MessageFactory Klasse

  • Referenz
Paket:
com.microsoft.bot.builder
Maven-Artefakt:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

Enthält Hilfsmethoden für verschiedene Nachrichtentypen, die ein Bot zurückgeben kann.

Erstellen und Senden einer Nachricht Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

Im Allgemeinen gelten die folgenden Aktionen für Nachrichten. In der Dokumentation des Kanals finden Sie Beschränkungen, die dem Inhalt des zu sendenden Texts der Nachricht auferlegt werden.

Um verschiedene Merkmale der Spracherkennung Ihres Bots zu steuern, z. B. Sprache, Rate, Lautstärke, Aussprache und Tonhöhe, geben Sie den Test an, um im SSML-Format (Speech Synthesis Markup Language) zu sprechen.

Kanäle entscheiden, wie sich die einzelnen Kartenaktionsmanifeste in ihrer Benutzeroberfläche befinden. In den meisten Fällen sind die Karten klickbar. In anderen Personen können sie von der Spracheingabe ausgewählt werden. In Fällen, in denen der Kanal keine interaktive Aktivierungserfahrung (z. B. bei der Interaktion über SMS) bietet, unterstützt der Kanal die Aktivierung möglicherweise nicht. Die Entscheidung über das Rendern von Aktionen wird an anderer Stelle in diesem Dokument durch normative Anforderungen gesteuert (z. B. innerhalb des Kartenformats oder innerhalb der vorgeschlagenen Aktionsdefinition).

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
static Activity attachment(Attachment attachment)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.
static Activity attachment(Attachment attachment, String text)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.
static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.
static Activity attachment(List<Attachment> attachments)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.
static Activity attachment(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.
static Activity carousel(List<Attachment> attachments, String text)

Gibt eine Nachrichtenaktivität zurück, die eine Auflistung von Anlagen in einer Liste enthält.
static Activity carousel(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Gibt eine Nachrichtenaktivität zurück, die eine Auflistung von Anlagen in einer Liste enthält.
static Activity contentUrl(String url, String contentType)

Gibt eine Nachrichtenaktivität zurück, die ein einzelnes Bild oder Video enthält.
static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

Gibt eine Nachrichtenaktivität zurück, die ein einzelnes Bild oder Video enthält.
static Activity suggestedActions(List<String> actions, String text)

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.
static Activity suggestedActions(List<String> actions, String text, String ssml, InputHints inputHint)

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.
static Activity suggestedCardActions(List<CardAction> actions, String text)

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.
static Activity suggestedCardActions(List<CardAction> actions, String text, String ssml, InputHints inputHint)

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.
static Activity text(String text)

Gibt eine einfache Textnachricht zurück.
static Activity text(String text, String ssml, InputHints inputHint)

Gibt eine einfache Textnachricht zurück.

Geerbte Methoden von 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

Details zur Methode

attachment

public static Activity attachment(Attachment attachment)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.

Parameter:

attachment - Anlage, die in die Nachricht eingeschlossen werden soll.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

attachment

public static Activity attachment(Attachment attachment, String text)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.

Parameter:

attachment - Anlage, die in die Nachricht eingeschlossen werden soll.
text - Optional, der Text der zu sendenden Nachricht.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

attachment

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

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.

Parameter:

attachment - Anlage, die in die Nachricht eingeschlossen werden soll.
text - Optional, der Text der zu sendenden Nachricht.
ssml - Optional, Text, der von Ihrem Bot in einem Sprachaktivierungskanal gesprochen werden soll.
inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Der Standardwert ist ACCEPTING_INPUT.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

attachment

public static Activity attachment(List attachments)

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.

Parameter:

attachments - Anlagen, die in die Nachricht eingeschlossen werden sollen.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

attachment

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

Gibt eine Nachrichtenaktivität zurück, die eine Anlage enthält.

Parameter:

attachments - Anlagen, die in die Nachricht eingeschlossen werden sollen.
text - Optional, der Text der zu sendenden Nachricht.
ssml - Optional, Text, der von Ihrem Bot in einem Sprachaktivierungskanal gesprochen werden soll.
inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Der Standardwert ist ACCEPTING_INPUT.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

carousel

public static Activity carousel(List attachments, String text)

Gibt eine Nachrichtenaktivität zurück, die eine Auflistung von Anlagen in einer Liste enthält.

Parameter:

attachments - Anlagen, die in die Nachricht eingeschlossen werden sollen.
text - Optional, der Text der zu sendenden Nachricht.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

carousel

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

Gibt eine Nachrichtenaktivität zurück, die eine Auflistung von Anlagen in einer Liste enthält.

Parameter:

attachments - Anlagen, die in die Nachricht eingeschlossen werden sollen.
text - Optional, der Text der zu sendenden Nachricht.
ssml - Optional, Text, der von Ihrem Bot in einem Sprachaktivierungskanal gesprochen werden soll.
inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Der Standardwert ist ACCEPTING_INPUT.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

contentUrl

public static Activity contentUrl(String url, String contentType)

Gibt eine Nachrichtenaktivität zurück, die ein einzelnes Bild oder Video enthält.

Parameter:

url - Die URL des zu sendenden Bilds oder Videos.
contentType - Der MIME-Typ des Bilds oder Videos.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

contentUrl

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

Gibt eine Nachrichtenaktivität zurück, die ein einzelnes Bild oder Video enthält.

Parameter:

url - Die URL des zu sendenden Bilds oder Videos.
contentType - Der MIME-Typ des Bilds oder Videos.
name - Optional, der Name der Bild- oder Videodatei.
text - Optional, der Text der zu sendenden Nachricht.
ssml - Optional, Text, der von Ihrem Bot in einem Sprachaktivierungskanal gesprochen werden soll.
inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Der Standardwert ist ACCEPTING_INPUT.

Gibt zurück:

Eine Nachrichtenaktivität, die die Anlage enthält.

suggestedActions

public static Activity suggestedActions(List actions, String text)

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält. // 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);

Parameter:

actions - Der Text der zu erstellenden Aktionen.
text - Wahlfrei. Der Text der zu sendenden Nachricht.

Gibt zurück:

Eine Nachrichtenaktivität, die die vorgeschlagenen Aktionen enthält.

suggestedActions

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

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält. // 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);

Parameter:

actions - Der Text der zu erstellenden Aktionen.
text - Wahlfrei. Der Text der zu sendenden Nachricht.
ssml - Optional, Text, der von Ihrem Bot in einem Sprachaktivierungskanal gesprochen werden soll.
inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Der Standardwert ist ACCEPTING_INPUT.

Gibt zurück:

Eine Nachrichtenaktivität, die die vorgeschlagenen Aktionen enthält.

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.

Parameter:

actions - Die einzuschließden Kartenaktionen.
text - Optional, der Text der zu sendenden Nachricht.

Gibt zurück:

Eine Nachrichtenaktivität, die die vorgeschlagenen Aktionen enthält.

suggestedCardActions

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

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.

Parameter:

actions - Die einzuschließden Kartenaktionen.
text - Optional, der Text der zu sendenden Nachricht.
ssml - Optional, Text, der von Ihrem Bot in einem Sprachaktivierungskanal gesprochen werden soll.
inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Der Standardwert ist ACCEPTING_INPUT.

Gibt zurück:

Eine Nachrichtenaktivität, die die vorgeschlagenen Aktionen enthält.

text

public static Activity text(String text)

Gibt eine einfache Textnachricht zurück.

Parameter:

text - Der Text der zu sendenden Nachricht.

Gibt zurück:

Eine Nachrichtenaktivität, die den Text enthält.

text

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

Gibt eine einfache Textnachricht zurück.

Parameter:

text - Der Text der zu sendenden Nachricht.
ssml - Optionaler Text, der von Ihrem Bot in einem sprachfähigen Kanal gesprochen werden soll.
inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Der Standardwert ist ACCEPTING_INPUT.

Gibt zurück:

Eine Nachrichtenaktivität, die den Text enthält.

Gilt für: