Class: AxWebFileSystem

AxWebFileSystem()

new AxWebFileSystem()

Creates a new instance of AxWebFileSystem
Source:

Methods

CreateNewFile(path) → {AxStream}

Creates a file for writing This method is only provided for consistency with other implementations. It is not meant to be used in this implementation
Parameters:
Name Type Description
path AxString Path to the file to create
Source:
Returns:
Stream which represents the newly created file
Type
AxStream

FromNativePathSyntax(path) → {AxString}

Converts a path from the specific file system's path syntax to Axis' path syntax If the path is already in Axis' path syntax, it is returned unaltered
Parameters:
Name Type Description
path AxString A path either in the specific file system's syntax or in Axis' syntax
Source:
Returns:
The path in the format of Axis' path syntax
Type
AxString

GetDirectoryContents(path, result) → {Boolean}

Gets information on the contents of the specified directory. This method is only provided for consistency with other implementations. It is not meant to be used in this implementation
Parameters:
Name Type Description
path AxString Path to the directory whose contents to get
result AxList Parameter in which to return a list of AxFileInfo items contained in the directory
Source:
Returns:
True if succeeded or false otherwise (for example if the directory does not exist)
Type
Boolean

GetFileInfo(path, result) → {Boolean}

Gets information on the specified file. This method is only provided for consistency with other implementations. It is not meant to be used in this implementation
Parameters:
Name Type Description
path AxString Path to the file to get information on
result AxFileInfo Parameter in which to return the information on the file
Source:
Returns:
True if succeeded or false otherwise (for example if the file does not exist)
Type
Boolean

OpenFile(path, context, callback) → {AxStream}

Opens a file for reading
Parameters:
Name Type Description
path AxString Path to the file to open
context * Object representing a context, which will be passed to the callback
callback AxFileSystemFileOpened A callback which is called after the file gets opened
Source:
Returns:
Stream with the file's contents
Type
AxStream

ToNativePathSyntax(path) → {AxString}

Converts a path from Axis' path syntax to the specific file system's path syntax If the path is already in the file system's path syntax, it is returned unaltered
Parameters:
Name Type Description
path AxString A path either in Axis' syntax or in the file systems' syntax
Source:
Returns:
The path in the format of the specific file system's path syntax
Type
AxString

Documentation generated by JSDoc 3.5.3 on Wed Jan 17 2018 17:06:57 GMT+0200 (FLE Standard Time)