FileStorage

FileStorage

云端文件存储模块。

Constructor

new FileStorage()

Extends

Classes

FileStorage

Members

block :number

文件分块大小。

Type:
  • number

contactService :ContactService

联系人服务。

Type:

(protected) defaultRetrospect :number

Overrides:

默认回溯时长，默认值：30个自然天。

Type:
  • number

(protected) dependencies :Array.<string>

Overrides:

模块的外部依赖。

Type:
  • Array.<string>

(protected) deps :Array.<string>

Overrides:

依赖库列表。

Type:
  • Array.<string>

fileAnchors :OrderMap.<string, FileAnchor>

文件锚点。

Type:

fileHierarchyMap :OrderMap.<number, FileHierarchy>

文件层级表。键为层级对应的联系人ID或群组ID。

Type:

fileLabels :OrderMap.<string, FileLabel>

缓存的文件标签。键为文件码。

Type:

filePipeline :AjaxPipeline

文件数据通道。

Type:

fileSpaceSize :number

已使用的文件存储空间大小。

Type:
  • number

fileURL :string

主机 URL 地址。

Type:
  • string

(protected) kernel :Kernel

Overrides:

内核对象。

Type:

maxFileSpaceSize :number

最大允许使用的文件存储空间大小。

Type:
  • number

NAME :string

模块名。

Type:
  • string

(protected) name :string

Overrides:

模块名称。

Type:
  • string

(protected) pipeline :Pipeline

Overrides:

模块使用的默认数据管道。

Type:

pipelineListener :FileStoragePipeListener

默认管道的监听器。

Type:

(protected) pluginSystem :PluginSystem

Overrides:

消息插件系统。

Type:

rootDirectory :Directory

当前联系人的根目录。

Type:

secure :boolean

是否是安全连接。

Type:
  • boolean

(protected) started :boolean

Overrides:

是否已启动。

Type:
  • boolean

storage :FileStructStorage

结构存储库。

Type:

Methods

cancelSharingTag(sharingCode, handleSuccess, handleFailure)

取消分享。

Parameters:
Name Type Description
sharingCode string | SharingTag

指定分享码或者分享标签实例。
handleSuccess function

成功回调。参数：(sharingTag:SharingTag) 。
handleFailure function

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

config(config)

Overrides:

配置模块。

Parameters:
Name Type Description
config JSON

配置信息。

createSharingTag(fileLabel, config, handleSuccess, handleFailure)

创建文件的分享标签。

Parameters:
Name Type Description
fileLabel FileLabel

指定文件标签。
config SharingTagConfig

指定分享操作配置。
handleSuccess function

成功回调。参数：(sharingTag:SharingTag) 。
handleFailure function

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

deleteDirectory(workingDir, pendingDir, recursive, handleSuccess, handleFailure)

删除目录。

Parameters:
Name Type Description
workingDir Directory

当前工作目录。
pendingDir Directory | Array

待删除目录或者目录 ID 。
recursive boolean

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

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

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

deleteFiles(workingDir, fileCodes, handleSuccess, handleFailureopt)

删除指定目录下的文件。

Parameters:
Name Type Attributes Description
workingDir Directory

指定当前工作目录。
fileCodes Array

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

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

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

downloadFile(fileOrFileCode, handleProcessingopt, handleSuccessopt, handleFailureopt)

下载文件。

Parameters:
Name Type Attributes Description
fileOrFileCode FileLabel | string

文件标签或文件码。
handleProcessing funciton <optional>
handleSuccess funciton <optional>
handleFailure funciton <optional>

使用超链接方式下载文件。

Parameters:
Name Type Description
fileOrFileCode string | FileLabel
handleSuccess function
handleFailure function

emptyTrash(handleSuccess, handleFailureopt)

清空回收站里所有文件和文件夹。

Parameters:
Name Type Attributes Description
handleSuccess function

成功回调。参数：(root:Directory) 。
handleFailure function <optional>

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

eraseTrash(trashIdList, handleSuccess, handleFailureopt)

