Directory

Directory

文件目录。

Constructor

new Directory(hierarchy)

Parameters:
Name Type Description
hierarchy FileHierarchy

层级描述对象。

Classes

Directory

Members

children :OrderMap.<number, Directory>

子目录映射。

Type:

creation :number

目录的创建时间。

Type:
  • number

domain :string

目录所属的域。

Type:
  • string

files :OrderMap.<string, FileLabel>

包含的文件映射。

Type:

hidden :boolean

是否是隐藏目录。

Type:
  • boolean

hierarchy :FileHierarchy

文件层级描述。

Type:

id :number

目录的 ID 。

Type:
  • number

lastModified :number

目录最后一次修改时间。

Type:
  • number

name :string

目录名。

Type:
  • string

numDirs :number

当前目录的子目录数量。

Type:
  • number

numFiles :number

当前目录下的文件数量。

Type:
  • number

ownerId :number

目录所属的实体 ID 。

Type:
  • number

parent :Directory

父目录。

Type:

parentId :number

父目录 ID 。

Type:
  • number

size :number

目录内所有各级文件大小总和。

Type:
  • number

Methods

deleteDirectory(dirs, recursive, handleSuccess, handleFailureopt)

删除子目录。

Parameters:
Name Type Attributes Description
dirs Array | Directory | number | string

待删除目录或目录列表。

recursive boolean

是否递归删除所有子文件和子目录。

handleSuccess function

成功回调。参数:(workingDir:Directory, deletedList:Array.<Directory>) 。

handleFailure function <optional>

失败回调。参数:(error:ModuleError) 。

deleteFile(files, handleSuccess, handleFailureopt)

删除文件。

Parameters:
Name Type Attributes Description
files Array

指定待删除的文件码列表。

handleSuccess function

成功回调。参数:(workingDir:Directory, deletedList:Array.<FileLabel>) 。

handleFailure function <optional>

失败回调。参数:(error:ModuleError) 。

getCreation() → {number}

获取目录创建时间。

Returns:

返回目录创建时间。

Type
number

getDirectory(id) → {Directory}

获取指定 ID 的子目录。

Parameters:
Name Type Description
id number | string

目录 ID 。

Returns:

返回指定 ID 的子目录。

Type
Directory

getDirectoryByName(name) → {Directory}

获取指定名称的子目录。

Parameters:
Name Type Description
name string

目录名称。

Returns:

返回指定名称的子目录。

Type
Directory

getDomain() → {string}

获取目录所属的域。

Returns:

返回目录所属的域。

Type
string

getFile(fileCodeOrId) → {FileLabel}

获取指定文件码或文件 ID 的文件。

Parameters:
Name Type Description
fileCodeOrId string | number

指定文件码或文件 ID 。

Returns:

返回指定文件码的文件。

Type
FileLabel

getFileByName(name) → {FileLabel}

获取指定文件名的文件。

Parameters:
Name Type Description
name string

指定文件名。

Returns:

返回指定文件名的文件。

Type
FileLabel

getId() → {number}

获取目录的 ID 。

Returns:

返回目录的 ID 。

Type
number

getLastModified() → {number}

获取目录最近一次修改时间。

Returns:

返回目录最近一次修改时间。

Type
number

getName() → {string}

获取目录名。

Returns:

返回目录名。

Type
string

getParent() → {Directory}

获取父目录。

Returns:

返回父目录。

Type
Directory

getSize() → {number}

获取目录包含的所有文件大小。

Returns:

返回目录包含的所有文件大小。

Type
number

isHidden() → {boolean}

当前目录是否是隐藏目录。

Returns:

如果是隐藏目录返回 true

Type
boolean

isRoot() → {boolean}

是否是根目录。

Returns:

如果当前目录是根目录返回 true

Type
boolean

listDirectories(handleSuccess, handleFailureopt)

罗列当前目录的所有子目录。

Parameters:
Name Type Attributes Description
handleSuccess function

成功回调。参数:(dir:Directory, list:Array)

handleFailure function <optional>

失败回调。参数:(error:ModuleError)

listFiles(beginIndex, endIndex, handleSuccess, handleFailureopt)

罗列指定索引范围内的所有文件。

Parameters:
Name Type Attributes Description
beginIndex number

起始索引。

endIndex number

结束索引。

handleSuccess function

成功回调。参数:(dir:Directory, list:Array, begin:number, end:number) 。

handleFailure function <optional>

失败回调。参数:(error:ModuleError) 。

newDirectory(dirName, handleSuccess, handleFailureopt)

新建目录。

Parameters:
Name Type Attributes Description
dirName string

新目录名称。

handleSuccess function

成功回调。参数:(newDir:Directory) 。

handleFailure function <optional>

失败回调。参数:(error:ModuleError) 。

searchFile(filter, handleSuccess, handleFailureopt)

搜索文件。

Parameters:
Name Type Attributes Description
filter SearchFilter
handleSuccess function

成功回调。参数:(filter:SearchFilter, list:Array.<SearchItem>) 。

handleFailure function <optional>

失败回调。参数:(error:ModuleError) 。

totalDirs() → {number}

合计包含的同级目录数量。

Returns:

返回包含的同级目录数量。

Type
number

totalFiles() → {number}

合计包含的同级文件数量。

Returns:

返回包含的同级文件数量。

Type
number

uploadFile(file, handleProcessing, handleSuccess, handleFailure)

上传文件到该目录。

Parameters:
Name Type Description
file File

指定文件。

handleProcessing function

正在上传文件回调。

handleSuccess function

成功回调。参数:(directory:Directory, fileLabel:FileLabel) 。

handleFailure function

失败回调。参数:(error:ModuleError) 。