DocumentBlockChildren (larksuite-oapi 2.8.5 API)

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

public class DocumentBlockChildren
extends Object

构造器概要

构造器
构造器和说明

DocumentBlockChildren(Config config)

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BatchDeleteDocumentBlockChildrenResp`	`batchDelete(BatchDeleteDocumentBlockChildrenReq req)` 删除块，指定需要操作的块，删除其指定范围的子块。
`BatchDeleteDocumentBlockChildrenResp`	`batchDelete(BatchDeleteDocumentBlockChildrenReq req, RequestOptions reqOptions)` 删除块，指定需要操作的块，删除其指定范围的子块。
`CreateDocumentBlockChildrenResp`	`create(CreateDocumentBlockChildrenReq req)` 创建块，在指定块的子块列表中，新创建一批子块，并放置到指定位置。
`CreateDocumentBlockChildrenResp`	`create(CreateDocumentBlockChildrenReq req, RequestOptions reqOptions)` 创建块，在指定块的子块列表中，新创建一批子块，并放置到指定位置。
`GetDocumentBlockChildrenResp`	`get(GetDocumentBlockChildrenReq req)` 获取所有子块，获取文档中指定块的所有子块的富文本内容并分页返回。
`GetDocumentBlockChildrenResp`	`get(GetDocumentBlockChildrenReq req, RequestOptions reqOptions)` 获取所有子块，获取文档中指定块的所有子块的富文本内容并分页返回。

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

- 构造器详细资料
  - DocumentBlockChildren
```
public DocumentBlockChildren(Config config)
```
- 方法详细资料
  - batchDelete
```
public BatchDeleteDocumentBlockChildrenResp batchDelete(BatchDeleteDocumentBlockChildrenReq 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_delete&project=docx&resource=document.block.children&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/BatchDeleteDocumentBlockChildrenSample.java ;
    
    抛出:
    
    Exception
  - batchDelete
```
public BatchDeleteDocumentBlockChildrenResp batchDelete(BatchDeleteDocumentBlockChildrenReq 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_delete&project=docx&resource=document.block.children&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/BatchDeleteDocumentBlockChildrenSample.java ;
    
    抛出:
    
    Exception
  - create
```
public CreateDocumentBlockChildrenResp create(CreateDocumentBlockChildrenReq req,
                                              RequestOptions reqOptions)
                                       throws Exception
```
    创建块，在指定块的子块列表中，新创建一批子块，并放置到指定位置。如果操作成功，接口将返回新创建子块的富文本内容。
    **应用频率限制**：单个应用调用频率上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400；;;**文档频率限制**：单篇文档并发编辑上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 429，编辑操作包括：;- 创建块;- 创建嵌套块;- 删除块;- 更新块;- 批量更新块;;当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;:::html;;要高效创建一批带有层级结构的子块或者创建带内容的表格等，推荐使用[创建嵌套块](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-descendant/create)接口。;;:::;;## 前提条件;- 调用该接口前，请参考[文档概述-基本概念](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-overview)了解块的父子关系规则。;- 调用此接口前，请确保当前调用身份（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=create&project=docx&resource=document.block.children&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/CreateDocumentBlockChildrenSample.java ;
    
    抛出:
    
    Exception
  - create
```
public CreateDocumentBlockChildrenResp create(CreateDocumentBlockChildrenReq req)
                                       throws Exception
```
    创建块，在指定块的子块列表中，新创建一批子块，并放置到指定位置。如果操作成功，接口将返回新创建子块的富文本内容。
    **应用频率限制**：单个应用调用频率上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400；;;**文档频率限制**：单篇文档并发编辑上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 429，编辑操作包括：;- 创建块;- 创建嵌套块;- 删除块;- 更新块;- 批量更新块;;当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。;;:::html;;要高效创建一批带有层级结构的子块或者创建带内容的表格等，推荐使用[创建嵌套块](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-descendant/create)接口。;;:::;;## 前提条件;- 调用该接口前，请参考[文档概述-基本概念](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-overview)了解块的父子关系规则。;- 调用此接口前，请确保当前调用身份（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=create&project=docx&resource=document.block.children&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/CreateDocumentBlockChildrenSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetDocumentBlockChildrenResp get(GetDocumentBlockChildrenReq 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=get&project=docx&resource=document.block.children&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/GetDocumentBlockChildrenSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetDocumentBlockChildrenResp get(GetDocumentBlockChildrenReq 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=get&project=docx&resource=document.block.children&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/docxv1/GetDocumentBlockChildrenSample.java ;
    
    抛出:
    
    Exception

类 DocumentBlockChildren

构造器概要

方法概要

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

构造器详细资料

DocumentBlockChildren

方法详细资料

batchDelete

batchDelete

create

create

get

get