程序包 com.lark.oapi.service.drive.v1

类 DriveService.File

java.lang.Object

com.lark.oapi.service.drive.v1.DriveService.File

封闭类:

DriveService

public static class DriveService.File
extends Object

构造器概要

构造器

构造器	说明
File(Config config)

方法概要

修饰符和类型	方法	说明
CopyFileResp	copy(CopyFileReq req)	复制文件，将文件复制到用户云空间的其他文件夹中。
CopyFileResp	copy(CopyFileReq req, RequestOptions reqOptions)	复制文件，将文件复制到用户云空间的其他文件夹中。
CreateFolderFileResp	createFolder(CreateFolderFileReq req)	新建文件夹，在用户云空间的指定文件夹中创建一个新的空文件夹。
CreateFolderFileResp	createFolder(CreateFolderFileReq req, RequestOptions reqOptions)	新建文件夹，在用户云空间的指定文件夹中创建一个新的空文件夹。
DeleteFileResp	delete(DeleteFileReq req)	删除文件，删除用户在云空间内的文件或者文件夹。
DeleteFileResp	delete(DeleteFileReq req, RequestOptions reqOptions)	删除文件，删除用户在云空间内的文件或者文件夹。
DownloadFileResp	download(DownloadFileReq req)	下载文件，使用该接口可以下载在云空间目录下的文件（不含飞书文档/表格/思维导图等在线文档）。
DownloadFileResp	download(DownloadFileReq 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)	分片上传文件（完成上传），触发完成上传。
UploadFinishFileResp	uploadFinish(UploadFinishFileReq req, RequestOptions reqOptions)	分片上传文件（完成上传），触发完成上传。
UploadPartFileResp	uploadPart(UploadPartFileReq req)	分片上传文件（上传分片），上传对应的文件块。
UploadPartFileResp	uploadPart(UploadPartFileReq req, RequestOptions reqOptions)	分片上传文件（上传分片），上传对应的文件块。
UploadPrepareFileResp	uploadPrepare(UploadPrepareFileReq req)	分片上传文件（预上传），发送初始化请求获取上传事务ID和分块策略，目前是以4MB大小进行定长分片。
UploadPrepareFileResp	uploadPrepare(UploadPrepareFileReq req, RequestOptions reqOptions)	分片上传文件（预上传），发送初始化请求获取上传事务ID和分块策略，目前是以4MB大小进行定长分片。

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

File

public File(Config config)

方法详细资料

copy

public CopyFileResp copy(CopyFileReq req,
 RequestOptions reqOptions)
                  throws Exception

复制文件，将文件复制到用户云空间的其他文件夹中。不支持复制文件夹。;;如果目标文件夹是我的空间，则复制的文件会在「**我的空间**」的「**归我所有**」列表里。

该接口不支持并发拷贝多个文件，且调用频率上限为 5QPS 且 10000次/天 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/CopyFileSample.java ;

抛出:

Exception

copy

public CopyFileResp copy(CopyFileReq req)
                  throws Exception

复制文件，将文件复制到用户云空间的其他文件夹中。不支持复制文件夹。;;如果目标文件夹是我的空间，则复制的文件会在「**我的空间**」的「**归我所有**」列表里。

该接口不支持并发拷贝多个文件，且调用频率上限为 5QPS 且 10000次/天 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/CopyFileSample.java ;

抛出:

Exception

createFolder

public CreateFolderFileResp createFolder(CreateFolderFileReq req,
 RequestOptions reqOptions)
                                  throws Exception

新建文件夹，在用户云空间的指定文件夹中创建一个新的空文件夹。

该接口不支持并发创建，且调用频率上限为 5QPS 以及 10000次/天 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/CreateFolderFileSample.java ;

抛出:

Exception

createFolder

public CreateFolderFileResp createFolder(CreateFolderFileReq req)
                                  throws Exception

新建文件夹，在用户云空间的指定文件夹中创建一个新的空文件夹。

该接口不支持并发创建，且调用频率上限为 5QPS 以及 10000次/天 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/CreateFolderFileSample.java ;

抛出:

Exception

delete

public DeleteFileResp delete(DeleteFileReq req,
 RequestOptions reqOptions)
                      throws Exception

删除文件，删除用户在云空间内的文件或者文件夹。文件或者文件夹被删除后，会进入用户回收站里。

要删除文件需要确保应用具有下述两种权限之一：;1. 该应用是文件所有者并且具有该文件所在父文件夹的编辑权限。;2. 该应用并非文件所有者，但是是该文件所在父文件夹的所有者或者拥有该父文件夹的所有权限（full access）。 ;

该接口不支持并发调用，且调用频率上限为5QPS。删除文件夹会异步执行并返回一个task_id，可以使用[task_check](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check)接口查询任务执行状态。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/DeleteFileSample.java ;

抛出:

Exception

delete

public DeleteFileResp delete(DeleteFileReq req)
                      throws Exception

删除文件，删除用户在云空间内的文件或者文件夹。文件或者文件夹被删除后，会进入用户回收站里。

要删除文件需要确保应用具有下述两种权限之一：;1. 该应用是文件所有者并且具有该文件所在父文件夹的编辑权限。;2. 该应用并非文件所有者，但是是该文件所在父文件夹的所有者或者拥有该父文件夹的所有权限（full access）。 ;

该接口不支持并发调用，且调用频率上限为5QPS。删除文件夹会异步执行并返回一个task_id，可以使用[task_check](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check)接口查询任务执行状态。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/DeleteFileSample.java ;

抛出:

Exception

download

public DownloadFileResp download(DownloadFileReq req,
 RequestOptions reqOptions)
                          throws Exception

下载文件，使用该接口可以下载在云空间目录下的文件（不含飞书文档/表格/思维导图等在线文档）。支持range下载。

