Message class

Paquete:

botbuilder

Clase generador de mensajes que simplifica la creación de mensajes complejos con datos adjuntos.

Constructores

Message(Session)

Crea un nuevo generador de mensajes.

Métodos

addAttachment(AttachmentType)	Agrega datos adjuntos al mensaje. Consulte de IAttachment para obtener ejemplos.
addEntity(Object)	Agrega una entidad al mensaje.
address(IAddress)	Dirección de la información de enrutamiento del mensaje. Guarde este campo en el almacenamiento externo en algún lugar para redactar posteriormente un mensaje proactivo al usuario.
attachmentLayout(string)	Sugerencia sobre cómo los clientes deben diseñar varios datos adjuntos. El valor predeterminado es "list".
attachments(AttachmentType[])	Tarjetas o imágenes que se van a enviar al usuario.
code(string)	Código que indica por qué finalizó la conversación.
compose(string[][], any[])	Compone una respuesta compleja y aleatoria al usuario.
composePrompt(Session, string[][], any[])	en desuso, use compose() .
composePrompt(Session, string[][], any[])	Combina una matriz de mensajes en un único aviso localizado y, opcionalmente, rellena las ranuras de plantilla de avisos con los argumentos pasados.
entities(Object[])	Objetos estructurados pasados al bot o al usuario.
inputHint(string)	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.
localTimestamp(string)	Hora local en la que se envió el mensaje (establecido por cliente o bot, por ejemplo: 2016-09-23T13:07:49.4714686-07:00).)
name(string)	Nombre de la operación que se va a invocar o el nombre del evento.
nspeak(TextType, TextType, number)	Establezca condicionalmente el campo de habla del mensaje según un recuento especificado.
ntext(TextType, TextType, number)	Establezca condicionalmente el texto del mensaje según un recuento especificado.
originalEvent(any)	Mensaje en formato original o nativo del canal para los mensajes entrantes.
randomPrompt(TextType)	Selecciona un mensaje al azar.
relatesTo(IAddress)	Referencia a otra conversación o mensaje.
setChannelData(any)	EN DESUSO, use sourceEvent() en su lugar.
setLanguage(string)	en desuso, use local() en su lugar.
setNText(Session, string, string, number)	en desuso, use ntext() .
setText(Session, TextType, any[])	en desuso, use text() de .
sourceEvent(ISourceEventMap)	Para los mensajes salientes se puede usar para pasar datos de eventos específicos de origen, como datos adjuntos personalizados.
speak(TextType, any[])	Establece el campo de habla del mensaje como lenguaje de marcado de síntesis de voz (SSML). Esto se hablará al usuario en dispositivos compatibles.
suggestedActions(ISuggestedActions | IIsSuggestedActions)	Acciones sugeridas opcionales para enviar al usuario. Las acciones sugeridas solo se mostrarán en los canales que admiten acciones sugeridas.
summary(TextType, any[])	Texto que se va a mostrar como retroceso y como breve descripción del contenido del mensaje, por ejemplo, lista de conversaciones recientes.
text(TextType, any[])	Establece el texto del mensaje.
textFormat(string)	Formato de los campos de texto.
textLocale(string)	Idioma del mensaje.
timestamp(string)	Establezca por servicio de conectores. Use localTimestamp().
toMessage()	Devuelve el json del mensaje.
value(any)	Valor de finalización abierta.

Detalles del constructor

Message(Session)

Crea un nuevo generador de mensajes.

new Message(session?: Session)

Parámetros

session

Session

(Opcional) se usará para rellenar la dirección de los mensajes y localizar cualquier texto.

Detalles del método

addAttachment(AttachmentType)

Agrega datos adjuntos al mensaje. Consulte de IAttachment para obtener ejemplos.

function addAttachment(attachment: AttachmentType)

Parámetros

attachment

AttachmentType

Datos adjuntos que se van a agregar.

Devoluciones

Message

addEntity(Object)

Agrega una entidad al mensaje.

function addEntity(obj: Object)

Parámetros

obj

Object

Devoluciones

Message

address(IAddress)

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

function address(adr: IAddress)

Parámetros

adr

IAddress

Devoluciones

Message

attachmentLayout(string)

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

function attachmentLayout(style: string)

Parámetros

style

string

Devoluciones

Message

attachments(AttachmentType[])

Tarjetas o imágenes que se van a enviar al usuario.

function attachments(list: AttachmentType[])

Parámetros

list

AttachmentType[]

Devoluciones

Message

code(string)

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

function code(value: string)

Parámetros

value

string

Devoluciones

Message

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

Compone una respuesta compleja y aleatoria al usuario.

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

Parámetros

prompts

string[][]

args

any[]

Devoluciones

Message

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

en desuso, use compose() .

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

