Skip to content

rename

描述

重命名本地文件/目录

将指定路径的文件或目录重命名(移动)到新路径。
网页应用需要完成鉴权后调用该接口。

支持说明

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

输入

名称数据类型是否必填描述
paramsobject
∟ newPathstring新文件/目录路径,fakePath/Struct
∟ oldPathstring原文件/目录路径,fakePath/Struct

输出

名称类型描述
msgstring错误信息,成功时为"ok"

示例代码

ts
const manager = window.ksoxz_sdk.getFileSystemManager({onSuccess, onError});
manager.rename({ params: { oldPath: 'ksoxz://user/a.txt', newPath: 'ksoxz://user/b.txt' }, onSuccess, onError });

错误码

参考:公共错误码