Activity interface

套件:

botframework-schema

活動是 Bot Framework 3.0 通訊協定的基本通訊類型。

屬性

action	指出是否已從寄件者的連絡人清單中新增或移除 contactRelationUpdate 的收件者。
attachmentLayout	多個附件的配置提示。 預設值：清單。 可能的值包括：'list'、'carousel'
attachments	附件
callerId	字串，包含識別 Bot 呼叫端的 URI。 此欄位並非透過線路傳輸，而是由 Bot 和用戶端填入；他們會依據可經由密碼編譯驗證、對呼叫端的身分識別 (例如權杖) 進行判斷提示的資料來執行。
channelData	包含通道特定內容。
channelId	包含可唯一識別通道的識別碼。 由通道設定。
code	endOfConversation 活動的程式碼，指出對話結束的原因。 可能的值包括：'unknown'、'completedSuccessfully'、'userCancelled'、'botTimedOut'、'botIssuedInvalidMessage'、'channelFailed'
conversation	識別活動所屬的交談。
deliveryMode	一個傳遞提示，用來將活動的替代傳遞路徑告知收件者。 預設傳遞模式為 「default」。 可能的值包括：'normal'、'notification'、'expectReplies'、'ephemeral'
entities	表示訊息中所提及的實體。
expiration	應將活動視為「過期」而不向收件者顯示的時間。
from	識別郵件的寄件者。
historyDisclosed	指出通道的先前歷程記錄是否公開。
id	包含可唯一識別通道上活動的識別碼。
importance	活動的重要性。 可能的值包括：'low'、'normal'、'high'
inputHint	指出在訊息傳遞至用戶端之後，Bot 是否接受、預期或忽略使用者輸入。 可能的值包括：'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 時區資料庫格式表示。 例如 America/Los_Angeles。
membersAdded	新增至交談的成員集合。
membersRemoved	已從交談中移除的成員集合。
name	與叫用或事件活動相關聯的作業名稱。
reactionsAdded	新增至交談的回應集合。
reactionsRemoved	從交談中移除的回應集合。
recipient	識別郵件的收件者。
relatesTo	另一個交談或活動的參考。
replyToId	包含此郵件為回復之訊息的識別碼。
semanticAction	此要求隨附的選擇性程式設計動作
serviceUrl	包含指定通道服務端點的 URL。 由通道設定。
speak	要讀出的文字。
suggestedActions	活動的建議動作。
summary	如果通道無法轉譯卡片，要顯示的文字。
text	訊息的文字內容。
textFormat	文字欄位的格式 Default：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

字串，包含識別 Bot 呼叫端的 URI。 此欄位並非透過線路傳輸，而是由 Bot 和用戶端填入；他們會依據可經由密碼編譯驗證、對呼叫端的身分識別 (例如權杖) 進行判斷提示的資料來執行。

callerId: string

屬性值

string

channelData

包含通道特定內容。

channelData?: any

屬性值

any

channelId

包含可唯一識別通道的識別碼。 由通道設定。

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?: string

屬性值

string

importance

活動的重要性。 可能的值包括：'low'、'normal'、'high'

importance?: ActivityImportance | string

屬性值

ActivityImportance | string

inputHint

指出在訊息傳遞至用戶端之後，Bot 是否接受、預期或忽略使用者輸入。 可能的值包括：'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 時區資料庫格式表示。 例如 America/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

包含此郵件為回復之訊息的識別碼。

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

文字欄位的格式 Default：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