MessageFactory Clase

  • Referencia
Paquete:
com.microsoft.bot.builder
Artefacto Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

Contiene métodos de utilidad para varios tipos de mensajes que puede devolver un bot.

Cree y envíe un mensaje. Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

Lo siguiente se aplica a las acciones de mensaje en general. Consulte la documentación del canal para ver los límites impuestos sobre el contenido del texto del mensaje que se va a enviar.

Para controlar varias características de la voz del bot, como voz, velocidad, volumen, pronunciación y tono, especifique la prueba para hablar en formato lenguaje de marcado de síntesis de voz (SSML).

Los canales deciden cómo se manifiesta cada acción de tarjeta en su experiencia de usuario. En la mayoría de los casos, se pueden hacer clic en las tarjetas. En otros, pueden seleccionarse mediante la entrada de voz. En los casos en los que el canal no ofrezca una experiencia de activación interactiva (por ejemplo, al interactuar a través de SMS), es posible que el canal no admita la activación. La decisión sobre cómo representar acciones se controla mediante requisitos normativos en otros lugares de este documento (por ejemplo, dentro del formato de tarjeta o dentro de la definición de acciones sugeridas).

Resumen del método

Modificador y tipo Método y descripción
static Activity attachment(Attachment attachment)

Devuelve una actividad de mensaje que contiene datos adjuntos.
static Activity attachment(Attachment attachment, String text)

Devuelve una actividad de mensaje que contiene datos adjuntos.
static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

Devuelve una actividad de mensaje que contiene datos adjuntos.
static Activity attachment(List<Attachment> attachments)

Devuelve una actividad de mensaje que contiene datos adjuntos.
static Activity attachment(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Devuelve una actividad de mensaje que contiene datos adjuntos.
static Activity carousel(List<Attachment> attachments, String text)

Devuelve una actividad de mensaje que contiene una colección de datos adjuntos, en una lista.
static Activity carousel(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Devuelve una actividad de mensaje que contiene una colección de datos adjuntos, en una lista.
static Activity contentUrl(String url, String contentType)

Devuelve una actividad de mensaje que contiene una sola imagen o vídeo.
static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

Devuelve una actividad de mensaje que contiene una sola imagen o vídeo.
static Activity suggestedActions(List<String> actions, String text)

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.
static Activity suggestedActions(List<String> actions, String text, String ssml, InputHints inputHint)

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.
static Activity suggestedCardActions(List<CardAction> actions, String text)

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.
static Activity suggestedCardActions(List<CardAction> actions, String text, String ssml, InputHints inputHint)

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.
static Activity text(String text)

Devuelve un mensaje de texto simple.
static Activity text(String text, String ssml, InputHints inputHint)

Devuelve un mensaje de texto simple.

Métodos heredados 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

Detalles del método

attachment

public static Activity attachment(Attachment attachment)

Devuelve una actividad de mensaje que contiene datos adjuntos.

Parámetros:

attachment - Datos adjuntos que se van a incluir en el mensaje.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

attachment

public static Activity attachment(Attachment attachment, String text)

Devuelve una actividad de mensaje que contiene datos adjuntos.

Parámetros:

attachment - Datos adjuntos que se van a incluir en el mensaje.
text - Opcional, el texto del mensaje que se va a enviar.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

attachment

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

Devuelve una actividad de mensaje que contiene datos adjuntos.

Parámetros:

attachment - Datos adjuntos que se van a incluir en el mensaje.
text - Opcional, el texto del mensaje que se va a enviar.
ssml - Opcional, el texto que va a hablar el bot en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. El valor predeterminado es ACCEPTING_INPUT.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

attachment

public static Activity attachment(List attachments)

Devuelve una actividad de mensaje que contiene datos adjuntos.

Parámetros:

attachments - Datos adjuntos que se van a incluir en el mensaje.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

attachment

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

Devuelve una actividad de mensaje que contiene datos adjuntos.

Parámetros:

attachments - Datos adjuntos que se van a incluir en el mensaje.
text - Opcional, el texto del mensaje que se va a enviar.
ssml - Opcional, el texto que va a hablar el bot en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. El valor predeterminado es ACCEPTING_INPUT.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

carousel

public static Activity carousel(List attachments, String text)

Devuelve una actividad de mensaje que contiene una colección de datos adjuntos, en una lista.

Parámetros:

attachments - Datos adjuntos que se van a incluir en el mensaje.
text - Opcional, el texto del mensaje que se va a enviar.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

carousel

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

Devuelve una actividad de mensaje que contiene una colección de datos adjuntos, en una lista.

Parámetros:

attachments - Datos adjuntos que se van a incluir en el mensaje.
text - Opcional, el texto del mensaje que se va a enviar.
ssml - Opcional, el texto que va a hablar el bot en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. El valor predeterminado es ACCEPTING_INPUT.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

contentUrl

public static Activity contentUrl(String url, String contentType)

Devuelve una actividad de mensaje que contiene una sola imagen o vídeo.

Parámetros:

url - Dirección URL de la imagen o vídeo que se va a enviar.
contentType - Tipo MIME de la imagen o vídeo.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

contentUrl

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

Devuelve una actividad de mensaje que contiene una sola imagen o vídeo.

Parámetros:

url - Dirección URL de la imagen o vídeo que se va a enviar.
contentType - Tipo MIME de la imagen o vídeo.
name - Opcional, el nombre del archivo de imagen o vídeo.
text - Opcional, el texto del mensaje que se va a enviar.
ssml - Opcional, el texto que va a hablar el bot en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. El valor predeterminado es ACCEPTING_INPUT.

Devoluciones:

Actividad de mensaje que contiene los datos adjuntos.

suggestedActions

public static Activity suggestedActions(List actions, String text)

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional. // 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);

Parámetros:

actions - Texto de las acciones que se van a crear.
text - Opcional. Texto del mensaje que se va a enviar.

Devoluciones:

Actividad de mensaje que contiene las acciones sugeridas.

suggestedActions

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

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional. // 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);

Parámetros:

actions - Texto de las acciones que se van a crear.
text - Opcional. Texto del mensaje que se va a enviar.
ssml - Opcional, el texto que va a hablar el bot en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. El valor predeterminado es ACCEPTING_INPUT.

Devoluciones:

Actividad de mensaje que contiene las acciones sugeridas.

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.

Parámetros:

actions - Acciones de tarjeta que se van a incluir.
text - Opcional, el texto del mensaje que se va a enviar.

Devoluciones:

Actividad de mensaje que contiene las acciones sugeridas.

suggestedCardActions

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

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.

Parámetros:

actions - Acciones de tarjeta que se van a incluir.
text - Opcional, el texto del mensaje que se va a enviar.
ssml - Opcional, el texto que va a hablar el bot en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. El valor predeterminado es ACCEPTING_INPUT.

Devoluciones:

Actividad de mensaje que contiene las acciones sugeridas.

text

public static Activity text(String text)

Devuelve un mensaje de texto simple.

Parámetros:

text - Texto del mensaje que se va a enviar.

Devoluciones:

Actividad de mensaje que contiene el texto.

text

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

Devuelve un mensaje de texto simple.

Parámetros:

text - Texto del mensaje que se va a enviar.
ssml - Opcional, el bot dirá texto en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. El valor predeterminado es ACCEPTING_INPUT.

Devoluciones:

Actividad de mensaje que contiene el texto.

Se aplica a