public class File extends Object
| 限定符和类型 | 方法和说明 |
|---|---|
CopyFileResp |
copy(CopyFileReq req)
复制文件,将用户云空间中的文件复制至其它文件夹下。
|
CopyFileResp |
copy(CopyFileReq req,
RequestOptions reqOptions)
复制文件,将用户云空间中的文件复制至其它文件夹下。
|
CreateFolderFileResp |
createFolder(CreateFolderFileReq req)
新建文件夹,该接口用于在用户云空间指定文件夹中创建一个空文件夹。
|
CreateFolderFileResp |
createFolder(CreateFolderFileReq req,
RequestOptions reqOptions)
新建文件夹,该接口用于在用户云空间指定文件夹中创建一个空文件夹。
|
CreateShortcutFileResp |
createShortcut(CreateShortcutFileReq req)
创建文件快捷方式,创建指定文件的快捷方式到云空间的其它文件夹中。
|
CreateShortcutFileResp |
createShortcut(CreateShortcutFileReq req,
RequestOptions reqOptions)
创建文件快捷方式,创建指定文件的快捷方式到云空间的其它文件夹中。
|
DeleteFileResp |
delete(DeleteFileReq req)
删除文件或文件夹,删除用户在云空间内的文件或者文件夹。
|
DeleteFileResp |
delete(DeleteFileReq req,
RequestOptions reqOptions)
删除文件或文件夹,删除用户在云空间内的文件或者文件夹。
|
DeleteSubscribeFileResp |
deleteSubscribe(DeleteSubscribeFileReq req)
取消云文档事件订阅,该接口用于取消订阅云文档的通知事件。
|
DeleteSubscribeFileResp |
deleteSubscribe(DeleteSubscribeFileReq req,
RequestOptions reqOptions)
取消云文档事件订阅,该接口用于取消订阅云文档的通知事件。
|
DownloadFileResp |
download(DownloadFileReq req)
下载文件,下载云空间中的文件,如 PDF 文件。
|
DownloadFileResp |
download(DownloadFileReq req,
RequestOptions reqOptions)
下载文件,下载云空间中的文件,如 PDF 文件。
|
GetSubscribeFileResp |
getSubscribe(GetSubscribeFileReq req)
查询云文档事件订阅状态,该接口用于查询云文档事件的订阅状态。
|
GetSubscribeFileResp |
getSubscribe(GetSubscribeFileReq req,
RequestOptions reqOptions)
查询云文档事件订阅状态,该接口用于查询云文档事件的订阅状态。
|
ListFileResp |
list(ListFileReq req)
获取文件夹中的文件清单,该接口用于获取用户云空间指定文件夹中文件信息清单。
|
ListFileResp |
list(ListFileReq req,
RequestOptions reqOptions)
获取文件夹中的文件清单,该接口用于获取用户云空间指定文件夹中文件信息清单。
|
MoveFileResp |
move(MoveFileReq req)
移动文件或文件夹,将文件或者文件夹移动到用户云空间的其他位置。
|
MoveFileResp |
move(MoveFileReq req,
RequestOptions reqOptions)
移动文件或文件夹,将文件或者文件夹移动到用户云空间的其他位置。
|
SubscribeFileResp |
subscribe(SubscribeFileReq req)
订阅云文档事件,订阅云文档的各类通知事件。
|
SubscribeFileResp |
subscribe(SubscribeFileReq req,
RequestOptions reqOptions)
订阅云文档事件,订阅云文档的各类通知事件。
|
TaskCheckFileResp |
taskCheck(TaskCheckFileReq req)
查询异步任务状态,查询异步任务的状态信息。
|
TaskCheckFileResp |
taskCheck(TaskCheckFileReq req,
RequestOptions reqOptions)
查询异步任务状态,查询异步任务的状态信息。
|
UploadAllFileResp |
uploadAll(UploadAllFileReq req)
上传文件,将指定文件上传至云空间指定目录中。
|
UploadAllFileResp |
uploadAll(UploadAllFileReq req,
RequestOptions reqOptions)
上传文件,将指定文件上传至云空间指定目录中。
|
UploadFinishFileResp |
uploadFinish(UploadFinishFileReq req)
分片上传文件-完成上传,调用[上传分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part)接口将分片全部上传完毕后,你需调用本接口触发完成上传。
|
UploadFinishFileResp |
uploadFinish(UploadFinishFileReq req,
RequestOptions reqOptions)
分片上传文件-完成上传,调用[上传分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part)接口将分片全部上传完毕后,你需调用本接口触发完成上传。
|
UploadPartFileResp |
uploadPart(UploadPartFileReq req)
分片上传文件-上传分片,根据
[预上传](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare)接口返回的上传事务
ID
和分片策略上传对应的文件分片。
|
UploadPartFileResp |
uploadPart(UploadPartFileReq req,
RequestOptions reqOptions)
分片上传文件-上传分片,根据
[预上传](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare)接口返回的上传事务
ID
和分片策略上传对应的文件分片。
|
UploadPrepareFileResp |
uploadPrepare(UploadPrepareFileReq req)
分片上传文件-预上传,发送初始化请求,以获取上传事务 ID
和分片策略,为[上传分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part)做准备。
|
UploadPrepareFileResp |
uploadPrepare(UploadPrepareFileReq req,
RequestOptions reqOptions)
分片上传文件-预上传,发送初始化请求,以获取上传事务 ID
和分片策略,为[上传分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part)做准备。
|
public File(Config config)
public CopyFileResp copy(CopyFileReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=copy&project=drive&resource=file&version=v1 ;
Exceptionpublic CopyFileResp copy(CopyFileReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=copy&project=drive&resource=file&version=v1 ;
Exceptionpublic CreateFolderFileResp createFolder(CreateFolderFileReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic CreateFolderFileResp createFolder(CreateFolderFileReq req) throws Exception
Exceptionpublic CreateShortcutFileResp createShortcut(CreateShortcutFileReq req, RequestOptions reqOptions) throws Exception
## 使用限制;;该接口不支持并发调用,且调用频率上限为 5 QPS,10000 次/天。否则会返回 1061045 错误码,可通过稍后重试解决。 ;
Exceptionpublic CreateShortcutFileResp createShortcut(CreateShortcutFileReq req) throws Exception
## 使用限制;;该接口不支持并发调用,且调用频率上限为 5 QPS,10000 次/天。否则会返回 1061045 错误码,可通过稍后重试解决。 ;
Exceptionpublic DeleteFileResp delete(DeleteFileReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=drive&resource=file&version=v1 ;
Exceptionpublic DeleteFileResp delete(DeleteFileReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=drive&resource=file&version=v1 ;
Exceptionpublic DeleteSubscribeFileResp deleteSubscribe(DeleteSubscribeFileReq req, RequestOptions reqOptions) throws Exception
## 注意事项;目前只支持取消订阅事件列表中所有文档事件,暂不支持指定取消的事件。;## 前提条件;- 调用接口前,请确保应用或用户为文档所有者或文档管理者。;- 调用接口前,请确保正确配置订阅方式并添加了事件。详情参考[配置订阅方式](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case)和[添加事件](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/subscription-event-case)。 ;
Exceptionpublic DeleteSubscribeFileResp deleteSubscribe(DeleteSubscribeFileReq req) throws Exception
## 注意事项;目前只支持取消订阅事件列表中所有文档事件,暂不支持指定取消的事件。;## 前提条件;- 调用接口前,请确保应用或用户为文档所有者或文档管理者。;- 调用接口前,请确保正确配置订阅方式并添加了事件。详情参考[配置订阅方式](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case)和[添加事件](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/subscription-event-case)。 ;
Exceptionpublic DownloadFileResp download(DownloadFileReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=download&project=drive&resource=file&version=v1 ;
Exceptionpublic DownloadFileResp download(DownloadFileReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=download&project=drive&resource=file&version=v1 ;
Exceptionpublic GetSubscribeFileResp getSubscribe(GetSubscribeFileReq req, RequestOptions reqOptions) throws Exception
## 前提条件;- 调用接口前,请确保应用或用户为文档所有者或文档管理者。文档的通知事件仅支持文档拥有者和文档管理者订阅。;- 调用接口前,请确保正确配置订阅方式并添加了事件。详情参考[配置订阅方式](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case)和[添加事件](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/subscription-event-case)。 ;
Exceptionpublic GetSubscribeFileResp getSubscribe(GetSubscribeFileReq req) throws Exception
## 前提条件;- 调用接口前,请确保应用或用户为文档所有者或文档管理者。文档的通知事件仅支持文档拥有者和文档管理者订阅。;- 调用接口前,请确保正确配置订阅方式并添加了事件。详情参考[配置订阅方式](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case)和[添加事件](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/subscription-event-case)。 ;
Exceptionpublic ListFileResp list(ListFileReq req, RequestOptions reqOptions) throws Exception
## 使用限制;;本接口仅支持获取当前层级的文件信息,不支持递归获取子文件夹中的文件信息清单。 ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=drive&resource=file&version=v1 ;
Exceptionpublic ListFileResp list(ListFileReq req) throws Exception
## 使用限制;;本接口仅支持获取当前层级的文件信息,不支持递归获取子文件夹中的文件信息清单。 ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=drive&resource=file&version=v1 ;
Exceptionpublic MoveFileResp move(MoveFileReq req, RequestOptions reqOptions) throws Exception
## 使用限制;;该接口不支持并发调用,且调用频率上限为 5 QPS 且 10000次/天。否则会返回 1061045 错误码,可通过稍后重试解决。 ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=move&project=drive&resource=file&version=v1 ;
Exceptionpublic MoveFileResp move(MoveFileReq req) throws Exception
## 使用限制;;该接口不支持并发调用,且调用频率上限为 5 QPS 且 10000次/天。否则会返回 1061045 错误码,可通过稍后重试解决。 ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=move&project=drive&resource=file&version=v1 ;
Exceptionpublic SubscribeFileResp subscribe(SubscribeFileReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=subscribe&project=drive&resource=file&version=v1 ;
Exceptionpublic SubscribeFileResp subscribe(SubscribeFileReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=subscribe&project=drive&resource=file&version=v1 ;
Exceptionpublic TaskCheckFileResp taskCheck(TaskCheckFileReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic TaskCheckFileResp taskCheck(TaskCheckFileReq req) throws Exception
Exceptionpublic UploadAllFileResp uploadAll(UploadAllFileReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic UploadAllFileResp uploadAll(UploadAllFileReq req) throws Exception
Exceptionpublic UploadFinishFileResp uploadFinish(UploadFinishFileReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic UploadFinishFileResp uploadFinish(UploadFinishFileReq req) throws Exception
Exceptionpublic UploadPartFileResp uploadPart(UploadPartFileReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic UploadPartFileResp uploadPart(UploadPartFileReq req) throws Exception
Exceptionpublic UploadPrepareFileResp uploadPrepare(UploadPrepareFileReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic UploadPrepareFileResp uploadPrepare(UploadPrepareFileReq req) throws Exception
ExceptionCopyright © 2026. All rights reserved.