MessageFactory クラス

  • リファレンス
パッケージ:
com.microsoft.bot.builder
Maven 成果物:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

ボットが返すことができるさまざまなメッセージの種類のユーティリティ メソッドが含まれています。

メッセージを作成して送信します。 Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

一般的なメッセージ アクションには、次の処理が適用されます。 送信するメッセージのテキストの内容に課される制限については、チャネルのドキュメントを参照してください。

音声、速度、音量、発音、ピッチなど、ボットの音声のさまざまな特性を制御するには、音声合成マークアップ言語 (SSML) 形式で話すテストを指定します。

チャネルは、各カード アクションがユーザー エクスペリエンスでどのようにマニフェストされるかを決定します。 ほとんどの場合、カードはクリック可能です。 つまり、音声入力で選択することができます。 チャネルが対話型のアクティベーション エクスペリエンスを提供しない場合 (たとえば、SMS を介して対話する場合など)、チャネルはアクティベーションをまったくサポートしない可能性があります。 アクションのレンダリング方法の決定は、このドキュメントの他の箇所 (たとえば、カード形式内、推奨されるアクションの定義内) に記載されている標準の要件によって制御されます。

メソッドの概要

修飾子と型 メソッドと説明
static Activity attachment(Attachment attachment)

添付ファイルを含むメッセージ アクティビティを返します。
static Activity attachment(Attachment attachment, String text)

添付ファイルを含むメッセージ アクティビティを返します。
static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

添付ファイルを含むメッセージ アクティビティを返します。
static Activity attachment(List<Attachment> attachments)

