IMessage interface

Pacote:

botbuilder

Uma mensagem de chat enviada entre um usuário e um bot. As mensagens do bot para o usuário vêm em dois tipos:

• mensagens reativas são mensagens enviadas do Bot para o Usuário como uma resposta a uma mensagem de entrada do usuário.
• mensagens proativas são mensagens enviadas do Bot para o Usuário em resposta a algum evento externo, como um gatilho de alarme.

No caso reativo, você deve copiar o endereço campo da mensagem de entrada para a mensagem de saída (se você usar a classe Message builder e inicializá-la com a sessão isso ocorrerá automaticamente) e, em seguida, definir a de texto ou anexos. Para mensagens proativas, você precisará salvar o endereço da mensagem de entrada para um armazenamento externo em algum lugar. Posteriormente, você pode passá-lo para UniversalBot.beginDialog() ou copiá-lo para uma mensagem de saída passada para UniversalBot.send().

A composição de uma mensagem para o usuário usando o objeto de endereço de entrada, por padrão, enviará uma resposta ao usuário no contexto da conversa atual. Alguns canais permitem o início de novas conversas com o usuário. Para iniciar uma nova conversa proativa com o usuário, basta excluir a conversa campo do objeto de endereço antes de redigir a mensagem de saída.

Extends

IEvent

Propriedades

address	Endereçar informações de roteamento para o evento. Salve esse campo no armazenamento externo em algum lugar para redigir posteriormente uma mensagem proativa para o usuário.
agent	SDK que está processando o evento. Sempre será "botbuilder".
attachmentLayout	Dica de como os clientes devem layout de vários anexos. O valor padrão é 'list'.
attachments	Para mensagens de entrada, há anexos como imagens enviadas do usuário. Para mensagens de saída contém objetos como cartões ou imagens a serem enviados ao usuário.
code	Código que indica por que a conversa terminou.
deliveryMode	Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade. O modo de entrega padrão é "padrão".
entities	Objetos estruturados passados para o bot ou usuário.
expriation	O momento em que a atividade deve ser considerada "expirada" e não deve ser apresentada ao destinatário.
importance	A importância da atividade.
inputHint	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.
label	Um rótulo descritivo para a atividade.
listenFor	Lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar.
localTimestamp	Hora local em que a mensagem foi enviada (definida por cliente ou bot, ex: 2016-09-23T13:07:49.4714686-07:00.)
localTimezone	Contém o nome do fuso horário no qual a mensagem, no horário local, expressa no formato de banco de dados de Fuso Horário IANA. Por exemplo, América/Los_Angeles.
name	Nome da operação a ser invocada ou o nome do evento.
relatesTo	Referência a outra conversa ou mensagem.
replyToId	A ID do evento ao qual esta atualização está relacionada.
semanticAction	Uma ação programática opcional que acompanha essa solicitação.
source	A origem original do evento (ou seja, 'facebook', 'skype', 'slack', etc.)
sourceEvent	O evento original no esquema nativo de fontes. Para mensagens de saída podem ser usadas para passar dados de evento específicos da origem, como anexos personalizados.
speak	Mensagem falada como de linguagem de marcação de síntese de fala.
summary	Texto a ser exibido como fall-back e como descrição curta do conteúdo da mensagem, por exemplo, lista de conversas recentes.
text	Texto da mensagem.
textFormat	Formato de campos de texto. O valor padrão é 'markdown'.
textHighlights	A coleção de fragmentos de texto a ser realçada quando a atividade contém um valor ReplyToId.
textLocale	Idioma identificado do texto da mensagem, se conhecido.
timestamp	Hora UTC em que a mensagem foi enviada (definida pelo serviço).)
type	Define o tipo de evento. Deve ser "mensagem" para um IMessage.
user	Para mensagens de entrada, este é o usuário que enviou a mensagem. Por padrão, essa é uma cópia de address.user mas você pode configurar seu bot com uma função lookupUser que permite mapear o usuário de entrada para uma ID de usuário interna.
value	Valor aberto.
valueType	O tipo do objeto de valor da atividade.

