MessageFactory class

套件:

botbuilder-core

一組公用程式函式，可協助 Bot 傳回的各種訊息類型格式設定。

備註

下列範例顯示傳送包含單一主圖卡片的訊息：

const { MessageFactory, CardFactory } = require('botbuilder');

const card = CardFactory.heroCard(
     'White T-Shirt',
     ['https://example.com/whiteShirt.jpg'],
     ['buy']
);
const message = MessageFactory.attachment(card);
await context.sendActivity(message);

方法

attachment(Attachment, string, string, InputHints | string)	傳回包含附件的單一訊息活動。
carousel(Attachment[], string, string, InputHints | string)	傳回一則訊息，該訊息會使用浮動切換版面配置來顯示一組附件。
contentUrl(string, string, string, string, string, InputHints | string)	會傳回訊息，向使用者顯示單一影像或視訊。
list(Attachment[], string, string, InputHints | string)	會傳回一則訊息，以顯示清單表單中的一組附件。
suggestedActions(string | CardAction[], string, string, InputHints | string)	傳回包含一組建議動作和選擇性文字的訊息。
text(string, string, InputHints | string)	傳回簡單的文字訊息。

方法詳細資料

attachment(Attachment, string, string, InputHints | string)

傳回包含附件的單一訊息活動。

static function attachment(attachment: Attachment, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

參數

attachment

Attachment

要包含在訊息中的調適型卡片。

text

string

(選擇性) 訊息的文字。

speak

string

(選擇性) SSML 以包含在訊息中。

inputHint

InputHints | string

(訊息的選擇性) 輸入提示。 預設值為 acceptingInput。

傳回

Partial<Activity>

包含附件的郵件活動。

備註

此範例示範如何使用主圖卡片附件建立訊息：

const message = MessageFactory.attachment(
    CardFactory.heroCard(
        'White T-Shirt',
        ['https://example.com/whiteShirt.jpg'],
        ['buy']
     )
);

carousel(Attachment[], string, string, InputHints | string)

傳回一則訊息，該訊息會使用浮動切換版面配置來顯示一組附件。

static function carousel(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

參數

attachments

Attachment[]

要包含在郵件中的附件陣列。

text

string

(選擇性) 訊息的文字。

speak

string

(選擇性) SSML 以包含在訊息中。

inputHint

InputHints | string

(訊息的選擇性) 輸入提示。

傳回

Partial<Activity>

訊息活動，將會使用浮動切換配置來顯示一組附件。

備註

此範例示範如何使用主圖卡片的浮動切換來建立訊息：

const message = MessageFactory.carousel([
   CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
   CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
   CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
]);

contentUrl(string, string, string, string, string, InputHints | string)

會傳回訊息，向使用者顯示單一影像或視訊。

static function contentUrl(url: string, contentType: string, name?: string, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

參數

url

string

要傳送的影像/視訊 URL。

contentType

string

影像/視訊的 MIME 類型。

name

string

(選擇性) 影像/視訊檔案的名稱。

text

string

(選擇性) 訊息的文字。

speak

string

(選擇性) SSML 以包含在訊息中。

inputHint

InputHints | string

(訊息的選擇性) 輸入提示。

傳回

Partial<Activity>

訊息活動，將向使用者顯示單一影像或視訊。

備註

此範例顯示將影像傳送給使用者：

const message = MessageFactory.contentUrl('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'A photo from our family vacation.');

list(Attachment[], string, string, InputHints | string)

會傳回一則訊息，以顯示清單表單中的一組附件。

static function list(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

參數

attachments

Attachment[]

要包含在郵件中的附件陣列。

text

string

(選擇性) 訊息的文字。

speak

string

(選擇性) SSML 以包含在訊息中。

inputHint

InputHints | string

(訊息的選擇性) 輸入提示。

傳回

Partial<Activity>

將顯示清單表單中一組附件的郵件活動。

備註

此範例示範如何建立含有主圖卡片清單的訊息：

const message = MessageFactory.list([
   CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
   CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
   CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
]);

suggestedActions(string | CardAction[], string, string, InputHints | string)

傳回包含一組建議動作和選擇性文字的訊息。

static function suggestedActions(actions: string | CardAction[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

參數

actions

string | CardAction[]

要包含的卡片動作或字串陣列。 字串將會轉換成 messageBack 動作。

text

string

(選擇性) 訊息的文字。

speak

string

(選擇性) SSML 以包含在訊息中。

inputHint

InputHints | string

(訊息的選擇性) 輸入提示。 預設值為 acceptingInput。

傳回

Partial<Activity>

包含建議動作的訊息活動。

備註

此範例示範如何建立含有建議動作的訊息：

const message = MessageFactory.suggestedActions(['red', 'green', 'blue'], `Choose a color`);

text(string, string, InputHints | string)

傳回簡單的文字訊息。

static function text(text: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

參數

text

string

要包含在訊息中的文字。

speak

string

(選擇性) SSML 以包含在訊息中。

inputHint

InputHints | string

(訊息的選擇性) 輸入提示。 預設值為 acceptingInput。

傳回

Partial<Activity>

包含文字的訊息活動。

備註

此範例顯示傳送簡單的簡訊：

const message = MessageFactory.text('Greetings from example message');