IMessage interface

Paquete:

botbuilder

Mensaje de chat enviado entre un usuario y un bot. Los mensajes del bot al usuario vienen en dos tipos:

• mensajes reactivos son mensajes enviados desde el bot al usuario como respuesta a un mensaje entrante del usuario.
• mensajes proactivos son mensajes enviados desde el bot al usuario en respuesta a algún evento externo, como un desencadenador de alarma.

En el caso reactivo, debe copiar el campo de dirección del mensaje entrante al mensaje saliente (si usa la clase generador message e inicializarla con la sesión de esto se producirá automáticamente) y, a continuación, establezca el texto o datos adjuntos. Para los mensajes proactivos, necesitará guardar la dirección desde el mensaje entrante a un almacenamiento externo en algún lugar. Después, puede pasarlo a UniversalBot.beginDialog() o copiarlo en un mensaje saliente pasado a UniversalBot.send().

La redacción de un mensaje al usuario mediante el objeto de dirección entrante enviará de forma predeterminada una respuesta al usuario en el contexto de la conversación actual. Algunos canales permiten el inicio de nuevas conversaciones con el usuario. Para iniciar una nueva conversación proactiva con el usuario, simplemente elimine el campo de conversación del objeto de dirección antes de redactar el mensaje saliente.

Extends

IEvent

Propiedades

address	Direccione la información de enrutamiento del evento. Guarde este campo en el almacenamiento externo en algún lugar para redactar posteriormente un mensaje proactivo al usuario.
agent	SDK que procesa el evento. Siempre será "botbuilder".
attachmentLayout	Sugerencia sobre cómo los clientes deben diseñar varios datos adjuntos. El valor predeterminado es "list".
attachments	Para los mensajes entrantes contiene datos adjuntos, como imágenes enviadas desde el usuario. En el caso de los mensajes salientes, contiene objetos como tarjetas o imágenes que se van a enviar al usuario.
code	Código que indica por qué finalizó la conversación.
deliveryMode	Sugerencia de entrega para indicar a los destinatarios rutas de entrega alternativas para la actividad. El modo de entrega predeterminado es "predeterminado".
entities	Objetos estructurados pasados al bot o al usuario.
expriation	La hora en la que se debe considerar que la actividad debe ser "expirada" y no debe presentarse al destinatario.
importance	Importancia de la actividad.
inputHint	Sugerencia para los clientes que les permiten saber si el bot espera una entrada adicional o no. Las solicitudes integradas rellenarán automáticamente este valor para los mensajes salientes.
label	Etiqueta descriptiva para la actividad.
listenFor	Lista de frases y referencias que los sistemas de preparación de voz e idioma deben escuchar.
localTimestamp	Hora local en la que se envió el mensaje (establecido por cliente o bot, por ejemplo: 2016-09-23T13:07:49.4714686-07:00).)
localTimezone	Contiene el nombre de la zona horaria en la que el mensaje, en hora local, expresado en formato de base de datos de zona horaria de IANA. Por ejemplo, Estados Unidos/Los_Angeles.
name	Nombre de la operación que se va a invocar o el nombre del evento.
relatesTo	Referencia a otra conversación o mensaje.
replyToId	El identificador del evento al que está relacionada esta actualización.
semanticAction	Una acción de programación opcional que acompaña a esta solicitud.
source	Origen original del evento (es decir, "facebook", "skype", "slack", etc.)
sourceEvent	Evento original en el esquema nativo de orígenes. Para los mensajes salientes se puede usar para pasar datos de eventos específicos de origen, como datos adjuntos personalizados.
speak	Mensaje hablado como lenguaje de marcado de síntesis de voz.
summary	Texto que se va a mostrar como retroceso y como breve descripción del contenido del mensaje, por ejemplo, lista de conversaciones recientes.
text	Texto del mensaje.
textFormat	Formato de los campos de texto. El valor predeterminado es "Markdown".
textHighlights	Colección de fragmentos de texto que se resaltarán cuando la actividad contiene un valor ReplyToId.
textLocale	Idioma identificado del texto del mensaje si se conoce.
timestamp	Hora UTC en la que se envió el mensaje (establecido por servicio).
type	Define el tipo de evento. Debe ser "message" para un IMessage.
user	Para los mensajes entrantes, este es el usuario que envió el mensaje. De forma predeterminada, se trata de una copia de address.user, pero puede configurar el bot con una función lookupUser que permite asignar el usuario entrante a un identificador de usuario interno.
value	Valor de finalización abierta.
valueType	Tipo del objeto de valor de la actividad.

Detalles de las propiedades

address

Direccione la información de enrutamiento del evento. Guarde este campo en el almacenamiento externo en algún lugar para redactar posteriormente un mensaje proactivo al usuario.

