MessageFactory class

パッケージ:

botbuilder-core

ボットが返すことができるさまざまなメッセージの種類の書式設定を支援するユーティリティ関数のセット。

注釈

次の例は、1 つのヒーロー カードを含むメッセージの送信を示しています。

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)	添付ファイルを含む 1 つのメッセージ アクティビティを返します。
carousel(Attachment[], string, string, InputHints | string)	カルーセル レイアウトを使用して添付ファイルのセットを表示するメッセージを返します。
contentUrl(string, string, string, string, string, InputHints | string)	1 つの画像またはビデオをユーザーに表示するメッセージを返します。
list(Attachment[], string, string, InputHints | string)	リスト フォームに添付ファイルのセットを表示するメッセージを返します。
suggestedActions(string | CardAction[], string, string, InputHints | string)	一連の推奨されるアクションと省略可能なテキストを含むメッセージを返します。
text(string, string, InputHints | string)	単純なテキスト メッセージを返します。

メソッドの詳細

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

添付ファイルを含む 1 つのメッセージ アクティビティを返します。

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)

1 つの画像またはビデオをユーザーに表示するメッセージを返します。

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>

1 つの画像またはビデオをユーザーに表示するメッセージ アクティビティ。

注釈

この例では、ユーザーに画像を送信する方法を示します。

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');