Activity interface

包:

botframework-schema

活动是 Bot Framework 3.0 协议的基本通信类型。

属性

action	指示是否已从发件人的联系人列表中添加或删除 contactRelationUpdate 的收件人。
attachmentLayout	多个附件的布局提示。 默认值：列表。 可能的值包括：“list”、“carousel”
attachments	附件
callerId	包含标识机器人调用方 URI 的字符串。 此字段不打算通过网络传输，而是由机器人和客户端根据断言调用方标识（例如令牌）的可加密验证数据填充。
channelData	包含特定于通道的内容。
channelId	包含唯一标识通道的 ID。 由通道设置。
code	endOfConversation 活动的代码，指示会话结束的原因。 可能的值包括：“unknown”、“completedSuccessfully”、“userCancelled”、“botTimedOut”、“botIssuedInvalidMessage”、“channelFailed”
conversation	标识活动所属的会话。
deliveryMode	用于向收件人发出活动备用传递路径的信号的传递提示。 默认传递模式为“default”。 可能的值包括：“normal”、“notification”、“expectReplies”、“ephemeral”
entities	表示消息中提到的实体。
expiration	活动被视为“已过期”的时间，不应提供给收件人。
from	标识邮件的发件人。
historyDisclosed	指示通道的先前历史记录是否被披露。
id	包含唯一标识通道上的活动的 ID。
importance	活动的重要性。 可能的值包括：“low”、“normal”、“high”
inputHint	指示将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 可能的值包括：“acceptingInput”、“ignoringInput”、“expectingInput”
label	活动的描述性标签。
listenFor	语音和语言启动系统应侦听的短语和引用列表
locale	文本字段内容的区域设置名称。 区域设置名称是与语言关联的 ISO 639 双字母或三字母区域性代码和与国家或地区关联的 ISO 3166 双字母子文化代码的组合。 区域设置名称还可以对应于有效的 BCP-47 语言标记。
localTimestamp	包含以 ISO-8601 格式表示的消息的本地日期和时间。 例如，2016-09-23T13：07：49.4714686-07：00。
localTimezone	包含以 IANA 时区数据库格式表示的消息本地时区的名称。 例如，美国/Los_Angeles。
membersAdded	添加到会话的成员集合。
membersRemoved	从会话中删除的成员集合。
name	与调用或事件活动关联的操作的名称。
reactionsAdded	添加到对话中的反应集合。
reactionsRemoved	从对话中删除的反应集合。
recipient	标识邮件的收件人。
relatesTo	对另一个对话或活动的引用。
replyToId	包含此邮件作为答复的消息的 ID。
semanticAction	此请求随附的可选编程操作
serviceUrl	包含指定通道的服务终结点的 URL。 由通道设置。
speak	要说的文本。
suggestedActions	活动的建议操作。
summary	通道无法呈现卡片时要显示的文本。
text	消息的文本内容。
textFormat	文本字段的格式默认值：markdown。 可能的值包括：“markdown”、“plain”、“xml”
textHighlights	活动包含 ReplyToId 值时要突出显示的文本片段集合。
timestamp	包含以 ISO-8601 格式表示的消息的日期和时间。
topicName	会话的更新主题名称。
type	包含活动类型。 可能的值包括：“message”、“contactRelationUpdate”、“conversationUpdate”、“type”、“endOfConversation”、“event”、“invoke”、“deleteUserData”、“messageUpdate”、“messageDelete”、“installationUpdate”、“messageReaction”、“suggestion”、“trace”、“handoff”
value	与活动关联的值。
valueType	活动值对象的类型。

属性详细信息

action

指示是否已从发件人的联系人列表中添加或删除 contactRelationUpdate 的收件人。

action?: string

属性值

string

attachmentLayout

多个附件的布局提示。 默认值：列表。 可能的值包括：“list”、“carousel”

attachmentLayout?: AttachmentLayoutTypes | string

属性值

AttachmentLayoutTypes | string

attachments

附件

attachments?: Attachment[]

属性值

Attachment[]

callerId

包含标识机器人调用方 URI 的字符串。 此字段不打算通过网络传输，而是由机器人和客户端根据断言调用方标识（例如令牌）的可加密验证数据填充。

callerId: string

属性值

string

channelData

包含特定于通道的内容。

channelData?: any

属性值

any

channelId

包含唯一标识通道的 ID。 由通道设置。

channelId: string

属性值

string

code

endOfConversation 活动的代码，指示会话结束的原因。 可能的值包括：“unknown”、“completedSuccessfully”、“userCancelled”、“botTimedOut”、“botIssuedInvalidMessage”、“channelFailed”

