MessageFactory class

Pacote:

botbuilder-core

Um conjunto de funções de utilitário para ajudar na formatação dos vários tipos de mensagem que um bot pode retornar.

Comentários

O exemplo a seguir mostra o envio de uma mensagem contendo um único cartão hero:

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

attachment(Attachment, string, string, InputHints | string)	Retorna uma única atividade de mensagem que contém um anexo.
carousel(Attachment[], string, string, InputHints | string)	Retorna uma mensagem que exibirá um conjunto de anexos usando um layout de carrossel.
contentUrl(string, string, string, string, string, InputHints | string)	Retorna uma mensagem que exibirá uma única imagem ou vídeo para um usuário.
list(Attachment[], string, string, InputHints | string)	Retorna uma mensagem que exibirá um conjunto de anexos no formulário de lista.
suggestedActions(string | CardAction[], string, string, InputHints | string)	Retorna uma mensagem que inclui um conjunto de ações sugeridas e texto opcional.
text(string, string, InputHints | string)	Retorna uma mensagem de texto simples.

Detalhes do método

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

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

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

Parâmetros

attachment

Attachment

Cartão adaptável a ser incluído na mensagem.

text

string

(Opcional) texto da mensagem.

speak

string

(Opcional) SSML a ser incluído com a mensagem.

inputHint

InputHints | string

Dica de entrada (opcional) para a mensagem. O padrão é acceptingInput.

Retornos

Partial<Activity>

Uma atividade de mensagem que contém o anexo.

Comentários

Este exemplo mostra a criação de uma mensagem com um anexo de cartão hero:

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

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

Retorna uma mensagem que exibirá um conjunto de anexos usando um layout de carrossel.

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

Parâmetros

attachments

Attachment[]

Matriz de anexos a serem incluídos na mensagem.

text

string

(Opcional) texto da mensagem.

speak

string

(Opcional) SSML a ser incluído com a mensagem.

inputHint

InputHints | string

Dica de entrada (opcional) para a mensagem.

Retornos

Partial<Activity>

Uma atividade de mensagem que exibirá um conjunto de anexos usando um layout de carrossel.

Comentários

Este exemplo mostra a criação de uma mensagem com um carrossel de cartões hero:

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)

Retorna uma mensagem que exibirá uma única imagem ou vídeo para um usuário.

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

Parâmetros

url

string

Url da imagem/vídeo a ser enviado.

contentType

string

O tipo MIME da imagem/vídeo.

name

string

(Opcional) Nome do arquivo de imagem/vídeo.

text

string

(Opcional) texto da mensagem.

speak

string

(Opcional) SSML a ser incluído com a mensagem.

inputHint

InputHints | string

Dica de entrada (opcional) para a mensagem.

Retornos

Partial<Activity>

Uma atividade de mensagem que exibirá uma única imagem ou vídeo para um usuário.

Comentários

Este exemplo mostra o envio de uma imagem para o usuário:

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)

Retorna uma mensagem que exibirá um conjunto de anexos no formulário de lista.

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

Parâmetros

attachments

Attachment[]

Matriz de anexos a serem incluídos na mensagem.

text

string

(Opcional) texto da mensagem.

speak

string

(Opcional) SSML a ser incluído com a mensagem.

inputHint

InputHints | string

Dica de entrada (opcional) para a mensagem.

Retornos

Partial<Activity>

Uma atividade de mensagem que exibirá um conjunto de anexos no formulário de lista.

Comentários

Este exemplo mostra como criar uma mensagem com uma lista de cartões hero:

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)

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

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

Parâmetros

actions

string | CardAction[]

Matriz de ações de cartão ou cadeias de caracteres a serem incluídas. As cadeias de caracteres serão convertidas em ações de messageBack.

text

string

(Opcional) texto da mensagem.

speak

string

(Opcional) SSML a ser incluído com a mensagem.

inputHint

InputHints | string

Dica de entrada (opcional) para a mensagem. O padrão é acceptingInput.

Retornos

Partial<Activity>

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

Comentários

Este exemplo mostra a criação de uma mensagem com ações sugeridas:

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

text(string, string, InputHints | string)

Retorna uma mensagem de texto simples.

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

Parâmetros

text

string

Texto a ser incluído na mensagem.

speak

string

(Opcional) SSML a ser incluído na mensagem.

inputHint

InputHints | string

Dica de entrada (opcional) para a mensagem. O padrão é acceptingInput.

Retornos

Partial<Activity>

Uma atividade de mensagem que contém o texto.

Comentários

Este exemplo mostra o envio de uma mensagem de texto simples:

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