MessageFactory Classe

  • Referência
Pacote:
com.microsoft.bot.builder
Artefato Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

Contém métodos utilitários para vários tipos de mensagem que um bot pode retornar.

Crie e envie uma mensagem. Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

A seguir, aplique-se a ações de mensagem em geral. Consulte a documentação do canal para obter limites impostos sobre o conteúdo do texto da mensagem a ser enviada.

Para controlar várias características da fala do bot, como voz, taxa, volume, pronúncia e tom, especifique o teste para falar no formato SSML (Speech Synthesis Markup Language).

Os canais decidem como cada ação de cartão se manifesta na experiência do usuário. Na maioria dos casos, os cartões são clicáveis. Em outros, eles podem ser selecionados por entrada de fala. Nos casos em que o canal não oferece uma experiência de ativação interativa (por exemplo, ao interagir por SMS), o canal pode não dar suporte à ativação. A decisão sobre como renderizar ações é controlada por requisitos normativos em outros lugares neste documento (por exemplo, dentro do formato de cartão ou dentro da definição de ações sugeridas).

Resumo do método

Modificador e tipo Método e descrição
static Activity attachment(Attachment attachment)

Retorna uma atividade de mensagem que contém um anexo.
static Activity attachment(Attachment attachment, String text)

Retorna uma atividade de mensagem que contém um anexo.
static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

Retorna uma atividade de mensagem que contém um anexo.
static Activity attachment(List<Attachment> attachments)