code?: EndOfConversationCodes | string

属性值

EndOfConversationCodes | string

conversation

标识活动所属的会话。

conversation: ConversationAccount

属性值

ConversationAccount

deliveryMode

用于向收件人发出活动备用传递路径的信号的传递提示。 默认传递模式为“default”。 可能的值包括：“normal”、“notification”、“expectReplies”、“ephemeral”

deliveryMode?: DeliveryModes | string

属性值

DeliveryModes | string

entities

表示消息中提到的实体。

entities?: Entity[]

属性值

Entity[]

expiration

活动被视为“已过期”的时间，不应提供给收件人。

expiration?: Date

属性值

Date

from

标识邮件的发件人。

from: ChannelAccount

属性值

ChannelAccount

historyDisclosed

指示通道的先前历史记录是否被披露。

historyDisclosed?: boolean

属性值

boolean

id

包含唯一标识通道上的活动的 ID。

id?: string

属性值

string

importance

活动的重要性。 可能的值包括：“low”、“normal”、“high”

importance?: ActivityImportance | string

属性值

ActivityImportance | string

inputHint

指示将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 可能的值包括：“acceptingInput”、“ignoringInput”、“expectingInput”

inputHint?: InputHints | string

属性值

InputHints | string

label

活动的描述性标签。

label: string

属性值

string

listenFor

语音和语言启动系统应侦听的短语和引用列表

listenFor: string[]

属性值

string[]

locale

文本字段内容的区域设置名称。 区域设置名称是与语言关联的 ISO 639 双字母或三字母区域性代码和与国家或地区关联的 ISO 3166 双字母子文化代码的组合。 区域设置名称还可以对应于有效的 BCP-47 语言标记。

locale?: string

属性值

string

localTimestamp

包含以 ISO-8601 格式表示的消息的本地日期和时间。 例如，2016-09-23T13：07：49.4714686-07：00。

localTimestamp?: Date

属性值

Date

localTimezone

包含以 IANA 时区数据库格式表示的消息本地时区的名称。 例如，美国/Los_Angeles。

localTimezone: string

属性值

string

membersAdded

添加到会话的成员集合。

membersAdded?: ChannelAccount[]

属性值

ChannelAccount[]

membersRemoved

从会话中删除的成员集合。

membersRemoved?: ChannelAccount[]

属性值

ChannelAccount[]

name

与调用或事件活动关联的操作的名称。

name?: ActivityEventNames | string

属性值

ActivityEventNames | string

reactionsAdded

添加到对话中的反应集合。

reactionsAdded?: MessageReaction[]

属性值

MessageReaction[]

reactionsRemoved

从对话中删除的反应集合。

reactionsRemoved?: MessageReaction[]

属性值

MessageReaction[]

recipient

标识邮件的收件人。

recipient: ChannelAccount

属性值

ChannelAccount

relatesTo

对另一个对话或活动的引用。

relatesTo?: ConversationReference

属性值

ConversationReference

replyToId

包含此邮件作为答复的消息的 ID。

replyToId?: string

属性值

string

semanticAction

此请求随附的可选编程操作

semanticAction?: SemanticAction

属性值

SemanticAction

serviceUrl

包含指定通道的服务终结点的 URL。 由通道设置。

serviceUrl: string

属性值

string

speak

要说的文本。

speak?: string

属性值

string

suggestedActions

活动的建议操作。

suggestedActions?: SuggestedActions

属性值

SuggestedActions

summary

通道无法呈现卡片时要显示的文本。

summary?: string

属性值

string

text

消息的文本内容。

text: string

属性值

string

textFormat

文本字段的格式默认值：markdown。 可能的值包括：“markdown”、“plain”、“xml”

textFormat?: TextFormatTypes | string

属性值

TextFormatTypes | string

textHighlights

活动包含 ReplyToId 值时要突出显示的文本片段集合。

textHighlights?: TextHighlight[]

属性值

TextHighlight[]

timestamp

包含以 ISO-8601 格式表示的消息的日期和时间。

timestamp?: Date

属性值

Date

topicName

会话的更新主题名称。

topicName?: string

属性值

string

type

包含活动类型。 可能的值包括：“message”、“contactRelationUpdate”、“conversationUpdate”、“type”、“endOfConversation”、“event”、“invoke”、“deleteUserData”、“messageUpdate”、“messageDelete”、“installationUpdate”、“messageReaction”、“suggestion”、“trace”、“handoff”

type: ActivityTypes | string

属性值

ActivityTypes | string

value

与活动关联的值。

value?: any

属性值

any

valueType

活动值对象的类型。

valueType: string

属性值

string