MessageFactory Classe

  • Référence
Paquet:
com.microsoft.bot.builder
Artefact Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

Contient des méthodes utilitaires pour différents types de messages qu’un bot peut retourner.

Créez et envoyez un message. Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

Les éléments suivants s’appliquent aux actions de message en général. Consultez la documentation du canal pour connaître les limites imposées au contenu du texte du message à envoyer.

Pour contrôler différentes caractéristiques de la parole de votre bot, telles que la voix, la vitesse, le volume, la prononciation et la hauteur, spécifiez un test pour parler au format SSML (Speech Synthesis Markup Language).

Les canaux déterminent la façon dont chaque action de carte manifeste dans son expérience utilisateur. Dans la plupart des cas, les cartes sont cliquables. Dans d’autres, ils peuvent être sélectionnés par entrée vocale. Dans les cas où le canal n’offre pas d’expérience d’activation interactive (par exemple, lors de l’interaction via SMS), le canal peut ne pas prendre en charge l’activation. La décision de rendre des actions est contrôlée par des exigences normatives ailleurs dans ce document (par exemple, au format de carte ou dans la définition d’actions suggérées).

Résumé de la méthode

Modificateur et type Méthode et description
static Activity attachment(Attachment attachment)

Retourne une activité de message qui contient une pièce jointe.
static Activity attachment(Attachment attachment, String text)

Retourne une activité de message qui contient une pièce jointe.
static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

Retourne une activité de message qui contient une pièce jointe.
static Activity attachment(List<Attachment> attachments)

Retourne une activité de message qui contient une pièce jointe.
static Activity attachment(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Retourne une activité de message qui contient une pièce jointe.
static Activity carousel(List<Attachment> attachments, String text)

Retourne une activité de message qui contient une collection de pièces jointes, dans une liste.
static Activity carousel(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Retourne une activité de message qui contient une collection de pièces jointes, dans une liste.
static Activity contentUrl(String url, String contentType)

Retourne une activité de message qui contient une seule image ou vidéo.
static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

Retourne une activité de message qui contient une seule image ou vidéo.
static Activity suggestedActions(List<String> actions, String text)

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif.
static Activity suggestedActions(List<String> actions, String text, String ssml, InputHints inputHint)

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif.
static Activity suggestedCardActions(List<CardAction> actions, String text)

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif.
static Activity suggestedCardActions(List<CardAction> actions, String text, String ssml, InputHints inputHint)

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif.
static Activity text(String text)

Retourne un message texte simple.
static Activity text(String text, String ssml, InputHints inputHint)

Retourne un message texte simple.

Méthodes héritées de 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

Détails de la méthode

attachment

public static Activity attachment(Attachment attachment)

Retourne une activité de message qui contient une pièce jointe.

Paramètres:

attachment - Pièce jointe à inclure dans le message.

Retours:

Activité de message contenant la pièce jointe.

attachment

public static Activity attachment(Attachment attachment, String text)

Retourne une activité de message qui contient une pièce jointe.

Paramètres:

attachment - Pièce jointe à inclure dans le message.
text - Facultatif, texte du message à envoyer.

Retours:

Activité de message contenant la pièce jointe.

attachment

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

Retourne une activité de message qui contient une pièce jointe.

Paramètres:

attachment - Pièce jointe à inclure dans le message.
text - Facultatif, texte du message à envoyer.
ssml - Facultatif, texte à prononcer par votre bot sur un canal d’activation vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. La valeur par défaut est ACCEPTING_INPUT.

Retours:

Activité de message contenant la pièce jointe.

attachment

public static Activity attachment(List attachments)

Retourne une activité de message qui contient une pièce jointe.

Paramètres:

attachments - Pièces jointes à inclure dans le message.

Retours:

Activité de message contenant la pièce jointe.

attachment

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

Retourne une activité de message qui contient une pièce jointe.

Paramètres:

attachments - Pièces jointes à inclure dans le message.
text - Facultatif, texte du message à envoyer.
ssml - Facultatif, texte à prononcer par votre bot sur un canal d’activation vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. La valeur par défaut est ACCEPTING_INPUT.

Retours:

Activité de message contenant la pièce jointe.

carousel

public static Activity carousel(List attachments, String text)

Retourne une activité de message qui contient une collection de pièces jointes, dans une liste.

Paramètres:

attachments - Pièces jointes à inclure dans le message.
text - Facultatif, texte du message à envoyer.

Retours:

Activité de message contenant la pièce jointe.

carousel

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

Retourne une activité de message qui contient une collection de pièces jointes, dans une liste.

Paramètres:

attachments - Pièces jointes à inclure dans le message.
text - Facultatif, texte du message à envoyer.
ssml - Facultatif, texte à prononcer par votre bot sur un canal d’activation vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. La valeur par défaut est ACCEPTING_INPUT.

Retours:

Activité de message contenant la pièce jointe.

contentUrl

public static Activity contentUrl(String url, String contentType)

Retourne une activité de message qui contient une seule image ou vidéo.

Paramètres:

url - URL de l’image ou de la vidéo à envoyer.
contentType - Type MIME de l’image ou de la vidéo.

Retours:

Activité de message contenant la pièce jointe.

contentUrl

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

Retourne une activité de message qui contient une seule image ou vidéo.

Paramètres:

url - URL de l’image ou de la vidéo à envoyer.
contentType - Type MIME de l’image ou de la vidéo.
name - Facultatif, nom du fichier image ou vidéo.
text - Facultatif, texte du message à envoyer.
ssml - Facultatif, texte à prononcer par votre bot sur un canal d’activation vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. La valeur par défaut est ACCEPTING_INPUT.

Retours:

Activité de message contenant la pièce jointe.

suggestedActions

public static Activity suggestedActions(List actions, String text)

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif. // 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);

Paramètres:

actions - Texte des actions à créer.
text - Optionnel. Texte du message à envoyer.

Retours:

Activité de message contenant les actions suggérées.

suggestedActions

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

Retourne un message qui inclut un ensemble d’actions suggérées et du texte facultatif. // 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);

Paramètres:

actions - Texte des actions à créer.
text - Optionnel. Texte du message à envoyer.
ssml - Facultatif, texte à prononcer par votre bot sur un canal d’activation vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. La valeur par défaut est ACCEPTING_INPUT.

Retours:

Activité de message contenant les actions suggérées.

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

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

Paramètres:

actions - Actions de carte à inclure.
text - Facultatif, texte du message à envoyer.

Retours:

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

suggestedCardActions

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

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

Paramètres:

actions - Actions de carte à inclure.
text - Facultatif, texte du message à envoyer.
ssml - Facultatif, texte à prononcer par votre bot sur un canal d’activation vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. La valeur par défaut est ACCEPTING_INPUT.

Retours:

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

text

public static Activity text(String text)

Retourne un message texte simple.

Paramètres:

text - Texte du message à envoyer.

Retours:

Activité de message contenant le texte.

text

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

Retourne un message texte simple.

Paramètres:

text - Texte du message à envoyer.
ssml - Facultatif, texte à prononcer par votre bot sur un canal avec reconnaissance vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. La valeur par défaut est ACCEPTING_INPUT.

Retours:

Activité de message contenant le texte.

S’applique à