Retorna uma atividade de mensagem que contém um anexo.
static Activity attachment(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Retorna uma atividade de mensagem que contém um anexo.
static Activity carousel(List<Attachment> attachments, String text)

Retorna uma atividade de mensagem que contém uma coleção de anexos, em uma lista.
static Activity carousel(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Retorna uma atividade de mensagem que contém uma coleção de anexos, em uma lista.
static Activity contentUrl(String url, String contentType)

Retorna uma atividade de mensagem que contém uma única imagem ou vídeo.
static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

Retorna uma atividade de mensagem que contém uma única imagem ou vídeo.
static Activity suggestedActions(List<String> actions, String text)

Retorna uma mensagem que inclui um conjunto de ações sugeridas e texto opcional.
static Activity suggestedActions(List<String> actions, String text, String ssml, InputHints inputHint)

Retorna uma mensagem que inclui um conjunto de ações sugeridas e texto opcional.
static Activity suggestedCardActions(List<CardAction> actions, String text)

Retorna uma mensagem que inclui um conjunto de ações sugeridas e texto opcional.
static Activity suggestedCardActions(List<CardAction> actions, String text, String ssml, InputHints inputHint)

Retorna uma mensagem que inclui um conjunto de ações sugeridas e texto opcional.
static Activity text(String text)

Retorna uma mensagem de texto simples.
static Activity text(String text, String ssml, InputHints inputHint)

Retorna uma mensagem de texto simples.

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

Detalhes do método

attachment

public static Activity attachment(Attachment attachment)

Retorna uma atividade de mensagem que contém um anexo.

Parâmetros:

attachment - Anexo a ser incluído na mensagem.

Retornos:

Uma atividade de mensagem que contém o anexo.

attachment

public static Activity attachment(Attachment attachment, String text)

Retorna uma atividade de mensagem que contém um anexo.

Parâmetros:

attachment - Anexo a ser incluído na mensagem.
text - Opcional, o texto da mensagem a ser enviada.

Retornos:

Uma atividade de mensagem que contém o anexo.

attachment

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

Retorna uma atividade de mensagem que contém um anexo.

Parâmetros:

attachment - Anexo a ser incluído na mensagem.
text - Opcional, o texto da mensagem a ser enviada.
ssml - Opcional, o texto a ser falado pelo bot em um canal de habilitação de fala.
inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. O padrão é ACCEPTING_INPUT.

Retornos:

Uma atividade de mensagem que contém o anexo.

attachment

public static Activity attachment(List attachments)

Retorna uma atividade de mensagem que contém um anexo.

Parâmetros:

attachments - Anexos a serem incluídos na mensagem.

Retornos:

Uma atividade de mensagem que contém o anexo.

attachment

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

Retorna uma atividade de mensagem que contém um anexo.

Parâmetros:

attachments - Anexos a serem incluídos na mensagem.
text - Opcional, o texto da mensagem a ser enviada.
ssml - Opcional, o texto a ser falado pelo bot em um canal de habilitação de fala.
inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. O padrão é ACCEPTING_INPUT.

Retornos:

Uma atividade de mensagem que contém o anexo.

carousel

public static Activity carousel(List attachments, String text)

Retorna uma atividade de mensagem que contém uma coleção de anexos, em uma lista.

Parâmetros:

attachments - Anexos a serem incluídos na mensagem.
text - Opcional, o texto da mensagem a ser enviada.

Retornos:

Uma atividade de mensagem que contém o anexo.

carousel

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

Retorna uma atividade de mensagem que contém uma coleção de anexos, em uma lista.

Parâmetros:

attachments - Anexos a serem incluídos na mensagem.
text - Opcional, o texto da mensagem a ser enviada.
ssml - Opcional, o texto a ser falado pelo bot em um canal de habilitação de fala.
inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. O padrão é ACCEPTING_INPUT.

Retornos:

Uma atividade de mensagem que contém o anexo.

contentUrl

public static Activity contentUrl(String url, String contentType)

Retorna uma atividade de mensagem que contém uma única imagem ou vídeo.

Parâmetros:

url - A URL da imagem ou vídeo a ser enviado.
contentType - O tipo MIME da imagem ou vídeo.

Retornos:

Uma atividade de mensagem que contém o anexo.

contentUrl

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

Retorna uma atividade de mensagem que contém uma única imagem ou vídeo.

Parâmetros:

url - A URL da imagem ou vídeo a ser enviado.
contentType - O tipo MIME da imagem ou vídeo.
name - Opcional, o nome da imagem ou do arquivo de vídeo.
text - Opcional, o texto da mensagem a ser enviada.
ssml - Opcional, o texto a ser falado pelo bot em um canal de habilitação de fala.
inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. O padrão é ACCEPTING_INPUT.

Retornos:

Uma atividade de mensagem que contém o anexo.

suggestedActions

public static Activity suggestedActions(List actions, String text)

Retorna uma mensagem que inclui um conjunto de ações sugeridas e 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 - O texto das ações a serem criadas.
text - Opcional. O texto da mensagem a ser enviada.

Retornos:

Uma atividade de mensagem que contém as ações sugeridas.

suggestedActions

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

Retorna uma mensagem que inclui um conjunto de ações sugeridas e 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 - O texto das ações a serem criadas.
text - Opcional. O texto da mensagem a ser enviada.
ssml - Opcional, o texto a ser falado pelo bot em um canal de habilitação de fala.
inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. O padrão é ACCEPTING_INPUT.

Retornos:

Uma atividade de mensagem que contém as ações sugeridas.

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

Retorna uma mensagem que inclui um conjunto de ações sugeridas e texto opcional.

Parâmetros:

actions - As ações de cartão a serem incluídas.
text - Opcional, o texto da mensagem a ser enviada.

Retornos:

Uma atividade de mensagem que contém as ações sugeridas.

suggestedCardActions

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

Retorna uma mensagem que inclui um conjunto de ações sugeridas e texto opcional.

Parâmetros:

actions - As ações de cartão a serem incluídas.
text - Opcional, o texto da mensagem a ser enviada.
ssml - Opcional, o texto a ser falado pelo bot em um canal de habilitação de fala.
inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. O padrão é ACCEPTING_INPUT.

Retornos:

Uma atividade de mensagem que contém as ações sugeridas.

text

public static Activity text(String text)

Retorna uma mensagem de texto simples.

Parâmetros:

text - O texto da mensagem a ser enviada.

Retornos:

Uma atividade de mensagem que contém o texto.

text

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

Retorna uma mensagem de texto simples.

Parâmetros:

text - O texto da mensagem a ser enviada.
ssml - Opcional, o texto a ser falado pelo bot em um canal habilitado para fala.
inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. O padrão é ACCEPTING_INPUT.

Retornos:

Uma atividade de mensagem que contém o texto.

Aplica-se a