MessageFactory 類別

  • java.lang.Object
    • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

包含 Bot 可以傳回之各種訊息類型的公用程式方法。

建立並傳送訊息。 Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

下列動作適用於一般訊息動作。 如需郵件要傳送之文字內容的限制,請參閱通道的檔。

若要控制 Bot 語音的各種特性,例如語音、速率、音量、發音和音調,請指定以語音合成標記語言 (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)

傳回包含單一影像或視訊的訊息活動。

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

傳回包含單一影像或視訊的訊息活動。

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)

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

參數:

attachment - 要包含在郵件中的附件。

傳回:

包含附件的郵件活動。

attachment

public static Activity attachment(Attachment attachment, String text)

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

參數:

attachment - 要包含在郵件中的附件。
text - 選擇性的訊息要傳送的文字。

傳回:

包含附件的郵件活動。

attachment

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

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

參數:

attachment - 要包含在郵件中的附件。
text - 選擇性的訊息要傳送的文字。
ssml - 選擇性的語音啟用通道上 Bot 所要說出的文字。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 預設值為 ACCEPTING_INPUT

傳回:

包含附件的郵件活動。

attachment

public static Activity attachment(List attachments)

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

參數:

attachments - 要包含在郵件中的附件。

傳回:

包含附件的郵件活動。

attachment

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

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

參數:

attachments - 要包含在郵件中的附件。
text - 選擇性的訊息要傳送的文字。
ssml - 選擇性的語音啟用通道上 Bot 所要說出的文字。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 預設值為 ACCEPTING_INPUT

傳回:

包含附件的郵件活動。

carousel

public static Activity carousel(List attachments, String text)

傳回訊息活動,其中包含清單中的附件集合。

參數:

attachments - 要包含在郵件中的附件。
text - 選擇性的訊息要傳送的文字。

傳回:

包含附件的郵件活動。

carousel

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

傳回訊息活動,其中包含清單中的附件集合。

參數:

attachments - 要包含在郵件中的附件。
text - 選擇性的訊息要傳送的文字。
ssml - 選擇性的語音啟用通道上 Bot 所要說出的文字。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 預設值為 ACCEPTING_INPUT

傳回:

包含附件的郵件活動。

contentUrl

public static Activity contentUrl(String url, String contentType)

傳回包含單一影像或視訊的訊息活動。

參數:

url - 要傳送之影像或視訊的URL。
contentType - 影像或視訊的MIME類型。

傳回:

包含附件的郵件活動。

contentUrl

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

傳回包含單一影像或視訊的訊息活動。

參數:

url - 要傳送之影像或視訊的URL。
contentType - 影像或視訊的MIME類型。
name - 選擇性的影像或視訊檔名稱。
text - 選擇性的訊息要傳送的文字。
ssml - 選擇性的語音啟用通道上 Bot 所要說出的文字。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 預設值為 ACCEPTING_INPUT

傳回:

包含附件的郵件活動。

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

參數:

actions - 要建立之動作的文字。
text - 自選。 要傳送之訊息的文字。

傳回:

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

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

參數:

actions - 要建立之動作的文字。
text - 自選。 要傳送之訊息的文字。
ssml - 選擇性的語音啟用通道上 Bot 所要說出的文字。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 預設值為 ACCEPTING_INPUT

傳回:

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

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

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

參數:

actions - 要包含的卡片動作。
text - 選擇性的訊息要傳送的文字。

傳回:

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

suggestedCardActions

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

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

參數:

actions - 要包含的卡片動作。
text - 選擇性的訊息要傳送的文字。
ssml - 選擇性的語音啟用通道上 Bot 所要說出的文字。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 預設值為 ACCEPTING_INPUT

傳回:

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

text

public static Activity text(String text)

傳回簡單的簡訊。

參數:

text - 要傳送之訊息的文字。

傳回:

包含文字的訊息活動。

text

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

傳回簡單的簡訊。

參數:

text - 要傳送之訊息的文字。
ssml - 選擇性的文字,由 Bot 在啟用語音功能的通道上說出。
inputHint - 選擇性表示 Bot 在訊息傳遞至客戶端之後是否接受、預期或忽略使用者輸入。 預設值為 ACCEPTING_INPUT

傳回:

包含文字的訊息活動。

適用於