CallSession class

Paquete:

botbuilder-calling

Administra la conversación de bots con un usuario.

Constructores

CallSession(ICallSessionOptions)

Crea una instancia de la sesión.

Propiedades

conversationData	Datos de conversación compartidos que son visibles para todos los miembros de la conversación.
dialogData	Datos que solo son visibles para el cuadro de diálogo actual.
library	La biblioteca raíz de bots de diálogos.
message	Mensaje recibido del usuario. En el caso de los mensajes originados por el bot, esto solo puede contener los campos "to" & "from".
privateConversationData	Datos de conversación privada que solo son visibles para el usuario.
sessionState	Sesiones de información de estado actual.
userData	Datos del usuario que se conservan en todas las conversaciones con el bot.

Métodos

answer()	Responde manualmente a la llamada. La llamada se responderá automáticamente cuando el bot realice una acción.
beginDialog<T>(string, T)	Pasa el control de la conversación a un cuadro de diálogo nuevo. El diálogo actual se suspenderá hasta que se complete el diálogo secundario. Una vez que el elemento secundario finaliza el cuadro de diálogo actual, recibirá una llamada a dialogResumed() donde puede inspeccionar los resultados devueltos por el elemento secundario.
dispatch(ISessionState, IEvent)	Envía un mensaje para su procesamiento. La sesión llamará a cualquier middleware instalado antes del mensaje al cuadro de diálogo activo para su procesamiento.
endConversation(string | string[] | IAction | IIsAction, any[])	Finaliza la conversación actual y, opcionalmente, envía un mensaje al usuario. La llamada se colgará o rechazará automáticamente.
endDialog(string | string[] | IAction | IIsAction, any[])	Finaliza el cuadro de diálogo actual y, opcionalmente, envía un mensaje al usuario. El elemento primario se reanudará con un IDialogResult.reanudado motivo de completado.
endDialogWithResult(IDialogResult<any>)	Finaliza el cuadro de diálogo actual y, opcionalmente, devuelve un resultado al elemento primario de los diálogos.
error(Error)	Indica que se produjo un error. El bot indicará el error a través de un evento on('error', err).
gettext(string, any[])	Carga una cadena localizada para el idioma de los mensajes. Si se pasan argumentos, la cadena localizada se tratará como una plantilla y tendrá formato mediante sprintf-js (consulte sus documentos para obtener más información).
hangup()	Finaliza manualmente una llamada establecida. La llamada se finalizará automáticamente cuando el bot deje de solicitar al usuario la entrada.
isReset()	Devuelve true si se ha restablecido la sesión.
messageSent()	Devuelve true si se ha enviado un mensaje para esta sesión.
ngettext(string, string, number)	Carga la forma plural de una cadena localizada para el idioma de los mensajes. La cadena de salida tendrá formato para incluir el recuento reemplazando %d en la cadena por el recuento.
on(string, Function)	Registra un agente de escucha de eventos.
reject()	Rechaza una llamada entrante.
replaceDialog<T>(string, T)	Finaliza el cuadro de diálogo actual e inicia uno nuevo en su lugar. El cuadro de diálogo primario no se reanudará hasta que se complete el cuadro de diálogo nuevo.
reset(string, any)	Borra la pila de llamadas de sesiones y reinicia la conversación con el dialogId configurado.
save()	Desencadena el guardado de cambios realizados en dialogData, userData, conversationdatao [privateConversationData'(#privateconversationdata).
send(string | string[] | IAction | IIsAction, any[])	Envía una acción PlayPrompt al usuario.
sendBatch()	Finaliza inmediatamente el lote actual y entrega los mensajes en cola.

Detalles del constructor

CallSession(ICallSessionOptions)

Crea una instancia de la sesión.

new CallSession(options: ICallSessionOptions)

Parámetros

options

ICallSessionOptions

Opciones de configuración de sesiones.

Detalles de las propiedades

conversationData

Datos de conversación compartidos que son visibles para todos los miembros de la conversación.

conversationData: any

Valor de propiedad

any

dialogData

Datos que solo son visibles para el cuadro de diálogo actual.

dialogData: any

Valor de propiedad

any

library

La biblioteca raíz de bots de diálogos.

library: Library

Valor de propiedad

Library

message

Mensaje recibido del usuario. En el caso de los mensajes originados por el bot, esto solo puede contener los campos "to" & "from".

message: IEvent

Valor de propiedad

IEvent

privateConversationData

Datos de conversación privada que solo son visibles para el usuario.

privateConversationData: any

Valor de propiedad

any

sessionState

Sesiones de información de estado actual.

sessionState: ISessionState

Valor de propiedad

ISessionState

userData

Datos del usuario que se conservan en todas las conversaciones con el bot.

userData: any

Valor de propiedad

any

Detalles del método

answer()

Responde manualmente a la llamada. La llamada se responderá automáticamente cuando el bot realice una acción.

function answer()

Devoluciones

CallSession

beginDialog<T>(string, T)

Pasa el control de la conversación a un cuadro de diálogo nuevo. El diálogo actual se suspenderá hasta que se complete el diálogo secundario. Una vez que el elemento secundario finaliza el cuadro de diálogo actual, recibirá una llamada a dialogResumed() donde puede inspeccionar los resultados devueltos por el elemento secundario.

function beginDialog<T>(id: string, args?: T)

Parámetros

id

string

Identificador único del cuadro de diálogo que se va a iniciar.

args

T

(Opcional) argumentos para pasar a los diálogos método begin().

Devoluciones

CallSession

dispatch(ISessionState, IEvent)

Envía un mensaje para su procesamiento. La sesión llamará a cualquier middleware instalado antes del mensaje al cuadro de diálogo activo para su procesamiento.

function dispatch(sessionState: ISessionState, message: IEvent)

Parámetros

sessionState

ISessionState

Estado de sesión actual. Si null se iniciará una nueva conversación a partir del dialogId configurado.

message

IEvent

Mensaje que se va a enviar.

Devoluciones

CallSession

endConversation(string | string[] | IAction | IIsAction, any[])

Finaliza la conversación actual y, opcionalmente, envía un mensaje al usuario. La llamada se colgará o rechazará automáticamente.

function endConversation(action?: string | string[] | IAction | IIsAction, args: any[])

Parámetros

action

string | string[] | IAction | IIsAction

(Opcional)

• acción:{string}: texto del mensaje que se va a enviar. El mensaje se localizará mediante el localizador configurado de sesiones. Si se pasan argumentos en el mensaje se da formato mediante sprintf-js.
• acción:{string[]}: el mensaje enviado se elegirá aleatoriamente de la matriz.
• acción:{IAction|IIsAction}: acción que se va a enviar.

args

any[]

(Opcional) argumentos usados para dar formato al texto de salida final cuando mensaje es un {string|string[]}.

Devoluciones

CallSession

endDialog(string | string[] | IAction | IIsAction, any[])

Finaliza el cuadro de diálogo actual y, opcionalmente, envía un mensaje al usuario. El elemento primario se reanudará con un IDialogResult.reanudado motivo de completado.

function endDialog(action?: string | string[] | IAction | IIsAction, args: any[])

Parámetros

action

string | string[] | IAction | IIsAction

(Opcional)

• acción:{string}: texto del mensaje que se va a enviar. El mensaje se localizará mediante el localizador configurado de sesiones. Si se pasan argumentos en el mensaje se da formato mediante sprintf-js.
• acción:{string[]}: el mensaje enviado se elegirá aleatoriamente de la matriz.
• acción:{IAction|IIsAction}: acción que se va a enviar.

args

any[]

(Opcional) argumentos usados para dar formato al texto de salida final cuando mensaje es un {string|string[]}.

Devoluciones

CallSession

endDialogWithResult(IDialogResult<any>)

Finaliza el cuadro de diálogo actual y, opcionalmente, devuelve un resultado al elemento primario de los diálogos.

function endDialogWithResult(result?: IDialogResult<any>)

Parámetros

result

IDialogResult<any>

Devoluciones

CallSession

error(Error)

Indica que se produjo un error. El bot indicará el error a través de un evento on('error', err).

function error(err: Error)

Parámetros

err

Error

Error que se produjo.

Devoluciones

CallSession

gettext(string, any[])

Carga una cadena localizada para el idioma de los mensajes. Si se pasan argumentos, la cadena localizada se tratará como una plantilla y tendrá formato mediante sprintf-js (consulte sus documentos para obtener más información).

function gettext(msgid: string, args: any[])

Parámetros

msgid

string

Cadena que se va a usar como clave en la tabla de cadenas localizadas. Normalmente, esto solo será la versión en inglés de la cadena.

args

any[]

(Opcional) argumentos usados para dar formato a la cadena de salida final.

Devoluciones

string

hangup()

Finaliza manualmente una llamada establecida. La llamada se finalizará automáticamente cuando el bot deje de solicitar al usuario la entrada.

function hangup()

Devoluciones

CallSession

isReset()

Devuelve true si se ha restablecido la sesión.

function isReset()

Devoluciones

boolean

messageSent()

Devuelve true si se ha enviado un mensaje para esta sesión.

function messageSent()

Devoluciones

boolean

ngettext(string, string, number)

Carga la forma plural de una cadena localizada para el idioma de los mensajes. La cadena de salida tendrá formato para incluir el recuento reemplazando %d en la cadena por el recuento.

function ngettext(msgid: string, msgid_plural: string, count: number)

Parámetros

msgid

string

Forma singular de la cadena que se va a usar como clave en la tabla de cadenas localizadas. Use %d para especificar dónde debe ir el recuento.

msgid_plural

string

Forma plural de la cadena que se va a usar como clave en la tabla de cadenas localizadas. Use %d para especificar dónde debe ir el recuento.

count

number

Recuento que se va a usar al determinar si se debe usar la forma singular o plural de la cadena.

Devoluciones

string

on(string, Function)

Registra un agente de escucha de eventos.

function on(event: string, listener: Function)

Parámetros

event

string

Nombre del evento. Tipos de eventos:

• error: Error. IErrorEvent

listener

Function

Función que se va a invocar.

reject()

Rechaza una llamada entrante.

function reject()

Devoluciones

CallSession

replaceDialog<T>(string, T)

Finaliza el cuadro de diálogo actual e inicia uno nuevo en su lugar. El cuadro de diálogo primario no se reanudará hasta que se complete el cuadro de diálogo nuevo.

function replaceDialog<T>(id: string, args?: T)

Parámetros

id

string

Identificador único del cuadro de diálogo que se va a iniciar.

args

T

(Opcional) argumentos para pasar a los diálogos método begin().

Devoluciones

CallSession

reset(string, any)

Borra la pila de llamadas de sesiones y reinicia la conversación con el dialogId configurado.

function reset(dialogId?: string, dialogArgs?: any)

Parámetros

dialogId

string

(Opcional) Identificador del cuadro de diálogo que se va a iniciar.

dialogArgs

any

(Opcional) argumentos para pasar a los diálogos método begin().

Devoluciones

CallSession

save()

Desencadena el guardado de cambios realizados en dialogData, userData, conversationdatao [privateConversationData'(#privateconversationdata).

function save()

Devoluciones

CallSession

send(string | string[] | IAction | IIsAction, any[])

Envía una acción PlayPrompt al usuario.

function send(action: string | string[] | IAction | IIsAction, args: any[])

Parámetros

action

string | string[] | IAction | IIsAction

• acción:{string}: texto del mensaje que se va a enviar. El mensaje se localizará mediante el localizador configurado de sesiones. Si se pasan argumentos en el mensaje se da formato mediante sprintf-js.
• acción:{string[]}: el mensaje enviado se elegirá aleatoriamente de la matriz.
• acción:{IAction|IIsAction}: acción que se va a enviar.

args

any[]

(Opcional) argumentos usados para dar formato al texto de salida final cuando acción es un {string|string[]}.

Devoluciones

CallSession

sendBatch()

Finaliza inmediatamente el lote actual y entrega los mensajes en cola.

function sendBatch()