getFile

描述

读取本地文件内容

读取指定路径的本地文件内容，支持分段读取和多种编码。单次读取最大 1024*1024 字节。
网页应用需要完成鉴权后调用该接口。

支持说明

客户端平台	WPS协作版本要求
iOS	>=5.42.0
Android	>=5.42.0
PC	>=5.42.0

输入

名称	数据类型	是否必填	描述
params	object	是
∟ encoding	string	否	指定读取文件的字符编码。如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容。 支持：ascii、base64、binary、hex、ucs2/ucs-2/utf16le/utf-16le、utf-8/utf8、latin1
∟ filePath	string	是	要读取的文件路径，fakePath/uuid与fakePath/struct均支持
∟ length	number	否	指定读取长度（字节），默认 524288（512KB）。 如可读长度不足则返回实际可读长度。 有效范围：[0, fileLength]，单次最大 1048576（1MB）
∟ position	number	否	从文件指定位置开始读取（字节偏移量），默认 0。 读取范围为左闭右开区间 [position, position+length)。 有效范围：[0, fileLength - 1]

输出

名称	类型	描述
data	string	文件内容
fileName	string	文件名称
fileSize	number	文件大小

示例代码

const manager = window.ksoxz_sdk.getFileSystemManager({onSuccess, onError});
manager.getFile({ params: { filePath: 'ksoxz://user/a.txt', encoding: 'utf8' }, onSuccess, onError });

错误码

参考：公共错误码