DocumentBlock (larksuite-oapi 2.8.5 API)

java.lang.Object
- com.lark.oapi.service.docx.v1.resource.DocumentBlock

public class DocumentBlock
extends Object

构造器概要

构造器
构造器和说明

DocumentBlock(Config config)

构造器
构造器和说明
`DocumentBlock(Config config)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BatchUpdateDocumentBlockResp`	`batchUpdate(BatchUpdateDocumentBlockReq req)` 批量更新块的内容，批量更新块的富文本内容。
`BatchUpdateDocumentBlockResp`	`batchUpdate(BatchUpdateDocumentBlockReq req, RequestOptions reqOptions)` 批量更新块的内容，批量更新块的富文本内容。
`GetDocumentBlockResp`	`get(GetDocumentBlockReq req)` 获取块的内容，指定块的 block id 获取指定块的富文本内容数据。
`GetDocumentBlockResp`	`get(GetDocumentBlockReq req, RequestOptions reqOptions)` 获取块的内容，指定块的 block id 获取指定块的富文本内容数据。
`ListDocumentBlockResp`	`list(ListDocumentBlockReq req)` 获取文档所有块，获取文档所有块的富文本内容并分页返回。
`ListDocumentBlockResp`	`list(ListDocumentBlockReq req, RequestOptions reqOptions)` 获取文档所有块，获取文档所有块的富文本内容并分页返回。
`PatchDocumentBlockResp`	`patch(PatchDocumentBlockReq req)` 更新块的内容，更新指定块的内容。
`PatchDocumentBlockResp`	`patch(PatchDocumentBlockReq req, RequestOptions reqOptions)` 更新块的内容，更新指定块的内容。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DocumentBlock
```
public DocumentBlock(Config config)
```
- 方法详细资料
  - batchUpdate
```
public BatchUpdateDocumentBlockResp batchUpdate(BatchUpdateDocumentBlockReq req,
                                                RequestOptions reqOptions)
                                         throws Exception
```
    批量更新块的内容，批量更新块的富文本内容。
    **应用频率限制**：单个应用调用频率上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400；;;**文档频率限制**：单篇文档并发编辑上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 429，编辑操作包括：;- 创建块;- 创建嵌套块;- 删除块;- 更新块;- 批量更新块;;当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_update&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/BatchUpdateDocumentBlockSample.java ;
    
    抛出:
    
    Exception
  - batchUpdate
```
public BatchUpdateDocumentBlockResp batchUpdate(BatchUpdateDocumentBlockReq req)
                                         throws Exception
```
    批量更新块的内容，批量更新块的富文本内容。
    **应用频率限制**：单个应用调用频率上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400；;;**文档频率限制**：单篇文档并发编辑上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 429，编辑操作包括：;- 创建块;- 创建嵌套块;- 删除块;- 更新块;- 批量更新块;;当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_update&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/BatchUpdateDocumentBlockSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetDocumentBlockResp get(GetDocumentBlockReq req,
                                RequestOptions reqOptions)
                         throws Exception
```
    获取块的内容，指定块的 block id 获取指定块的富文本内容数据。
    **应用频率限制**：单个应用调用频率上限为每秒 5 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400。当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/GetDocumentBlockSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetDocumentBlockResp get(GetDocumentBlockReq req)
                         throws Exception
```
    获取块的内容，指定块的 block id 获取指定块的富文本内容数据。
    **应用频率限制**：单个应用调用频率上限为每秒 5 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400。当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/GetDocumentBlockSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListDocumentBlockResp list(ListDocumentBlockReq req,
                                  RequestOptions reqOptions)
                           throws Exception
```
    获取文档所有块，获取文档所有块的富文本内容并分页返回。
    **应用频率限制**：单个应用调用频率上限为每秒 5 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400。当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/ListDocumentBlockSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListDocumentBlockResp list(ListDocumentBlockReq req)
                           throws Exception
```
    获取文档所有块，获取文档所有块的富文本内容并分页返回。
    **应用频率限制**：单个应用调用频率上限为每秒 5 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400。当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/ListDocumentBlockSample.java ;
    
    抛出:
    
    Exception
  - patch
```
public PatchDocumentBlockResp patch(PatchDocumentBlockReq req,
                                    RequestOptions reqOptions)
                             throws Exception
```
    更新块的内容，更新指定块的内容。如果操作成功，接口将返回更新后的块的富文本内容。
    **应用频率限制**：单个应用调用频率上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400；;;**文档频率限制**：单篇文档并发编辑上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 429，编辑操作包括：;- 创建块;- 创建嵌套块;- 删除块;- 更新块;- 批量更新块;;当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=patch&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/PatchDocumentBlockSample.java ;
    
    抛出:
    
    Exception
  - patch
```
public PatchDocumentBlockResp patch(PatchDocumentBlockReq req)
                             throws Exception
```
    更新块的内容，更新指定块的内容。如果操作成功，接口将返回更新后的块的富文本内容。
    **应用频率限制**：单个应用调用频率上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400；;;**文档频率限制**：单篇文档并发编辑上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 429，编辑操作包括：;- 创建块;- 创建嵌套块;- 删除块;- 更新块;- 批量更新块;;当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;## 前提条件;;调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=patch&project=docx&resource=document.block&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/PatchDocumentBlockSample.java ;
    
    抛出:
    
    Exception

类 DocumentBlock

构造器概要

方法概要

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

构造器详细资料

DocumentBlock

方法详细资料

batchUpdate

batchUpdate

get

get

list

list

patch

patch