抹除回收站里的指定废弃数据。

Parameters:
Name Type Attributes Description
trashIdList Array.<number>

指定待抹除数据的 ID 列表。
handleSuccess function

成功回调。参数：(root:Directory) 。
handleFailure function <optional>

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

findFile(file, handleSuccess, handleFailure)

精确查找文件。

Parameters:
Name Type Description
file File

指定文件。
handleSuccess funciton
handleFailure funciton

getAuthToken() → {AuthToken}

Overrides:

获取访问令牌。

Returns:

返回当前存储的访问令牌，如果没有获得令牌返回 null 值。

Type
AuthToken

getFileLabel(fileCode, handleSuccess, handleFailureopt)

获取文件标签。

Parameters:
Name Type Attributes Description
fileCode string

指定文件码。
handleSuccess function

获取到数据回调该方法，参数：(fileLabel:FileLabel)。
handleFailure function <optional>

未能找到数据回调该方法，参数：(error:ModuleError)。

getFileSpaceSize() → {number}

获取已使用的文件空间大小。

Returns:

返回已使用的文件空间大小。

Type
number

getFileURL(fileCodeOrLabel, handler)

获取文件的访问 URL 。

Parameters:
Name Type Description
fileCodeOrLabel string

文件码。
handler function

回调函数，函数参数：(fileLabel:FileLabel, fileURL:string, fileSecureURL:string) 。

getMaxFileSpaceSize() → {number}

获取最大允许使用的文件空间大小。

Returns:

返回最大允许使用的文件空间大小。

Type
number

getName() → {string}

Overrides:

获取模块名称。

Returns:

返回模块名称。

Type
string

getPluginSystem() → {PluginSystem}

Overrides:

获取插件系统对象实例。

Returns:

返回插件系统对象实例。

Type
PluginSystem

getSelfRoot(handleSuccess, handleFailure)

获取当前登录联系人的个人文件根目录。

Parameters:
Name Type Description
handleSuccess function

成功回调。参数：(root:Directory)。
handleFailure function

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

getSharingTag(sharingCode, handleSuccess, handleFailure)

获取指定分享码的分享标签。

Parameters:
Name Type Description
sharingCode string

指定分享码。
handleSuccess function

成功回调。参数：(sharingTag:SharingTag) 。
handleFailure function

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

hasStarted() → {boolean}

Overrides:

是否已启动过该模块。

Returns:

如果已启动返回 true ，否则返回 false 。

Type
boolean

isReady() → {boolean}

Overrides:

模块是否就绪。

Returns:

如果模块就绪返回 true 。

Type
boolean

launchFileSelector(handle, acceptopt)

启动文件选择器。

Parameters:
Name Type Attributes Description
handle function

文件选择回调函数。参数：(file:File) 。
accept string <optional>

input 标签的 accept 属性值。

listSharingTags(beginIndex, endIndex, valid, handleSuccess, handleFailure)

批量获取分享标签。

Parameters:
Name Type Description
beginIndex number

指定数据起始索引。
endIndex number

指定数据结束索引。
valid boolean

指定获取有效标签还是过期标签。
handleSuccess funciton

成功回调。参数：(list:Array.<SharingTag>, total:number) 。
handleFailure funciton

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

listTrash(begin, end, handleSuccess, handleFailureopt)

罗列当前登录联系人文件回收站里的废弃数据。

Parameters:
Name Type Attributes Description
begin number

开始索引。
end number

结束索引。
handleSuccess function

成功回调。参数：(root:Directory, list:Array, begin:number, end:number) 。
handleFailure function <optional>

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

listVisitTraces(sharingCode, beginIndex, endIndex, handleSuccess, handleFailure)

列表分享访问痕迹。

Parameters:
Name Type Description
sharingCode string
beginIndex number
endIndex number
handleSuccess funciton

成功回调。参数：(list:Array.<VisitTrace>, total:number) 。
handleFailure funciton

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

moveFile(fileCode, srcDirectory, destDirectory, handleSuccess, handleFailure)

