MessageFactory class

Paket:

botbuilder-core

Eine Reihe von Hilfsfunktionen, die bei der Formatierung der verschiedenen Nachrichtentypen helfen, die ein Bot zurückgeben kann.

Hinweise

Das folgende Beispiel zeigt das Senden einer Nachricht, die eine einzelne Hero-Karte enthält:

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

Methoden

attachment(Attachment, string, string, InputHints | string)	Gibt eine einzelne Nachrichtenaktivität zurück, die eine Anlage enthält.
carousel(Attachment[], string, string, InputHints | string)	Gibt eine Nachricht zurück, die eine Reihe von Anlagen mithilfe eines Karusselllayouts anzeigt.
contentUrl(string, string, string, string, string, InputHints | string)	Gibt eine Nachricht zurück, die einem Benutzer ein einzelnes Bild oder Video anzeigt.
list(Attachment[], string, string, InputHints | string)	Gibt eine Nachricht zurück, die eine Reihe von Anlagen in Listenform anzeigt.
suggestedActions(string | CardAction[], string, string, InputHints | string)	Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.
text(string, string, InputHints | string)	Gibt eine einfache TEXTnachricht zurück.

Details zur Methode

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

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

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

Parameter

attachment

Attachment

Adaptive Karte, die in die Nachricht aufgenommen werden soll.

text

string

(Optional) Text der Nachricht.

speak

string

(Optional) SSML, das in die Nachricht eingeschlossen werden soll.

inputHint

InputHints | string

(Optional) Eingabehinweis für die Nachricht. Wird standardmäßig auf acceptingInput festgelegt.

Gibt zurück

Partial<Activity>

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

Hinweise

Dieses Beispiel zeigt das Erstellen einer Nachricht mit einer Hero-Kartenanlage:

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

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

Gibt eine Nachricht zurück, die eine Reihe von Anlagen mithilfe eines Karusselllayouts anzeigt.

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

Parameter

attachments

Attachment[]

Array von Anlagen, die in die Nachricht eingeschlossen werden sollen.

text

string

(Optional) Text der Nachricht.

speak

string

(Optional) SSML, das in die Nachricht eingeschlossen werden soll.

inputHint

InputHints | string

(Optional) Eingabehinweis für die Nachricht.

Gibt zurück

Partial<Activity>

Eine Nachrichtenaktivität, die eine Reihe von Anlagen mithilfe eines Karusselllayouts anzeigt.

Hinweise

Dieses Beispiel zeigt das Erstellen einer Nachricht mit einem Karussell von Heldenkarten:

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)

Gibt eine Nachricht zurück, die einem Benutzer ein einzelnes Bild oder Video anzeigt.

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

Parameter

url

string

URL des zu sendenden Bilds/Videos.

contentType

string

Der MIME-Typ des Bilds/Videos.

name

string

(Optional) Name der Bild-/Videodatei.

text

string

(Optional) Text der Nachricht.

speak

string

(Optional) SSML, das in die Nachricht eingeschlossen werden soll.

inputHint

InputHints | string

(Optional) Eingabehinweis für die Nachricht.

Gibt zurück

Partial<Activity>

Eine Nachrichtenaktivität, die einem Benutzer ein einzelnes Bild oder Video anzeigt.

Hinweise

Dieses Beispiel zeigt das Senden eines Bilds an den Benutzer:

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)

Gibt eine Nachricht zurück, die eine Reihe von Anlagen in Listenform anzeigt.

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

Parameter

attachments

Attachment[]

Array von Anlagen, die in die Nachricht eingeschlossen werden sollen.

text

string

(Optional) Text der Nachricht.

speak

string

(Optional) SSML, das in die Nachricht eingeschlossen werden soll.

inputHint

InputHints | string

(Optional) Eingabehinweis für die Nachricht.

Gibt zurück

Partial<Activity>

Eine Nachrichtenaktivität, die eine Reihe von Anlagen in Listenform anzeigt.

Hinweise

Dieses Beispiel zeigt das Erstellen einer Nachricht mit einer Liste von Hero-Karten:

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)

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

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

Parameter

actions

string | CardAction[]

Array von Kartenaktionen oder Zeichenfolgen, die eingeschlossen werden sollen. Zeichenfolgen werden in messageBack Aktionen konvertiert.

text

string

(Optional) Text der Nachricht.

speak

string

(Optional) SSML, das in die Nachricht eingeschlossen werden soll.

inputHint

InputHints | string

(Optional) Eingabehinweis für die Nachricht. Wird standardmäßig auf acceptingInput festgelegt.

Gibt zurück

Partial<Activity>

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

Hinweise

Dieses Beispiel zeigt das Erstellen einer Nachricht mit vorgeschlagenen Aktionen:

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

text(string, string, InputHints | string)

Gibt eine einfache TEXTnachricht zurück.

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

Parameter

text

string

Text, der in die Nachricht aufgenommen werden soll.

speak

string

(Optional) SSML, das in die Nachricht eingeschlossen werden soll.

inputHint

InputHints | string

(Optional) Eingabehinweis für die Nachricht. Wird standardmäßig auf acceptingInput festgelegt.

Gibt zurück

Partial<Activity>

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

Hinweise

Dieses Beispiel zeigt das Senden einer einfachen SMS:

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