CardAction class

包:

botbuilder

Builder 类，用于简化向卡片添加操作。

构造函数

CardAction(Session)

创建新的 CardAction。

方法

call(Session, string, TextType)	拨打电话号码的呼叫。 对于 Skype 呼叫，应包含采用 +44/+1 格式的国家/地区代码。
dialogAction(Session, string, string, TextType)	将按钮或点击操作绑定到为对话框注册或全局关闭机器人的命名操作。 可在 postBack 有效的任何位置使用。 还可以静态地将按钮绑定到 Facebooks 持久菜单等操作。 对于没有数据的操作，应 action?<action> 按钮的有效负载，或者对具有数据的操作 action?<action>=<data>。
displayText(TextType, any[])	（可选）单击按钮时显示在聊天源中的文本。
downloadFile(Session, string, TextType)	将指定的文件下载到用户设备。 Skype 当前不支持。
image(string)	对于要包含在按钮标签旁边的图像的按钮。 所有通道都不支持。
imBack(Session, string, TextType)	向机器人发送一条消息，以对聊天的所有成员可见的方式进行处理。 对于某些通道，可能会映射到 postBack。
invoke(Session, string, any, string)
messageBack(Session, string, TextType)	将消息发送到机器人进行处理。 messageBack 能够像 imBack 和 postBack一样执行操作。
openUrl(Session, string, TextType)	打开指定的 URL。
playAudio(Session, string, TextType)	向用户播放指定的音频文件。 Skype 当前不支持。
playVideo(Session, string, TextType)	向用户播放指定的视频。 Skype 当前不支持。
postBack(Session, string, TextType)	向机器人发送消息，以隐藏会话的所有成员的方式进行处理。 对于某些通道，这可能映射到 imBack。
showImage(Session, string, TextType)	在本机图像查看器中打开指定的图像。 对于 Skype，仅适用于 CardImage 上的点击操作。
text(TextType, any[])	（可选）此操作的文本。
title(TextType, any[])	操作的标题。 对于按钮，这是按钮的标签。 对于点击操作，这可用于可加入目的或在悬停时显示。
toAction()	返回操作的 JSON。
type(string)	卡片操作的类型。
value(string)	操作值。

构造函数详细信息

CardAction(Session)

创建新的 CardAction。

new CardAction(session?: Session)

参数

session

Session

（可选）将用于本地化任何文本。

方法详细信息

call(Session, string, TextType)

拨打电话号码的呼叫。 对于 Skype 呼叫，应包含采用 +44/+1 格式的国家/地区代码。

static function call(session: Session, number: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

number

string

title

TextType

返回

CardAction

dialogAction(Session, string, string, TextType)

将按钮或点击操作绑定到为对话框注册或全局关闭机器人的命名操作。 可在 postBack 有效的任何位置使用。 还可以静态地将按钮绑定到 Facebooks 持久菜单等操作。 对于没有数据的操作，应 action?<action> 按钮的有效负载，或者对具有数据的操作 action?<action>=<data>。

static function dialogAction(session: Session, action: string, data?: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

action

string

点击时要调用的操作的名称。

data

string

（可选）在调用时传递给操作的数据。 IRecognizeActionResult.data 属性可用于访问此数据。 如果使用 beginDialogAction（） 此值将作为对话初始参数的一部分传递。

title

TextType

（可选） 将操作绑定到按钮时要分配的标题。

返回

CardAction

displayText(TextType, any[])

（可选）单击按钮时显示在聊天源中的文本。

function displayText(text: TextType, args: any[])

参数

text

TextType

args

any[]

返回

CardAction

downloadFile(Session, string, TextType)

将指定的文件下载到用户设备。 Skype 当前不支持。

static function downloadFile(session: Session, url: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

url

string

title

TextType

返回

CardAction

image(string)

对于要包含在按钮标签旁边的图像的按钮。 所有通道都不支持。

function image(url: string)

参数

url

string

返回

CardAction

imBack(Session, string, TextType)

向机器人发送一条消息，以对聊天的所有成员可见的方式进行处理。 对于某些通道，可能会映射到 postBack。

static function imBack(session: Session, msg: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

msg

string

title

TextType

返回

CardAction

invoke(Session, string, any, string)

static function invoke(session: Session, action: string, data: any, title: string)

参数

session

Session

action

string

data

any

title

string

返回

CardAction

messageBack(Session, string, TextType)

将消息发送到机器人进行处理。 messageBack 能够像 imBack 和 postBack一样执行操作。

static function messageBack(session: Session, msg: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

msg

string

title

TextType

返回

CardAction

openUrl(Session, string, TextType)

打开指定的 URL。

static function openUrl(session: Session, url: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

url

string

title

TextType

返回

CardAction

playAudio(Session, string, TextType)

向用户播放指定的音频文件。 Skype 当前不支持。

static function playAudio(session: Session, url: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

url

string

title

TextType

返回

CardAction

playVideo(Session, string, TextType)

向用户播放指定的视频。 Skype 当前不支持。

static function playVideo(session: Session, url: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

url

string

title

TextType

返回

CardAction

postBack(Session, string, TextType)

向机器人发送消息，以隐藏会话的所有成员的方式进行处理。 对于某些通道，这可能映射到 imBack。

static function postBack(session: Session, msg: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

msg

string

title

TextType

返回

CardAction

showImage(Session, string, TextType)

在本机图像查看器中打开指定的图像。 对于 Skype，仅适用于 CardImage 上的点击操作。

static function showImage(session: Session, url: string, title?: TextType)

参数

session

Session

（可选）会话的当前会话对象。 如果指定用于本地化游戏。

url

string

title

TextType

返回

CardAction

text(TextType, any[])

（可选）此操作的文本。

function text(text: TextType, args: any[])

参数

text

TextType

args

any[]

返回

CardAction

title(TextType, any[])

操作的标题。 对于按钮，这是按钮的标签。 对于点击操作，这可用于可加入目的或在悬停时显示。

function title(text: TextType, args: any[])

参数

text

TextType

args

any[]

返回

CardAction

toAction()

返回操作的 JSON。

function toAction()

返回

ICardAction

type(string)

卡片操作的类型。

function type(t: string)

参数

t

string

返回

CardAction

value(string)

操作值。

function value(v: string)

参数

v

string

返回

CardAction