文件授权和共享的一些操作方法。
请求参数中的 options: IPDSRequestConfig 基于 axios 的 request config 封装，详情请看：AxiosRequestConfig。
listSharingFiles 方法
查询我的共享文件列表
const result = await client.listSharingFiles(params, options)参数说明
字段 | 类型 | 必选 | 说明 |
params | IListReq | 默认为 {} | |
options | IPDSRequestConfig | 其它配置项 |
IListReq
字段 | 类型 | 必选 | 说明 |
limit | number | 一次查询多少条数据 | |
marker | string | 标记 |
返回
字段 | 类型 | 必选 | 说明 |
result | IListRes<IFileItem> | 是 | 返回结果 |
IListRes
字段 | 类型 | 必选 | 说明 |
items | array | 是 | 查询到的文件信息列表，items 中每一项的具体字段可查看 IFileItem 的说明 |
next_marker | string | 是 | 分页标记 |
punished_file_count | number | 文件夹会返回 |
IFileItem
字段 | 类型 | 必选 | 说明 |
action_list | string[] | 权限列表 | |
created_at | Date | 是 | 创建时间 |
creator_id | string | 创建人的id | |
creator_name | string | 创建人的名称 | |
creator_type | string | 创建人的类型 | |
domain_id | string | 是 | domain ID |
drive_id | string | 是 | 云盘id |
encrypt_mode | string | 是否以加密形式分享 | |
file_id | string | 文件id | |
hidden | boolean | 显示隐藏 | |
last_modifier_id | string | 修改人的id | |
last_modifier_name | string | 修改人的名称 | |
last_modifier_type | string | 修改人的类型 | |
name | string | 文件名称 | |
parent_file_id | string | 上一级目录id | |
revision_id | string | 版本 | |
starred | boolean | 是否收藏， true 是 | |
status | string | 是 | 文件状态, available | enabled |
type | string | 文件类型 folder | |
updated_at | Date | 是 | 文件更新时间 |
listReceivedFiles 方法
查询收到的共享文件信息。
const result = await client.listReceivedFiles(params, options)参数说明
字段 | 类型 | 必选 | 说明 |
params | IListReq | 默认为 {} | |
options | IPDSRequestConfig | 其它配置项 |
IListReq
字段 | 类型 | 必选 | 说明 |
limit | number | 一次查询多少条数据 | |
marker | string | 标记 |
返回
字段 | 类型 | 必选 | 说明 |
result | IListRes<IFileItem> | 是 | 返回结果 |
IListRes
字段 | 类型 | 必选 | 说明 |
items | array | 是 | 查询到的文件信息列表，items 中每一项的具体字段可参考关于 IFileItem 的说明 |
next_marker | string | 分页标记 | |
punished_file_count | number | 文件夹会返回 |
addFilePermission 方法
添加文件授权信息 （创建共享 更新共享）
const result = await client.addFilePermission(params, options)参数说明
字段 | 类型 | 必选 | 说明 |
params | IAddFilePermissionReq | 是 | 创建共享的信息 |
options | IPDSRequestConfig | 其它配置项 |
IAddFilePermissionReq
字段 | 类型 | 必选 | 说明 |
drive_id | string | 是 | 云盘id |
file_id | string | 共享文件的ID | |
member_list | array | 要共享给的用户对象集合，数组每一项请参考 IPermissionStandard 说明 |
IPermissionStandard
字段 | 类型 | 必选 | 说明 |
identity | object | 是 | 包含 identity_type 和 identity_id 两个字段 |
expire_time | number | 是 | 时间戳 |
role_id | string | 是 | 角色id |
disinherit_sub_group | boolean | 是 | 是否继承子团队 |
返回值
StandardMode 模式下创建成功，没有返回值，失败则抛出异常信息。
removeFilePermission 方法
移除文件权限（删除共享）。
await client.removeFilePermission(params, options)参数说明
字段 | 类型 | 必选 | 说明 |
params | IAddFilePermissionReq | 是 | 要删除的共享文件 |
options | IPDSRequestConfig | 其它配置项 |
返回值
删除成功，没有返回值，失败则抛出异常信息。
listFilePermissions 方法
列举文件的权限。
const result = await client.listFilePermission(params, options)参数说明
字段 | 类型 | 必选 | 说明 |
params | IListPermissionReq | 是 | 查询参数 |
options | IPDSRequestConfig | 否 | 其它配置项 |
IListPermissionReq
字段 | 类型 | 必选 | 说明 |
drive_id | string | 是 | 云盘id |
file_id | string | 是 | 文件id |
返回
字段 | 类型 | 必选 | 说明 |
result | array | 是 | 返回结果, 其中每一项请查看关于 IPermissionStandard 的说明 |
IPermissionStandard
字段 | 类型 | 必选 | 说明 |
identity | object | 是 | 包含identity_name, identity_type 和 identity_id 字段 |
expire_time | number | 是 | 时间戳 |
role_id | string | 是 | 角色id |
disinherit_sub_group | boolean | 是 | 是否继承子团队 |
- 本页导读 （0）