Message class

Pacote:

botbuilder

Classe do construtor de mensagens que simplifica a criação de mensagens complexas com anexos.

Construtores

Message(Session)

Cria um novo Construtor de Mensagens.

Métodos

addAttachment(AttachmentType)	Adiciona um anexo à mensagem. Consulte IAttachment para obter exemplos.
addEntity(Object)	Adiciona uma entidade à mensagem.
address(IAddress)	Endereçar informações de roteamento para a mensagem. Salve esse campo no armazenamento externo em algum lugar para redigir posteriormente uma mensagem proativa para o usuário.
attachmentLayout(string)	Dica de como os clientes devem layout de vários anexos. O valor padrão é 'list'.
attachments(AttachmentType[])	Cartões ou imagens a serem enviados ao usuário.
code(string)	Código que indica por que a conversa terminou.
compose(string[][], any[])	Compõe uma resposta complexa e aleatória ao usuário.
composePrompt(Session, string[][], any[])	preterido usar compose().
composePrompt(Session, string[][], any[])	Combina uma matriz de prompts em um único prompt localizado e, opcionalmente, preenche os slots de modelo de prompts com os argumentos passados.
entities(Object[])	Objetos estruturados passados para o bot ou usuário.
inputHint(string)	Dica para clientes informando se o bot está esperando mais entradas ou não. Os prompts internos preencherão automaticamente esse valor para mensagens de saída.
localTimestamp(string)	Hora local em que a mensagem foi enviada (definida por cliente ou bot, ex: 2016-09-23T13:07:49.4714686-07:00.)
name(string)	Nome da operação a ser invocada ou o nome do evento.
nspeak(TextType, TextType, number)	Defina condicionalmente o campo de fala da mensagem dada uma contagem especificada.
ntext(TextType, TextType, number)	Defina condicionalmente o texto da mensagem dada uma contagem especificada.
originalEvent(any)	Mensagem no formato original/nativo do canal para mensagens de entrada.
randomPrompt(TextType)	Seleciona um prompt aleatoriamente.
relatesTo(IAddress)	Referência a outra conversa ou mensagem.
setChannelData(any)	preterido usar sourceEvent().
setLanguage(string)	preteridos usam local().
setNText(Session, string, string, number)	preterido usar ntext().
setText(Session, TextType, any[])	preteridos usam texto().
sourceEvent(ISourceEventMap)	Para mensagens de saída podem ser usadas para passar dados de evento específicos da origem, como anexos personalizados.
speak(TextType, any[])	Define o campo de fala da mensagem como SSML (Speech Synthesis Markup Language). Isso será falado com o usuário em dispositivos com suporte.
suggestedActions(ISuggestedActions | IIsSuggestedActions)	Ações sugeridas opcionais para enviar ao usuário. As ações sugeridas serão exibidas somente nos canais que dão suporte a ações sugeridas.
summary(TextType, any[])	Texto a ser exibido como fall-back e como descrição curta do conteúdo da mensagem, por exemplo, lista de conversas recentes.
text(TextType, any[])	Define o texto da mensagem.
textFormat(string)	Formato de campos de texto.
textLocale(string)	Idioma da mensagem.
timestamp(string)	Definido pelo serviço de conectores. Use localTimestamp().
toMessage()	Retorna o JSON para a mensagem.
value(any)	Valor aberto.

Detalhes do construtor

Message(Session)

Cria um novo Construtor de Mensagens.

new Message(session?: Session)

Parâmetros

session

Session

(Opcional) será usado para preencher o endereço de mensagens e localizar qualquer texto.

Detalhes do método

addAttachment(AttachmentType)

Adiciona um anexo à mensagem. Consulte IAttachment para obter exemplos.

function addAttachment(attachment: AttachmentType)

Parâmetros

attachment

AttachmentType

O anexo a ser adicionado.

Retornos

Message

addEntity(Object)

Adiciona uma entidade à mensagem.

function addEntity(obj: Object)

Parâmetros

obj

Object

Retornos

Message

address(IAddress)

Endereçar informações de roteamento para a mensagem. Salve esse campo no armazenamento externo em algum lugar para redigir posteriormente uma mensagem proativa para o usuário.

function address(adr: IAddress)

Parâmetros

adr

IAddress

Retornos

Message

attachmentLayout(string)

Dica de como os clientes devem layout de vários anexos. O valor padrão é 'list'.

function attachmentLayout(style: string)

Parâmetros

style

string

Retornos

Message

attachments(AttachmentType[])

Cartões ou imagens a serem enviados ao usuário.

function attachments(list: AttachmentType[])

Parâmetros

list

AttachmentType[]

Retornos

Message

code(string)

Código que indica por que a conversa terminou.

function code(value: string)

Parâmetros

value

string

Retornos

Message

compose(string[][], any[])

Compõe uma resposta complexa e aleatória ao usuário.

function compose(prompts: string[][], args: any[])

Parâmetros

prompts

string[][]

args

any[]

Retornos

Message

composePrompt(Session, string[][], any[])

preterido usar compose().

function composePrompt(session: Session, prompts: string[][], args: any[])

Parâmetros

session

Session

prompts

string[][]

args

any[]

Retornos

Message

composePrompt(Session, string[][], any[])

