Partager via

MessageFactory class

  • Référence
Paquet:
botbuilder-core

Un ensemble de fonctions utilitaires pour faciliter la mise en forme des différents types de messages qu’un bot peut retourner.

Remarques

L’exemple suivant montre l’envoi d’un message contenant une carte héros unique :

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

Méthodes

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

Retourne une activité de message unique contenant une pièce jointe.
carousel(Attachment[], string, string, InputHints | string)

Retourne un message qui affiche un ensemble de pièces jointes à l’aide d’une disposition carrousel.
contentUrl(string, string, string, string, string, InputHints | string)

Retourne un message qui affiche une seule image ou une vidéo à un utilisateur.
list(Attachment[], string, string, InputHints | string)

Retourne un message qui affiche un ensemble de pièces jointes sous forme de liste.
suggestedActions(string | CardAction[], string, string, InputHints | string)

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif.
text(string, string, InputHints | string)

Retourne un message texte simple.

Détails de la méthode

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

Retourne une activité de message unique contenant une pièce jointe.

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

Paramètres

attachment

Attachment

Carte adaptative à inclure dans le message.

text

string

(Facultatif) texte du message.

speak

string

(Facultatif) SSML à inclure avec le message.

inputHint

InputHints | string

(Facultatif) indicateur d’entrée pour le message. La valeur par défaut est acceptingInput.

Retours

Partial<Activity>

Activité de message contenant la pièce jointe.

Remarques

Cet exemple montre comment créer un message avec une pièce jointe de carte héros :

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

Retourne un message qui affiche un ensemble de pièces jointes à l’aide d’une disposition carrousel.

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

Paramètres

attachments

Attachment[]

Tableau de pièces jointes à inclure dans le message.

text

string

(Facultatif) texte du message.

speak

string

(Facultatif) SSML à inclure avec le message.

inputHint

InputHints | string

(Facultatif) indicateur d’entrée pour le message.

Retours

Partial<Activity>

Activité de message qui affiche un ensemble de pièces jointes à l’aide d’une disposition carrousel.

Remarques

Cet exemple montre comment créer un message avec un carrousel de cartes héros :

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)

Retourne un message qui affiche une seule image ou une vidéo à un utilisateur.

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

Paramètres

url

string

URL de l’image/vidéo à envoyer.

contentType

string

Type MIME de l’image/vidéo.

name

string

(Facultatif) Nom du fichier image/vidéo.

text

string

(Facultatif) texte du message.

speak

string

(Facultatif) SSML à inclure avec le message.

inputHint

InputHints | string

(Facultatif) indicateur d’entrée pour le message.

Retours

Partial<Activity>

Activité de message qui affiche une seule image ou vidéo à un utilisateur.

Remarques

Cet exemple montre l’envoi d’une image à l’utilisateur :

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)

Retourne un message qui affiche un ensemble de pièces jointes sous forme de liste.

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

Paramètres

attachments

Attachment[]

Tableau de pièces jointes à inclure dans le message.

text

string

(Facultatif) texte du message.

speak

string

(Facultatif) SSML à inclure avec le message.

inputHint

InputHints | string

(Facultatif) indicateur d’entrée pour le message.

Retours

Partial<Activity>

Activité de message qui affiche un ensemble de pièces jointes sous forme de liste.

Remarques

Cet exemple montre comment créer un message avec une liste de cartes héros :

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)

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif.

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

Paramètres

actions

string | CardAction[]

Tableau d’actions ou de chaînes de carte à inclure. Les chaînes sont converties en actions messageBack.

text

string

(Facultatif) texte du message.

speak

string

(Facultatif) SSML à inclure avec le message.

inputHint

InputHints | string

(Facultatif) indicateur d’entrée pour le message. La valeur par défaut est acceptingInput.

Retours

Partial<Activity>

Activité de message qui contient les actions suggérées.

Remarques

Cet exemple montre comment créer un message avec des actions suggérées :

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

text(string, string, InputHints | string)

Retourne un message texte simple.

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

Paramètres

text

string

Texte à inclure dans le message.

speak

string

(Facultatif) SSML à inclure dans le message.

inputHint

InputHints | string

(Facultatif) indicateur d’entrée pour le message. La valeur par défaut est acceptingInput.

Retours

Partial<Activity>

Activité de message contenant le texte.

Remarques

Cet exemple montre l’envoi d’un message texte simple :

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