IMessage interface

套件:

botbuilder

使用者與 Bot 之間傳送的聊天訊息。 從 Bot 到使用者的訊息有兩種類型：

• 回應式訊息 是從 Bot 傳送至使用者的訊息，以回復來自使用者的傳入訊息。
• 主動式訊息 是從 Bot 傳送給使用者的訊息，以回應某些外部事件，例如警示觸發。

在反應式案例中，您應該將 位址 字段從傳入訊息複製到傳出訊息（如果您使用 Message builder 類別，並以 會話初始化， 這會自動發生），然後設定 文字 或 附件。 針對主動式訊息，您需要將 位址 從傳入訊息儲存到某個位置的外部記憶體。 然後，您可以將此傳入 UniversalBot.beginDialog（），或將它複製到傳遞至 UniversalBot.send（）的傳出訊息。

使用傳入位址物件撰寫訊息給使用者時，預設會在目前交談的內容中傳送回復給使用者。 某些通道允許開始與用戶進行新的交談。 若要開始與使用者的新主動式交談，只需從地址對象中刪除 交談 字段，再撰寫傳出訊息。

Extends

IEvent

屬性

address	事件的位址路由資訊。 將此欄位儲存到某個位置的外部記憶體，以便稍後撰寫主動式訊息給使用者。
agent	正在處理事件的 SDK。 一律為「Botbuilder」。
attachmentLayout	用戶端應如何配置多個附件的提示。 預設值為 『list』。
attachments	對於內送郵件，包含從用戶傳送的影像之類的附件。 對於傳出訊息，包含要傳送給使用者的卡片或影像等物件。
code	指出交談結束原因的程序代碼。
deliveryMode	傳送提示，以向收件者發出活動替代傳遞路徑的訊號。 默認傳遞模式為 「default」。。
entities	傳遞至 Bot 或使用者的結構化物件。
expriation	活動應該視為「已過期」的時間，不應向收件者呈現。
importance	活動的重要性。
inputHint	用戶端提示，讓他們知道 Bot 是否預期進一步輸入。 內建提示會自動為傳出訊息填入此值。
label	活動的描述性標籤。
listenFor	語音和語言準備系統應該接聽的片語和參考清單。
localTimestamp	傳送訊息的當地時間（由用戶端或 Bot 設定，例如：2016-09-23T13：07：49.4714686-07：00。
localTimezone	包含訊息在本機時間以 IANA 時區資料庫格式表示的時區名稱。 例如，美國/Los_Angeles。
name	要叫用的作業名稱或事件的名稱。
relatesTo	另一個交談或訊息的參考。
replyToId	此更新所關聯的事件識別碼。
semanticAction	此要求隨附的選擇性程序設計動作。
source	活動的原始來源（例如'facebook'、'skype'、'slack'等等）
sourceEvent	來源原生架構中的原始事件。 針對傳出訊息，可用來傳遞來源特定事件數據，例如自定義附件。
speak	語音合成標記語言 語音合成標記語言。
summary	要以後援方式顯示的文字，以及訊息內容的簡短描述，例如最近的交談清單。
text	消息正文。
textFormat	文字欄位格式。 默認值為 『Markdown』。
textHighlights	活動包含 ReplyToId 值時要反白顯示的文字片段集合。
textLocale	如果已知，則為消息正文的識別語言。
timestamp	傳送訊息的 UTC 時間（由服務設定）。
type	定義事件類型。 應該是 IMessage 的「訊息」。
user	對於傳入訊息，這是傳送訊息的使用者。 根據預設，這是 address.user 複本，但您可以使用 lookupUser 函式來設定 Bot，讓傳入用戶對應至內部使用者標識符。
value	開放式值。
valueType	活動值物件的型別。

屬性詳細資料

address

事件的位址路由資訊。 將此欄位儲存到某個位置的外部記憶體，以便稍後撰寫主動式訊息給使用者。

address: IAddress

屬性值

IAddress

agent

正在處理事件的 SDK。 一律為「Botbuilder」。

agent: string

屬性值

string

attachmentLayout

用戶端應如何配置多個附件的提示。 預設值為 『list』。

attachmentLayout?: string

屬性值

string

attachments

對於內送郵件，包含從用戶傳送的影像之類的附件。 對於傳出訊息，包含要傳送給使用者的卡片或影像等物件。

attachments?: IAttachment[]

屬性值

IAttachment[]

code

指出交談結束原因的程序代碼。

code?: string

屬性值

string

deliveryMode

傳送提示，以向收件者發出活動替代傳遞路徑的訊號。 默認傳遞模式為 「default」。。

deliveryMode?: string

屬性值

string

entities

傳遞至 Bot 或使用者的結構化物件。

entities?: any[]

屬性值

any[]

expriation

活動應該視為「已過期」的時間，不應向收件者呈現。

expriation?: string

屬性值

string

importance

活動的重要性。

importance?: string

屬性值

string

inputHint

用戶端提示，讓他們知道 Bot 是否預期進一步輸入。 內建提示會自動為傳出訊息填入此值。

inputHint?: string

屬性值

string

label

活動的描述性標籤。

label?: string

屬性值

string

listenFor

語音和語言準備系統應該接聽的片語和參考清單。

listenFor?: string[]

屬性值

string[]

localTimestamp

傳送訊息的當地時間（由用戶端或 Bot 設定，例如：2016-09-23T13：07：49.4714686-07：00。

localTimestamp?: string

屬性值

string

localTimezone

包含訊息在本機時間以 IANA 時區資料庫格式表示的時區名稱。 例如，美國/Los_Angeles。

localTimezone?: string

屬性值

string

name

要叫用的作業名稱或事件的名稱。

name?: string

屬性值

string

relatesTo

另一個交談或訊息的參考。

relatesTo?: IAddress

屬性值

IAddress

replyToId

此更新所關聯的事件識別碼。

replyToId?: string

屬性值

string

semanticAction

此要求隨附的選擇性程序設計動作。

semanticAction?: ISemanticAction

屬性值

ISemanticAction

source

活動的原始來源（例如'facebook'、'skype'、'slack'等等）

source: string

屬性值

string

sourceEvent

來源原生架構中的原始事件。 針對傳出訊息，可用來傳遞來源特定事件數據，例如自定義附件。

sourceEvent: any

屬性值

any

speak

語音合成標記語言 語音合成標記語言。

speak?: string

屬性值

string

summary

要以後援方式顯示的文字，以及訊息內容的簡短描述，例如最近的交談清單。

summary?: string

屬性值

string

text

消息正文。

text?: string

屬性值

string

textFormat

文字欄位格式。 默認值為 『Markdown』。

textFormat?: string

屬性值

string

textHighlights

活動包含 ReplyToId 值時要反白顯示的文字片段集合。

textHighlights?: ITextHighlight[]

屬性值

ITextHighlight[]

textLocale

如果已知，則為消息正文的識別語言。

textLocale?: string

屬性值

string

timestamp

傳送訊息的 UTC 時間（由服務設定）。

timestamp?: string

屬性值

string

type

定義事件類型。 應該是 IMessage 的「訊息」。

type: string

屬性值

string

user

對於傳入訊息，這是傳送訊息的使用者。 根據預設，這是 address.user 複本，但您可以使用 lookupUser 函式來設定 Bot，讓傳入用戶對應至內部使用者標識符。

user: IIdentity

屬性值

IIdentity

value

開放式值。

value?: any

屬性值

any

valueType

活動值物件的型別。

valueType?: string

屬性值

string