Combina uma matriz de prompts em um único prompt localizado e, opcionalmente, preenche os slots de modelo de prompts com os argumentos passados.

static function composePrompt(session: Session, prompts: string[][], args?: any[])

Parâmetros

session

Session

Objeto de sessão usado para localizar as partes de prompt individuais.

prompts

string[][]

Matriz de listas de prompts. Cada entrada na matriz é outra matriz de prompts que será escolhida aleatoriamente. O texto de saída combinado será delimitado por espaço.

args

any[]

(Opcional) matriz de argumentos usados para formatar o texto de saída quando o prompt é um modelo.

Retornos

string

entities(Object[])

Objetos estruturados passados para o bot ou usuário.

function entities(list: Object[])

Parâmetros

list

Object[]

Retornos

Message

inputHint(string)

Dica para clientes informando se o bot está esperando mais entradas ou não. Os prompts internos preencherão automaticamente esse valor para mensagens de saída.

function inputHint(hint: string)

Parâmetros

hint

string

Retornos

Message

localTimestamp(string)

Hora local em que a mensagem foi enviada (definida por cliente ou bot, ex: 2016-09-23T13:07:49.4714686-07:00.)

function localTimestamp(time?: string)

Parâmetros

time

string

(Opcional) tempo expresso como uma cadeia de caracteres ISO. O padrão é new Date().toISOString().

Retornos

Message

name(string)

Nome da operação a ser invocada ou o nome do evento.

function name(name: string)

Parâmetros

name

string

Retornos

Message

nspeak(TextType, TextType, number)

Defina condicionalmente o campo de fala da mensagem dada uma contagem especificada.

function nspeak(ssml: TextType, ssml_plural: TextType, count: number)

Parâmetros

ssml

TextType

ssml_plural

TextType

count

number

Retornos

Message

ntext(TextType, TextType, number)

Defina condicionalmente o texto da mensagem dada uma contagem especificada.

function ntext(msg: TextType, msg_plural: TextType, count: number)

Parâmetros

msg

TextType

msg_plural

TextType

count

number

Retornos

Message

originalEvent(any)

Mensagem no formato original/nativo do canal para mensagens de entrada.

function originalEvent(event: any)

Parâmetros

event

any

Retornos

Message

randomPrompt(TextType)

Seleciona um prompt aleatoriamente.

static function randomPrompt(prompts: TextType)

Parâmetros

prompts

TextType

Matriz de prompts para escolher. Quando os prompts são do tipo cadeia de caracteres o prompt simplesmente será retornado sem modificação.

Retornos

string

relatesTo(IAddress)

Referência a outra conversa ou mensagem.

function relatesTo(adr: IAddress)

Parâmetros

adr

IAddress

Retornos

Message

setChannelData(any)

preterido usar sourceEvent().

function setChannelData(data: any)

Parâmetros

data

any

Retornos

Message

setLanguage(string)

preteridos usam local().

function setLanguage(language: string)

Parâmetros

language

string

Retornos

Message

setNText(Session, string, string, number)

preterido usar ntext().

function setNText(session: Session, msg: string, msg_plural: string, count: number)

Parâmetros

session

Session

msg

string

msg_plural

string

count

number

Retornos

Message

setText(Session, TextType, any[])

preteridos usam texto().

function setText(session: Session, prompt: TextType, args: any[])

Parâmetros

session

Session

prompt

TextType

args

any[]

Retornos

Message

sourceEvent(ISourceEventMap)

Para mensagens de saída podem ser usadas para passar dados de evento específicos da origem, como anexos personalizados.

function sourceEvent(map: ISourceEventMap)

Parâmetros

map

ISourceEventMap

Retornos

Message

speak(TextType, any[])

Define o campo de fala da mensagem como SSML (Speech Synthesis Markup Language). Isso será falado com o usuário em dispositivos com suporte.

function speak(ssml: TextType, args: any[])

Parâmetros

ssml

TextType

args

any[]

Retornos

Message

suggestedActions(ISuggestedActions | IIsSuggestedActions)

Ações sugeridas opcionais para enviar ao usuário. As ações sugeridas serão exibidas somente nos canais que dão suporte a ações sugeridas.

function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)

Parâmetros

suggestedActions

ISuggestedActions | IIsSuggestedActions

Retornos

Message

summary(TextType, any[])

Texto a ser exibido como fall-back e como descrição curta do conteúdo da mensagem, por exemplo, lista de conversas recentes.

function summary(text: TextType, args: any[])

Parâmetros

text

TextType

args

any[]

Retornos

Message

text(TextType, any[])

Define o texto da mensagem.

function text(text: TextType, args: any[])

Parâmetros

text

TextType

args

any[]

Retornos

Message

textFormat(string)

Formato de campos de texto.

function textFormat(style: string)

Parâmetros

style

string

Retornos

Message

textLocale(string)

Idioma da mensagem.

function textLocale(locale: string)

Parâmetros

locale

string

Retornos

Message

timestamp(string)

Definido pelo serviço de conectores. Use localTimestamp().

function timestamp(time?: string)

Parâmetros

time

string

Retornos

Message

toMessage()

Retorna o JSON para a mensagem.

function toMessage()

Retornos

IMessage

value(any)

Valor aberto.

function value(param: any)

Parâmetros

param

any

Retornos

Message