添付ファイルを含むメッセージ アクティビティを返します。
static Activity attachment(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

添付ファイルを含むメッセージ アクティビティを返します。
static Activity carousel(List<Attachment> attachments, String text)

添付ファイルのコレクションを一覧に含むメッセージ アクティビティを返します。
static Activity carousel(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

添付ファイルのコレクションを一覧に含むメッセージ アクティビティを返します。
static Activity contentUrl(String url, String contentType)

1 つの画像またはビデオを含むメッセージ アクティビティを返します。
static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

1 つの画像またはビデオを含むメッセージ アクティビティを返します。
static Activity suggestedActions(List<String> actions, String text)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。
static Activity suggestedActions(List<String> actions, String text, String ssml, InputHints inputHint)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。
static Activity suggestedCardActions(List<CardAction> actions, String text)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。
static Activity suggestedCardActions(List<CardAction> actions, String text, String ssml, InputHints inputHint)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。
static Activity text(String text)

単純なテキスト メッセージを返します。
static Activity text(String text, String ssml, InputHints inputHint)

単純なテキスト メッセージを返します。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

メソッドの詳細

attachment

public static Activity attachment(Attachment attachment)

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

Parameters:

attachment - メッセージに含める添付ファイル。

Returns:

添付ファイルを含むメッセージ アクティビティ。

attachment

public static Activity attachment(Attachment attachment, String text)

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

Parameters:

attachment - メッセージに含める添付ファイル。
text - 省略可能。送信するメッセージのテキスト。

Returns:

添付ファイルを含むメッセージ アクティビティ。

attachment

public static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

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

Parameters:

attachment - メッセージに含める添付ファイル。
text - 省略可能。送信するメッセージのテキスト。
ssml - 音声対応チャネルでボットが読み上げるテキスト (省略可能)。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示します。 既定値は ACCEPTING_INPUT です。

Returns:

添付ファイルを含むメッセージ アクティビティ。

attachment

public static Activity attachment(List attachments)

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

Parameters:

attachments - メッセージに含める添付ファイル。

Returns:

添付ファイルを含むメッセージ アクティビティ。

attachment

public static Activity attachment(List attachments, String text, String ssml, InputHints inputHint)

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

Parameters:

attachments - メッセージに含める添付ファイル。
text - 省略可能。送信するメッセージのテキスト。
ssml - 音声対応チャネルでボットが読み上げるテキスト (省略可能)。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示します。 既定値は ACCEPTING_INPUT です。

Returns:

添付ファイルを含むメッセージ アクティビティ。

carousel

public static Activity carousel(List attachments, String text)

添付ファイルのコレクションを一覧に含むメッセージ アクティビティを返します。

Parameters:

attachments - メッセージに含める添付ファイル。
text - 省略可能。送信するメッセージのテキスト。

Returns:

添付ファイルを含むメッセージ アクティビティ。

carousel

public static Activity carousel(List attachments, String text, String ssml, InputHints inputHint)

添付ファイルのコレクションを一覧に含むメッセージ アクティビティを返します。

Parameters:

attachments - メッセージに含める添付ファイル。
text - 省略可能。送信するメッセージのテキスト。
ssml - 音声対応チャネルでボットが読み上げるテキスト (省略可能)。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示します。 既定値は ACCEPTING_INPUT です。

Returns:

添付ファイルを含むメッセージ アクティビティ。

contentUrl

public static Activity contentUrl(String url, String contentType)

1 つの画像またはビデオを含むメッセージ アクティビティを返します。

Parameters:

url - 送信する画像またはビデオの URL。
contentType - 画像またはビデオの MIME の種類。

Returns:

添付ファイルを含むメッセージ アクティビティ。

contentUrl

public static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

1 つの画像またはビデオを含むメッセージ アクティビティを返します。

Parameters:

url - 送信する画像またはビデオの URL。
contentType - 画像またはビデオの MIME の種類。
name - オプション。画像またはビデオ ファイルの名前。
text - 省略可能。送信するメッセージのテキスト。
ssml - 音声対応チャネルでボットが読み上げるテキスト (省略可能)。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示します。 既定値は ACCEPTING_INPUT です。

Returns:

添付ファイルを含むメッセージ アクティビティ。

suggestedActions

public static Activity suggestedActions(List actions, String text)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。 // Create the activity and add suggested actions. Activity activity = MessageFactory.suggestedActions( new String[] { "red", "green", "blue" }, "Choose a color");

// Send the activity as a reply to the user. context.sendActivity(activity);

Parameters:

actions - 作成するアクションのテキスト。
text - 省略可能。 送信するメッセージのテキスト。

Returns:

推奨されるアクションを含むメッセージ アクティビティ。

suggestedActions

public static Activity suggestedActions(List actions, String text, String ssml, InputHints inputHint)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。 // Create the activity and add suggested actions. Activity activity = MessageFactory.suggestedActions( new String[] { "red", "green", "blue" }, "Choose a color");

// Send the activity as a reply to the user. context.sendActivity(activity);

Parameters:

actions - 作成するアクションのテキスト。
text - 省略可能。 送信するメッセージのテキスト。
ssml - 音声対応チャネルでボットが読み上げるテキスト (省略可能)。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示します。 既定値は ACCEPTING_INPUT です。

Returns:

推奨されるアクションを含むメッセージ アクティビティ。

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。

Parameters:

actions - 含めるカード アクション。
text - 省略可能。送信するメッセージのテキスト。

Returns:

推奨されるアクションを含むメッセージ アクティビティ。

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text, String ssml, InputHints inputHint)

推奨される一連のアクションと省略可能なテキストを含むメッセージを返します。

Parameters:

actions - 含めるカード アクション。
text - 省略可能。送信するメッセージのテキスト。
ssml - 音声対応チャネルでボットが読み上げるテキスト (省略可能)。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示します。 既定値は ACCEPTING_INPUT です。

Returns:

推奨されるアクションを含むメッセージ アクティビティ。

text

public static Activity text(String text)

単純なテキスト メッセージを返します。

Parameters:

text - 送信するメッセージのテキスト。

Returns:

テキストを含むメッセージ アクティビティ。

text

public static Activity text(String text, String ssml, InputHints inputHint)

単純なテキスト メッセージを返します。

Parameters:

text - 送信するメッセージのテキスト。
ssml - 音声対応チャネルでボットが読み上げるテキスト (省略可能)。
inputHint - 省略可能。 は、メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示します。 既定値は ACCEPTING_INPUT です。

Returns:

テキストを含むメッセージ アクティビティ。

適用対象