移动文件到指定目录。

Parameters:
Name Type Description
fileCode string

指定文件码。
srcDirectory Directory

指定源目录。
destDirectory Directory

指定目标目录。
handleSuccess function

成功回调。参数：(fileLabel:FileLabel, srcDirectory:Directory, destDirectory:Directory) 。
handleFailure function

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

newDirectory(workingDir, newDirName, handleSuccess, handleFailure)

新建目录。

Parameters:
Name Type Description
workingDir Directory

当前工作目录。
newDirName string

新目录名。
handleSuccess function

成功回调。参数：(newDirectory:Directory) 。
handleFailure function

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

on(eventopt, listener)

Overrides:
See:

设置指定事件的监听回调函数。

Parameters:
Name Type Attributes Description
event string <optional>

指定事件名。
listener function

当发生该事件时回调此函数，函数参数参看 ModuleEvent 。

queryDirectory(id) → {Directory}

获取指定 ID 的目录。

Parameters:
Name Type Description
id number | string

目录 ID 。
Returns:

返回指定 ID 的目录。

Type
Directory

querySearch(directoryId, fileCode) → {SearchItem}

查询之前有效的搜索结果。

Parameters:
Name Type Description
directoryId number | string

目录 ID 。
fileCode string

文件码。
Returns:

返回搜索结果项。

Type
SearchItem

renameDirectory(workingDir, newDirName, handleSuccess, handleFailure)

重命名目录。

Parameters:
Name Type Description
workingDir Directory

工作目录。
newDirName string

新的目录名。
handleSuccess function

成功回调。参数：(workingDir:Directory) 。
handleFailure function

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

renameFile(directory, fileLabelOrFileCode, newFileName, handleSuccess, handleFailure)

重命名文件。

Parameters:
Name Type Description
directory Directory

文件所在的目录。
fileLabelOrFileCode FileLabel | string

待重命名的文件或文件的文件码。
newFileName string

指定新的文件名。
handleSuccess function

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

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

require(moduleName)

Overrides:

声明该模块依赖的其他模块。

Parameters:
Name Type Description
moduleName string

requireFile(fileOrURL, successCallbackopt, failureCallbackopt)

Overrides:

请求外部依赖库文件。

Parameters:
Name Type Attributes Description
fileOrURL string

文件或者文件的 URL 。
successCallback function <optional>
failureCallback function <optional>

restoreTrash(trashIdList, handleSuccess, handleFailure)

从回收站恢复指定数据。

Parameters:
Name Type Description
trashIdList Array

废弃数据的 ID 列表。
handleSuccess function

成功回调。参数：(root:Directory, result:RestoreResult) 。
handleFailure function

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

resume()

Overrides:

恢复模块。

searchFile(filter, handleSuccess, handleFailureopt)

搜索文件。

Parameters:
Name Type Attributes Description
filter SearchFilter

指定搜索过滤条件。
handleSuccess function

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

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

start() → {boolean}

Overrides:

启动模块。

Returns:

返回 false 表示模块不再需要执行启动流程。

Type
boolean

stop()

Overrides:

停止模块。

suspend()

Overrides:

挂起模块。

uploadFile(file, handleProcessingopt, handleSuccessopt, handleFailureopt) → {FileAnchor}

上传指定的文件。

Parameters:
Name Type Attributes Description
file File

指定上传文件。
handleProcessing function <optional>

正在进行文件处理的回调函数。函数参数：(fileAnchor:FileAnchor) 。
handleSuccess function <optional>

上传文件成功的回调函数。函数参数：(fileLabel:FileLabel) 。
handleFailure function <optional>

上传文件失败的回调函数。函数参数：(error:ModuleError) 。
Returns:

返回文件锚。

Type
FileAnchor

uploadFileWithSelector(handleProcessing, handleSuccess, handleFailure)

使用文件选择对话框选择文件后上传。 该方法仅适用于 Web 浏览器。

Parameters:
Name Type Description
handleProcessing function
handleSuccess function
handleFailure function