Message class

参考

包:: botbuilder

用于简化使用附件生成复杂邮件的邮件生成器类。

构造函数

创建新的消息生成器。

方法

addAttachment(AttachmentType)	向邮件添加附件。有关示例，请参阅 IAttachment。
addEntity(Object)	将实体添加到消息。
address(IAddress)	消息的地址路由信息。将此字段保存到外部存储，以便稍后向用户撰写主动消息。
attachmentLayout(string)	提示客户端应如何布局多个附件。默认值为“list”。
attachments(AttachmentType[])	要发送给用户的卡片或图像。
code(string)	指示会话结束原因的代码。
compose(string[][], any[])	撰写对用户的复杂随机答复。
composePrompt(Session, string[][], any[])	弃用改用 compose（）。
composePrompt(Session, string[][], any[])	将提示数组合并为单个本地化提示，然后选择性地使用传入的参数填充提示模板槽。
entities(Object[])	传递给机器人或用户的结构化对象。
inputHint(string)	客户端提示告知机器人是否需要进一步输入。内置提示会自动为传出消息填充此值。
localTimestamp(string)	发送消息的本地时间（由客户端或机器人设置，例如：2016-09-23T13：07：49.4714686-07：00）。
name(string)	要调用的操作的名称或事件的名称。
nspeak(TextType, TextType, number)	根据给定的指定计数，有条件地设置消息的说话字段。
ntext(TextType, TextType, number)	有条件地设置给定指定计数的消息文本。
originalEvent(any)	传入消息的通道的原始/本机格式的消息。
randomPrompt(TextType)	随机选择提示。
relatesTo(IAddress)	对另一个对话或消息的引用。
setChannelData(any)	弃用改为使用 sourceEvent（）。
setLanguage(string)	弃用改用本地。
setNText(Session, string, string, number)	弃用改为使用 ntext（）。
setText(Session, TextType, any[])	弃用改用文本（）。
sourceEvent(ISourceEventMap)	对于传出消息，可用于传递源特定事件数据，例如自定义附件。
speak(TextType, any[])	将消息的说话字段设置为语音合成标记语言（SSML）。这将在受支持的设备上与用户交谈。
suggestedActions(ISuggestedActions \| IIsSuggestedActions)	要发送给用户的可选建议操作。建议的操作仅显示在支持建议操作的通道上。
summary(TextType, any[])	要通过回退和邮件内容的简短说明显示的文本，例如最近对话的列表。
text(TextType, any[])	设置消息文本。
textFormat(string)	文本字段的格式。
textLocale(string)	消息的语言。
timestamp(string)	由连接器服务设置。请改用 localTimestamp（）。
toMessage()	返回消息的 JSON。
value(any)	开放式值。

构造函数详细信息

Message(Session)

创建新的消息生成器。

new Message(session?: Session)

参数

session: Session

（可选）将用于填充消息地址并本地化任何文本。

方法详细信息

addAttachment(AttachmentType)

向邮件添加附件。有关示例，请参阅 IAttachment。

function addAttachment(attachment: AttachmentType)

参数

attachment: AttachmentType

要添加的附件。

Message

addEntity(Object)

将实体添加到消息。

function addEntity(obj: Object)

参数

obj: Object

Message

address(IAddress)

消息的地址路由信息。将此字段保存到外部存储，以便稍后向用户撰写主动消息。

function address(adr: IAddress)

参数

adr: IAddress

Message

attachmentLayout(string)

提示客户端应如何布局多个附件。默认值为“list”。

function attachmentLayout(style: string)

参数

style: string

Message

要发送给用户的卡片或图像。

function attachments(list: AttachmentType[])

参数

list: AttachmentType[]

Message

code(string)

指示会话结束原因的代码。

function code(value: string)

参数

value: string

Message

compose(string[][], any[])

撰写对用户的复杂随机答复。

function compose(prompts: string[][], args: any[])

参数

prompts: string[][]

args: any[]

Message

composePrompt(Session, string[][], any[])

弃用改用 compose（）。

function composePrompt(session: Session, prompts: string[][], args: any[])

参数

session: Session

prompts: string[][]

args: any[]

Message

composePrompt(Session, string[][], any[])

将提示数组合并为单个本地化提示，然后选择性地使用传入的参数填充提示模板槽。

static function composePrompt(session: Session, prompts: string[][], args?: any[])

参数

session: Session

用于本地化各个提示部分的会话对象。

prompts: string[][]

提示列表的数组。数组中的每个条目都是将随机选择的另一个提示数组。组合的输出文本将分隔空格。

args: any[]

（可选）用于在提示为模板时设置输出文本格式的参数数组。

string

entities(Object[])

传递给机器人或用户的结构化对象。

function entities(list: Object[])

参数

