Class CardBuilder

CardBuilder

Card 对象的构建器。

方法

方法返回类型简介
addCardAction(cardAction)CardBuilder向此卡片添加 CardAction
addExpressionData(expressionData)CardBuilder向相应卡片添加了表情数据。
addSection(section)CardBuilder向相应卡片添加部分。
build()Card构建当前卡片并对其进行验证。
setDisplayStyle(displayStyle)CardBuilder设置相应卡片的显示样式。
setFixedFooter(fixedFooter)CardBuilder为此卡片设置固定页脚。
setHeader(cardHeader)CardBuilder为此卡片设置标题。
setName(name)CardBuilder为此卡片设置名称。
setPeekCardHeader(peekCardHeader)CardBuilder设置预览卡片标题。

详细文档

addCardAction(cardAction)

向此卡片添加 CardAction

参数

名称类型说明
cardActionCardAction要使用的 CardAction

返回

CardBuilder - 此对象,用于链式调用。


addExpressionData(expressionData)

向相应卡片添加表达式数据。

ExpressionData 定义了 CEL 逻辑和条件,以及在满足条件时要触发的事件。

参数

名称类型说明
expressionDataExpressionData要使用的 ExpressionData

返回

CardBuilder - 此对象,用于链式调用。


addSection(section)

向相应卡片添加部分。您无法向卡片添加超过 100 个部分。

参数

名称类型说明
sectionCardSection要使用的 CardSection

返回

CardBuilder - 此对象,用于链式调用。


build()

构建当前卡片并对其进行验证。

返回

Card - 已验证的卡。

抛出

Error - 如果构建的卡无效。


setDisplayStyle(displayStyle)

设置相应卡片的显示样式。

如果显示样式设置为 DisplayStyle.REPLACE,则通过替换卡片堆栈中顶部卡片的视图来显示卡片。

如果显示样式设置为 DisplayStyle.PEEK,卡片的标题会显示在边栏底部,部分遮盖堆栈的当前顶部卡片。点击标题会将卡片弹出到卡片堆栈中。如果卡片没有标题,则使用生成的标题。

DisplayStyle 仅适用于从上下文触发函数返回的卡片。

参数

名称类型说明
displayStyleDisplayStyle要设置的 DisplayStyle

返回

CardBuilder - 此对象,用于链式调用。


setFixedFooter(fixedFooter)

为此卡片设置固定页脚。

参数

名称类型说明
fixedFooterFixedFooter要使用的 FixedFooter

返回

CardBuilder - 此对象,用于链式调用。


setHeader(cardHeader)

为此卡片设置标题。

参数

名称类型说明
cardHeaderCardHeader要使用的 CardHeader

返回

CardBuilder - 此对象,用于链式调用。


setName(name)

为此卡片设置名称。该名称可用于导航

参数

名称类型说明
nameString名称。

返回

CardBuilder - 此对象,用于链式调用。


setPeekCardHeader(peekCardHeader)

设置速览卡片标题。

预览卡片设置在从情境触发函数返回的第一张卡片上。它用作描述性占位微件,以便用户可以从首页堆栈导航到上下文堆栈。

参数

名称类型说明
peekCardHeaderCardHeader要设置的 CardHeader

返回

CardBuilder - 此对象,用于链式调用。