Parámetros

session

Session

prompts

string[][]

args

any[]

Devoluciones

Message

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

Combina una matriz de mensajes en un único aviso localizado y, opcionalmente, rellena las ranuras de plantilla de avisos con los argumentos pasados.

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

Parámetros

session

Session

Objeto de sesión usado para localizar los elementos de solicitud individuales.

prompts

string[][]

Matriz de listas de mensajes. Cada entrada de la matriz es otra matriz de avisos que se elegirán aleatoriamente. El texto de salida combinado estará delimitado por el espacio.

args

any[]

(Opcional) matriz de argumentos usados para dar formato al texto de salida cuando el mensaje es una plantilla.

Devoluciones

string

entities(Object[])

Objetos estructurados pasados al bot o al usuario.

function entities(list: Object[])

Parámetros

list

Object[]

Devoluciones

Message

inputHint(string)

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.

function inputHint(hint: string)

Parámetros

hint

string

Devoluciones

Message

localTimestamp(string)

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

function localTimestamp(time?: string)

Parámetros

time

string

(Opcional) tiempo expresado como una cadena ISO. El valor predeterminado es new Date().toISOString().

Devoluciones

Message

name(string)

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

function name(name: string)

Parámetros

name

string

Devoluciones

Message

nspeak(TextType, TextType, number)

Establezca condicionalmente el campo de habla del mensaje según un recuento especificado.

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

Parámetros

ssml

TextType

ssml_plural

TextType

count

number

Devoluciones

Message

ntext(TextType, TextType, number)

Establezca condicionalmente el texto del mensaje según un recuento especificado.

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

Parámetros

msg

TextType

msg_plural

TextType

count

number

Devoluciones

Message

originalEvent(any)

Mensaje en formato original o nativo del canal para los mensajes entrantes.

function originalEvent(event: any)

Parámetros

event

any

Devoluciones

Message

randomPrompt(TextType)

Selecciona un mensaje al azar.

static function randomPrompt(prompts: TextType)

Parámetros

prompts

TextType

Matriz de avisos entre los que elegir. Cuando las solicitudes son de tipo cadena el mensaje simplemente se devolverá sin modificar.

Devoluciones

string

relatesTo(IAddress)

Referencia a otra conversación o mensaje.

function relatesTo(adr: IAddress)

Parámetros

adr

IAddress

Devoluciones

Message

setChannelData(any)

EN DESUSO, use sourceEvent() en su lugar.

function setChannelData(data: any)

Parámetros

data

any

Devoluciones

Message

setLanguage(string)

en desuso, use local() en su lugar.

function setLanguage(language: string)

Parámetros

language

string

Devoluciones

Message

setNText(Session, string, string, number)

en desuso, use ntext() .

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

Parámetros

session

Session

msg

string

msg_plural

string

count

number

Devoluciones

Message

setText(Session, TextType, any[])

en desuso, use text() de .

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

Parámetros

session

Session

prompt

TextType

args

any[]

Devoluciones

Message

sourceEvent(ISourceEventMap)

Para los mensajes salientes se puede usar para pasar datos de eventos específicos de origen, como datos adjuntos personalizados.

function sourceEvent(map: ISourceEventMap)

Parámetros

map

ISourceEventMap

Devoluciones

Message

speak(TextType, any[])

Establece el campo de habla del mensaje como lenguaje de marcado de síntesis de voz (SSML). Esto se hablará al usuario en dispositivos compatibles.

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

Parámetros

ssml

TextType

args

any[]

Devoluciones

Message

suggestedActions(ISuggestedActions | IIsSuggestedActions)

Acciones sugeridas opcionales para enviar al usuario. Las acciones sugeridas solo se mostrarán en los canales que admiten acciones sugeridas.

function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)

Parámetros

suggestedActions

ISuggestedActions | IIsSuggestedActions

Devoluciones

Message

summary(TextType, any[])

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

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

Parámetros

text

TextType

args

any[]

Devoluciones

Message

text(TextType, any[])

Establece el texto del mensaje.

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

Parámetros

text

TextType

args

any[]

Devoluciones

Message

textFormat(string)

Formato de los campos de texto.

function textFormat(style: string)

Parámetros

style

string

Devoluciones

Message

textLocale(string)

Idioma del mensaje.

function textLocale(locale: string)

Parámetros

locale

string

Devoluciones

Message

timestamp(string)

Establezca por servicio de conectores. Use localTimestamp().

function timestamp(time?: string)

Parámetros

time

string

Devoluciones

Message

toMessage()

Devuelve el json del mensaje.

function toMessage()

Devoluciones

IMessage

value(any)

Valor de finalización abierta.

function value(param: any)

Parámetros

param

any

Devoluciones

Message