Detalhes da propriedade

address

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

address: IAddress

Valor da propriedade

IAddress

agent

SDK que está processando o evento. Sempre será "botbuilder".

agent: string

Valor da propriedade

string

attachmentLayout

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

attachmentLayout?: string

Valor da propriedade

string

attachments

Para mensagens de entrada, há anexos como imagens enviadas do usuário. Para mensagens de saída contém objetos como cartões ou imagens a serem enviados ao usuário.

attachments?: IAttachment[]

Valor da propriedade

IAttachment[]

code

Código que indica por que a conversa terminou.

code?: string

Valor da propriedade

string

deliveryMode

Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade. O modo de entrega padrão é "padrão".

deliveryMode?: string

Valor da propriedade

string

entities

Objetos estruturados passados para o bot ou usuário.

entities?: any[]

Valor da propriedade

any[]

expriation

O momento em que a atividade deve ser considerada "expirada" e não deve ser apresentada ao destinatário.

expriation?: string

Valor da propriedade

string

importance

A importância da atividade.

importance?: string

Valor da propriedade

string

inputHint

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.

inputHint?: string

Valor da propriedade

string

label

Um rótulo descritivo para a atividade.

label?: string

Valor da propriedade

string

listenFor

Lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar.

listenFor?: string[]

Valor da propriedade

string[]

localTimestamp

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

localTimestamp?: string

Valor da propriedade

string

localTimezone

Contém o nome do fuso horário no qual a mensagem, no horário local, expressa no formato de banco de dados de Fuso Horário IANA. Por exemplo, América/Los_Angeles.

localTimezone?: string

Valor da propriedade

string

name

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

name?: string

Valor da propriedade

string

relatesTo

Referência a outra conversa ou mensagem.

relatesTo?: IAddress

Valor da propriedade

IAddress

replyToId

A ID do evento ao qual esta atualização está relacionada.

replyToId?: string

Valor da propriedade

string

semanticAction

Uma ação programática opcional que acompanha essa solicitação.

semanticAction?: ISemanticAction

Valor da propriedade

ISemanticAction

source

A origem original do evento (ou seja, 'facebook', 'skype', 'slack', etc.)

source: string

Valor da propriedade

string

sourceEvent

O evento original no esquema nativo de fontes. Para mensagens de saída podem ser usadas para passar dados de evento específicos da origem, como anexos personalizados.

sourceEvent: any

Valor da propriedade

any

speak

Mensagem falada como de linguagem de marcação de síntese de fala.

speak?: string

Valor da propriedade

string

summary

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

summary?: string

Valor da propriedade

string

text

Texto da mensagem.

text?: string

Valor da propriedade

string

textFormat

Formato de campos de texto. O valor padrão é 'markdown'.

textFormat?: string

Valor da propriedade

string

textHighlights

A coleção de fragmentos de texto a ser realçada quando a atividade contém um valor ReplyToId.

textHighlights?: ITextHighlight[]

Valor da propriedade

ITextHighlight[]

textLocale

Idioma identificado do texto da mensagem, se conhecido.

textLocale?: string

Valor da propriedade

string

timestamp

Hora UTC em que a mensagem foi enviada (definida pelo serviço).)

timestamp?: string

Valor da propriedade

string

type

Define o tipo de evento. Deve ser "mensagem" para um IMessage.

type: string

Valor da propriedade

string

user

Para mensagens de entrada, este é o usuário que enviou a mensagem. Por padrão, essa é uma cópia de address.user mas você pode configurar seu bot com uma função lookupUser que permite mapear o usuário de entrada para uma ID de usuário interna.

user: IIdentity

Valor da propriedade

IIdentity

value

Valor aberto.

value?: any

Valor da propriedade

any

valueType

O tipo do objeto de valor da atividade.

valueType?: string

Valor da propriedade

string