list: Object[]

Message

inputHint(string)

客户端提示告知机器人是否需要进一步输入。内置提示会自动为传出消息填充此值。

function inputHint(hint: string)

参数

hint: string

Message

localTimestamp(string)

发送消息的本地时间（由客户端或机器人设置，例如：2016-09-23T13：07：49.4714686-07：00）。

function localTimestamp(time?: string)

参数

time: string

（可选）表示为 ISO 字符串的时间。默认为 new Date().toISOString()。

Message

name(string)

要调用的操作的名称或事件的名称。

function name(name: string)

参数

name: string

Message

nspeak(TextType, TextType, number)

根据给定的指定计数，有条件地设置消息的说话字段。

function nspeak(ssml: TextType, ssml_plural: TextType, count: number)

参数

ssml: TextType

ssml_plural: TextType

count: number

Message

ntext(TextType, TextType, number)

有条件地设置给定指定计数的消息文本。

function ntext(msg: TextType, msg_plural: TextType, count: number)

参数

msg: TextType

msg_plural: TextType

count: number

Message

originalEvent(any)

传入消息的通道的原始/本机格式的消息。

function originalEvent(event: any)

参数

event: any

Message

randomPrompt(TextType)

随机选择提示。

static function randomPrompt(prompts: TextType)

参数

prompts: TextType

要从中选择的提示数组。当提示键入 字符串 将仅返回未修改提示。

string

relatesTo(IAddress)

对另一个对话或消息的引用。

function relatesTo(adr: IAddress)

参数

adr: IAddress

Message

setChannelData(any)

弃用改为使用 sourceEvent（）。

function setChannelData(data: any)

参数

data: any

Message

setLanguage(string)

弃用改用本地。

function setLanguage(language: string)

参数

language: string

Message

setNText(Session, string, string, number)

弃用改为使用 ntext（）。

function setNText(session: Session, msg: string, msg_plural: string, count: number)

参数

session: Session

msg: string

msg_plural: string

count: number

Message

setText(Session, TextType, any[])

弃用改用文本（）。

function setText(session: Session, prompt: TextType, args: any[])

参数

session: Session

prompt: TextType

args: any[]

Message

sourceEvent(ISourceEventMap)

对于传出消息，可用于传递源特定事件数据，例如自定义附件。

function sourceEvent(map: ISourceEventMap)

参数

map: ISourceEventMap

Message

speak(TextType, any[])

将消息的说话字段设置为语音合成标记语言（SSML）。这将在受支持的设备上与用户交谈。

function speak(ssml: TextType, args: any[])

参数

ssml: TextType

args: any[]

Message

suggestedActions(ISuggestedActions | IIsSuggestedActions)

要发送给用户的可选建议操作。建议的操作仅显示在支持建议操作的通道上。

function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)

参数

suggestedActions: ISuggestedActions | IIsSuggestedActions

Message

summary(TextType, any[])

要通过回退和邮件内容的简短说明显示的文本，例如最近对话的列表。

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

参数

text: TextType

args: any[]

Message

text(TextType, any[])

设置消息文本。

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

参数

text: TextType

args: any[]

Message

textFormat(string)

文本字段的格式。

function textFormat(style: string)

参数

style: string

Message

textLocale(string)

消息的语言。

function textLocale(locale: string)

参数

locale: string

Message

timestamp(string)

由连接器服务设置。请改用 localTimestamp（）。

function timestamp(time?: string)

参数

time: string

Message

toMessage()

返回消息的 JSON。

function toMessage()

IMessage

value(any)

开放式值。

function value(param: any)

参数

param: any

Message

通过

Message class

构造函数

方法

构造函数详细信息

Message(Session)

参数

方法详细信息

addAttachment(AttachmentType)

参数

返回

addEntity(Object)

参数

返回

address(IAddress)

参数

返回

attachmentLayout(string)

参数

返回

attachments(AttachmentType[])

参数

返回

code(string)

参数

返回

compose(string[][], any[])

参数

返回

composePrompt(Session, string[][], any[])

参数

返回

composePrompt(Session, string[][], any[])

参数

返回

entities(Object[])

参数

返回

inputHint(string)

参数

返回

localTimestamp(string)

参数

返回

name(string)

参数

返回

nspeak(TextType, TextType, number)

参数

返回

ntext(TextType, TextType, number)

参数

返回

originalEvent(any)

参数

返回

randomPrompt(TextType)

参数

返回

relatesTo(IAddress)

参数

返回

setChannelData(any)

参数

返回

setLanguage(string)

参数

返回

setNText(Session, string, string, number)

参数

返回

setText(Session, TextType, any[])

参数

返回

sourceEvent(ISourceEventMap)

参数

返回

speak(TextType, any[])

参数

返回