该接口支持调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/download ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/DownloadFileSample.java ;

抛出:

Exception

download

public DownloadFileResp download(DownloadFileReq req)
                          throws Exception

下载文件，使用该接口可以下载在云空间目录下的文件（不含飞书文档/表格/思维导图等在线文档）。支持range下载。

该接口支持调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/download ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/DownloadFileSample.java ;

抛出:

Exception

list

public ListFileResp list(ListFileReq req,
 RequestOptions reqOptions)
                  throws Exception

获取文件夹下的清单，获取用户云空间中指定文件夹下的文件清单。清单类型包括文件、各种在线文档（文档、电子表格、多维表格、思维笔记）、文件夹和快捷方式。该接口支持分页，但是不会递归的获取子文件夹的清单。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/ListFileSample.java ;

抛出:

Exception

list

public ListFileResp list(ListFileReq req)
                  throws Exception

获取文件夹下的清单，获取用户云空间中指定文件夹下的文件清单。清单类型包括文件、各种在线文档（文档、电子表格、多维表格、思维笔记）、文件夹和快捷方式。该接口支持分页，但是不会递归的获取子文件夹的清单。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/ListFileSample.java ;

抛出:

Exception

move

public MoveFileResp move(MoveFileReq req,
 RequestOptions reqOptions)
                  throws Exception

移动文件，将文件或者文件夹移动到用户云空间的其他位置。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/move ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/MoveFileSample.java ;

抛出:

Exception

move

public MoveFileResp move(MoveFileReq req)
                  throws Exception

移动文件，将文件或者文件夹移动到用户云空间的其他位置。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/move ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/MoveFileSample.java ;

抛出:

Exception

subscribe

public SubscribeFileResp subscribe(SubscribeFileReq req,
 RequestOptions reqOptions)
                            throws Exception

订阅云文档事件，该接口仅支持**文档拥有者**订阅自己文档的通知事件，可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a)(暂不支持单独订阅文档维度的某类事件)，事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/SubscribeFileSample.java ;

抛出:

Exception

subscribe

public SubscribeFileResp subscribe(SubscribeFileReq req)
                            throws Exception

订阅云文档事件，该接口仅支持**文档拥有者**订阅自己文档的通知事件，可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a)(暂不支持单独订阅文档维度的某类事件)，事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/SubscribeFileSample.java ;

抛出:

Exception

taskCheck

public TaskCheckFileResp taskCheck(TaskCheckFileReq req,
 RequestOptions reqOptions)
                            throws Exception

查询异步任务状态，查询删除文件夹等异步任务的状态信息。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/TaskCheckFileSample.java ;

抛出:

Exception

taskCheck

public TaskCheckFileResp taskCheck(TaskCheckFileReq req)
                            throws Exception

查询异步任务状态，查询删除文件夹等异步任务的状态信息。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/TaskCheckFileSample.java ;

抛出:

Exception

uploadAll

public UploadAllFileResp uploadAll(UploadAllFileReq req,
 RequestOptions reqOptions)
                            throws Exception

上传文件，向云空间指定目录下上传一个小文件。

请不要使用这个接口上传大于20MB的文件，如果有这个需求可以尝试使用[分片上传接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/multipart-upload-file-/introduction)。 ;

该接口支持调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_all ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadAllFileSample.java ;

抛出:

Exception

uploadAll

public UploadAllFileResp uploadAll(UploadAllFileReq req)
                            throws Exception

上传文件，向云空间指定目录下上传一个小文件。

请不要使用这个接口上传大于20MB的文件，如果有这个需求可以尝试使用[分片上传接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/multipart-upload-file-/introduction)。 ;

该接口支持调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_all ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadAllFileSample.java ;

抛出:

Exception

uploadFinish

public UploadFinishFileResp uploadFinish(UploadFinishFileReq req,
 RequestOptions reqOptions)
                                  throws Exception

分片上传文件（完成上传），触发完成上传。

该接口不支持太高的并发，且调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_finish ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadFinishFileSample.java ;

抛出:

Exception

uploadFinish

public UploadFinishFileResp uploadFinish(UploadFinishFileReq req)
                                  throws Exception

分片上传文件（完成上传），触发完成上传。

该接口不支持太高的并发，且调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_finish ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadFinishFileSample.java ;

抛出:

Exception

uploadPart

public UploadPartFileResp uploadPart(UploadPartFileReq req,
 RequestOptions reqOptions)
                              throws Exception

分片上传文件（上传分片），上传对应的文件块。

该接口不支持太高的并发，且调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadPartFileSample.java ;

抛出:

Exception

uploadPart

public UploadPartFileResp uploadPart(UploadPartFileReq req)
                              throws Exception

分片上传文件（上传分片），上传对应的文件块。

该接口不支持太高的并发，且调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadPartFileSample.java ;

抛出:

Exception

uploadPrepare

public UploadPrepareFileResp uploadPrepare(UploadPrepareFileReq req,
 RequestOptions reqOptions)
                                    throws Exception

分片上传文件（预上传），发送初始化请求获取上传事务ID和分块策略，目前是以4MB大小进行定长分片。

你在24小时内可保存上传事务ID和上传进度，以便可以恢复上传 ;

该接口不支持太高的并发，且调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadPrepareFileSample.java ;

抛出:

Exception

uploadPrepare

public UploadPrepareFileResp uploadPrepare(UploadPrepareFileReq req)
                                    throws Exception

分片上传文件（预上传），发送初始化请求获取上传事务ID和分块策略，目前是以4MB大小进行定长分片。

你在24小时内可保存上传事务ID和上传进度，以便可以恢复上传 ;

该接口不支持太高的并发，且调用频率上限为5QPS ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/drivev1/UploadPrepareFileSample.java ;

抛出:

Exception