address: IAddress

Valor de propiedad

IAddress

agent

SDK que procesa el evento. Siempre será "botbuilder".

agent: string

Valor de propiedad

string

attachmentLayout

Sugerencia sobre cómo los clientes deben diseñar varios datos adjuntos. El valor predeterminado es "list".

attachmentLayout?: string

Valor de propiedad

string

attachments

Para los mensajes entrantes contiene datos adjuntos, como imágenes enviadas desde el usuario. En el caso de los mensajes salientes, contiene objetos como tarjetas o imágenes que se van a enviar al usuario.

attachments?: IAttachment[]

Valor de propiedad

IAttachment[]

code

Código que indica por qué finalizó la conversación.

code?: string

Valor de propiedad

string

deliveryMode

Sugerencia de entrega para indicar a los destinatarios rutas de entrega alternativas para la actividad. El modo de entrega predeterminado es "predeterminado".

deliveryMode?: string

Valor de propiedad

string

entities

Objetos estructurados pasados al bot o al usuario.

entities?: any[]

Valor de propiedad

any[]

expriation

La hora en la que se debe considerar que la actividad debe ser "expirada" y no debe presentarse al destinatario.

expriation?: string

Valor de propiedad

string

importance

Importancia de la actividad.

importance?: string

Valor de propiedad

string

inputHint

Sugerencia para los clientes que les permiten saber si el bot espera una entrada adicional o no. Las solicitudes integradas rellenarán automáticamente este valor para los mensajes salientes.

inputHint?: string

Valor de propiedad

string

label

Etiqueta descriptiva para la actividad.

label?: string

Valor de propiedad

string

listenFor

Lista de frases y referencias que los sistemas de preparación de voz e idioma deben escuchar.

listenFor?: string[]

Valor de propiedad

string[]

localTimestamp

Hora local en la que se envió el mensaje (establecido por cliente o bot, por ejemplo: 2016-09-23T13:07:49.4714686-07:00).)

localTimestamp?: string

Valor de propiedad

string

localTimezone

Contiene el nombre de la zona horaria en la que el mensaje, en hora local, expresado en formato de base de datos de zona horaria de IANA. Por ejemplo, Estados Unidos/Los_Angeles.

localTimezone?: string

Valor de propiedad

string

name

Nombre de la operación que se va a invocar o el nombre del evento.

name?: string

Valor de propiedad

string

relatesTo

Referencia a otra conversación o mensaje.

relatesTo?: IAddress

Valor de propiedad

IAddress

replyToId

El identificador del evento al que está relacionada esta actualización.

replyToId?: string

Valor de propiedad

string

semanticAction

Una acción de programación opcional que acompaña a esta solicitud.

semanticAction?: ISemanticAction

Valor de propiedad

ISemanticAction

source

Origen original del evento (es decir, "facebook", "skype", "slack", etc.)

source: string

Valor de propiedad

string

sourceEvent

Evento original en el esquema nativo de orígenes. Para los mensajes salientes se puede usar para pasar datos de eventos específicos de origen, como datos adjuntos personalizados.

sourceEvent: any

Valor de propiedad

any

speak

Mensaje hablado como lenguaje de marcado de síntesis de voz.

speak?: string

Valor de propiedad

string

summary

Texto que se va a mostrar como retroceso y como breve descripción del contenido del mensaje, por ejemplo, lista de conversaciones recientes.

summary?: string

Valor de propiedad

string

text

Texto del mensaje.

text?: string

Valor de propiedad

string

textFormat

Formato de los campos de texto. El valor predeterminado es "Markdown".

textFormat?: string

Valor de propiedad

string

textHighlights

Colección de fragmentos de texto que se resaltarán cuando la actividad contiene un valor ReplyToId.

textHighlights?: ITextHighlight[]

Valor de propiedad

ITextHighlight[]

textLocale

Idioma identificado del texto del mensaje si se conoce.

textLocale?: string

Valor de propiedad

string

timestamp

Hora UTC en la que se envió el mensaje (establecido por servicio).

timestamp?: string

Valor de propiedad

string

type

Define el tipo de evento. Debe ser "message" para un IMessage.

type: string

Valor de propiedad

string

user

Para los mensajes entrantes, este es el usuario que envió el mensaje. De forma predeterminada, se trata de una copia de address.user, pero puede configurar el bot con una función lookupUser que permite asignar el usuario entrante a un identificador de usuario interno.

user: IIdentity

Valor de propiedad

IIdentity

value

Valor de finalización abierta.

value?: any

Valor de propiedad

any

valueType

Tipo del objeto de valor de la actividad.

valueType?: string

Valor de propiedad

string