创建卡
在聊天机器人交互中创建卡。
命令可用性: 本地 IBM RPA SaaS 和 IBM RPA
Description
在聊天机器人交互中创建卡。 卡可以播放或下载媒体、显示图像或重定向到 URL 地址。
脚本语法
IBM RPA 的专有脚本语言的语法与其他编程语言类似。 该脚本语法在脚本文件中定义命令的语法。 您可以在 IBM RPA Studio的 脚本 方式下使用此语法。
createCard --title(String) [--subtitle(String)] [--text(String)] --source(CardSource) [--url(String)] [--assetname(String)] [--action(BotCardItemActions)] [--value(String)] (CardItem)=value
输入参数
下表显示了此命令中提供的输入参数的列表。 在表中，您可以看到在 IBM RPA Studio的脚本方式及其 Designer 方式等效标签中工作时的参数名称。
| 设计器方式标签 | 脚本方式名称 | 必需的 | 接受的变量类型 | Description |
|---|---|---|---|---|
| 标题 | title |
Required |
Text |
用于指定卡标题的文本。 |
| 子标题 | subtitle |
Optional |
Text |
用于指定卡子标题的文本。 |
| 文本 | text |
Optional |
Text |
用于指定卡内容的文本。 |
| 源类型 | source |
Required |
CardSource |
从中获取主卡的图像的源类型。 请参阅 source 参数选项以获取可用选项的列表。 |
| URL | url |
Optional |
Text |
包含图像 URL 的文本。 |
| 资产 | assetname |
Optional |
Text |
图像文件资产。 注: 资产从资产选择器装入，并通过 Export Asset ( export) 命令生成的变量添加到参数。 |
| 操作 | action |
Optional |
BotCardItemActions |
通过卡执行的操作。 请参阅 action 参数选项以获取可用选项的列表。 |
| 值 | value |
Optional |
Text |
Action 中选择的操作必须执行的值。 |
source 参数选项
下表显示了可用于 source 输入参数的选项。 该表显示了在脚本方式下工作时的可用选项以及在设计器方式下的等效标签。
| 设计器方式标签 | 脚本方式名称 | Description |
|---|---|---|
| 资产 | Asset |
请提供本地文件或脚本的资产作为源。 |
| Url | Url |
提供 URL 文件作为资产。 |
action 参数选项
下表显示了可用于 action 输入参数的选项。 该表显示了在脚本方式下工作时的可用选项以及在设计器方式下的等效标签。
| 设计器方式标签 | 脚本方式名称 | Description |
|---|---|---|
| 下载文件 | DownloadFile |
下载指定的文件。 |
| 我已返回 | ImBack |
无操作（缺省值） |
| 打开 URL | OpenURL |
打开 URL 地址。 |
| 播放音频 | PlayAudio |
播放音频文件。 |
| 播放视频 | PlayVideo |
播放视频文件。 |
| 撤销发布 | PostBack |
|
| 显示图像 | ShowImage |
显示源文件中的图像。 |
| 登录 | SignIn |
输出参数
| 设计器方式标签 | 脚本方式名称 | 接受的变量类型 | Description |
|---|---|---|---|
| 卡 | value |
Card Item |
返回根据输入参数中指定的内容生成的卡。 |
示例
创建标题为 "IBM" 的卡和其他规范后， Bot ask Carousel (chatAskCarousel) 命令用于提示用户单击特定按钮。 因此，它将重定向到先前配置的操作。
defVar --name culture --type Language
defVar --name ibmCard --type CardItem
defVar --name cardList --type List --innertype CardItem
defVar --name selectedButton --type String
defVar --name insertedPhrase --type String
createLanguage --culture "en-US" culture=value
botConnect --type "Chat" --language ${culture} --autoanswer --timeout "00:05:00"
createCard --title "IBM" --subtitle "IBM" --text "IBM test example" --source "Url" --url "https://www.ibm.com/design/language/189b4fc4d43434372d82a514fcbc19f/core_black-on-gray30.svg" --action "DownloadFile" --value "https://www.ibm.com" ibmCard=value
addButtonToCard --card ${ibmCard} --buttonAction "OpenURL" --buttonText "Click Here!" --buttonValue "https://www.ibm.com"
add --collection "${cardList}" --value "${ibmCard}"
// Definition of the question and the cards to be used.
chatAskCarousel --text "Hello! Click the card below:" --cards ${cardList} --timeout "00:05:00" insertedPhrase=value selectedButton=utterance
botDisconnect