Message class

套件:

botbuilder

可簡化使用附件建置複雜訊息的訊息產生器類別。

建構函式

Message(Session)

建立新的訊息產生器。

方法

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[])	傳遞至 Bot 或使用者的結構化物件。
inputHint(string)	用戶端提示，讓他們知道 Bot 是否預期進一步輸入。 內建提示會自動為傳出訊息填入此值。
localTimestamp(string)	傳送訊息的當地時間（由用戶端或 Bot 設定，例如：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)	已被取代 改為使用 local（）。
setNText(Session, string, string, number)	已被取代 改用 ntext（） ntext（）。
setText(Session, TextType, any[])	已被取代 改為使用 text（）。
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

attachments(AttachmentType[])

要傳送給使用者的卡片或影像。

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[])

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

function entities(list: Object[])

參數

list

Object[]

傳回

Message

inputHint(string)

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

function inputHint(hint: string)

參數

hint

string

傳回

Message

localTimestamp(string)

傳送訊息的當地時間（由用戶端或 Bot 設定，例如：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)

已被取代 改為使用 local（）。

function setLanguage(language: string)

參數

language

string

傳回

Message

setNText(Session, string, string, number)

已被取代 改用 ntext（） 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[])

已被取代 改為使用 text（）。

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