public class CardElement extends Object
| 构造器和说明 |
|---|
CardElement(Config config) |
| 限定符和类型 | 方法和说明 |
|---|---|
ContentCardElementResp |
content(ContentCardElementReq req)
流式更新文本,对卡片中的普通文本元素(tag 为 plain_text 的元素)或富文本组件(tag 为 markdown 的组件)传入全量文本内容,以实现“打字机”式的文字输出效果。
|
ContentCardElementResp |
content(ContentCardElementReq req,
RequestOptions reqOptions)
流式更新文本,对卡片中的普通文本元素(tag 为 plain_text 的元素)或富文本组件(tag 为 markdown 的组件)传入全量文本内容,以实现“打字机”式的文字输出效果。
|
CreateCardElementResp |
create(CreateCardElementReq req)
新增组件,为指定卡片实体新增组件,以扩展卡片内容,如在卡片中添加一个点击按钮。
|
CreateCardElementResp |
create(CreateCardElementReq req,
RequestOptions reqOptions)
新增组件,为指定卡片实体新增组件,以扩展卡片内容,如在卡片中添加一个点击按钮。
|
DeleteCardElementResp |
delete(DeleteCardElementReq req)
删除组件,删除指定卡片实体中的组件。
|
DeleteCardElementResp |
delete(DeleteCardElementReq req,
RequestOptions reqOptions)
删除组件,删除指定卡片实体中的组件。
|
PatchCardElementResp |
patch(PatchCardElementReq req)
更新组件属性,通过传入 `card_id`(卡片实体 ID)和 `element_id`(组件 ID),更新卡片实体中对应组件的属性。
|
PatchCardElementResp |
patch(PatchCardElementReq req,
RequestOptions reqOptions)
更新组件属性,通过传入 `card_id`(卡片实体 ID)和 `element_id`(组件 ID),更新卡片实体中对应组件的属性。
|
UpdateCardElementResp |
update(UpdateCardElementReq req)
更新组件,更新卡片实体中的指定组件为新组件。
|
UpdateCardElementResp |
update(UpdateCardElementReq req,
RequestOptions reqOptions)
更新组件,更新卡片实体中的指定组件为新组件。
|
public CardElement(Config config)
public ContentCardElementResp content(ContentCardElementReq req, RequestOptions reqOptions) throws Exception
## 输出效果说明;;若旧文本为传入的新文本的前缀子串,新增文本将在旧文本末尾继续以打字机效果输出;若新旧文本前缀不同,全量文本将直接上屏输出,无打字机效果。参考[流式更新卡片](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/streaming-updates-openapi-overview),了解流式更新文本的效果和完整流程。;;## 使用限制;;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 对于搭建工具中的卡片,仅支持对富文本组件中的内容进行流式更新,不支持对普通文本元素进行文本流式更新。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。;;## 前提条件;;调用该接口时,需确保已开启卡片的流式更新模式:;- 在卡片 JSON 中,将 `streaming_mode` 设为 `true`;- 或在卡片搭建工具中,在设置中开启流式更新模式:;;  ;
Exceptionpublic ContentCardElementResp content(ContentCardElementReq req) throws Exception
## 输出效果说明;;若旧文本为传入的新文本的前缀子串,新增文本将在旧文本末尾继续以打字机效果输出;若新旧文本前缀不同,全量文本将直接上屏输出,无打字机效果。参考[流式更新卡片](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/streaming-updates-openapi-overview),了解流式更新文本的效果和完整流程。;;## 使用限制;;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 对于搭建工具中的卡片,仅支持对富文本组件中的内容进行流式更新,不支持对普通文本元素进行文本流式更新。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。;;## 前提条件;;调用该接口时,需确保已开启卡片的流式更新模式:;- 在卡片 JSON 中,将 `streaming_mode` 设为 `true`;- 或在卡片搭建工具中,在设置中开启流式更新模式:;;  ;
Exceptionpublic CreateCardElementResp create(CreateCardElementReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic CreateCardElementResp create(CreateCardElementReq req) throws Exception
Exceptionpublic DeleteCardElementResp delete(DeleteCardElementReq req, RequestOptions reqOptions) throws Exception
## 注意事项;;删除容器类组件时,容器中内嵌的组件将一并被删除。;;## 使用限制;;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。 ;
Exceptionpublic DeleteCardElementResp delete(DeleteCardElementReq req) throws Exception
## 注意事项;;删除容器类组件时,容器中内嵌的组件将一并被删除。;;## 使用限制;;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。 ;
Exceptionpublic PatchCardElementResp patch(PatchCardElementReq req, RequestOptions reqOptions) throws Exception
## 使用限制;;- 本接口不支持修改组件的标签(tag)属性。;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。 ;
Exceptionpublic PatchCardElementResp patch(PatchCardElementReq req) throws Exception
## 使用限制;;- 本接口不支持修改组件的标签(tag)属性。;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。 ;
Exceptionpublic UpdateCardElementResp update(UpdateCardElementReq req, RequestOptions reqOptions) throws Exception
## 使用限制;;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。 ;
Exceptionpublic UpdateCardElementResp update(UpdateCardElementReq req) throws Exception
## 使用限制;;- 调用该接口时,不支持将卡片设置为独享卡片模式。即不支持将卡片 JSON 数据中的 `update_multi` 属性设置为 `false`。;- 调用该接口的应用身份(tenant_access_token)需与创建目标卡片实体的应用身份一致。 ;
ExceptionCopyright © 2026. All rights reserved.