UniversalCallBot class
Administra las conversaciones de los bots con los usuarios en varios canales.
Constructores
| Universal |
Crea una nueva instancia de UniversalCallBot. |
Métodos
| dialog(string, Dialog | IDialog |
Registra o devuelve un cuadro de diálogo para el bot. |
| get(string) | Devuelve el valor actual de una configuración. |
| library(Library | string) | Registra o devuelve una dependencia de biblioteca. |
| on(string, Function) | Registra un agente de escucha de eventos. |
| set(string, any) | Establece una configuración en el bot. |
| use(IMiddleware |
Instala middleware para el bot. El middleware le permite interceptar eventos o mensajes entrantes y salientes. |
Detalles del constructor
UniversalCallBot(ICallConnector, IUniversalCallBotSettings)
Crea una nueva instancia de UniversalCallBot.
new UniversalCallBot(connector: ICallConnector, settings?: IUniversalCallBotSettings)
Parámetros
- connector
- ICallConnector
(Opcional) el conector predeterminado que se va a usar para las solicitudes. Si no hay un conector más específico registrado para un canal, se usará este conector./**
- settings
- IUniversalCallBotSettings
(Opcional) opciones para configurar el bot con.
Detalles del método
dialog(string, Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)
Registra o devuelve un cuadro de diálogo para el bot.
function dialog(id: string, dialog?: Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)
Parámetros
- id
-
string
Identificador único del cuadro de diálogo que se está resitiando o recuperando.
- dialog
(Opcional) cuadro de diálogo o cascada que se va a registrar.
- cuadro de diálogo:{Dialog} : cuadro de diálogo que se va a agregar.
- cuadro de diálogo :{IDialogWaterfallStep[]}: cascada de pasos que se van a ejecutar. Consulte IDialogWaterfallStep para obtener más información.
- cuadro de diálogo :{IDialogWaterfallStep}: cascada de paso único. Al llamar a un símbolo del sistema integrado o iniciar un nuevo cuadro de diálogo, el diálogo actual finalizará al finalizar el mensaje o el diálogo secundario.
Devoluciones
get(string)
Devuelve el valor actual de una configuración.
function get(name: string)
Parámetros
- name
-
string
Nombre de la propiedad que se va a devolver. Los nombres válidos son propiedades en IUniversalCallBotSettings.
Devoluciones
any
library(Library | string)
Registra o devuelve una dependencia de biblioteca.
function library(lib: Library | string)
Parámetros
- lib
-
Library | string
- lib:{Library} : biblioteca para registrarse como dependencia.
- lib:{string}: nombre único de la biblioteca que se va a buscar. También se buscarán todas las dependencias.
Devoluciones
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.
set(string, any)
Establece una configuración en el bot.
function set(name: string, value: any)
Parámetros
- name
-
string
Nombre de la propiedad que se va a establecer. Los nombres válidos son propiedades en IUniversalCallBotSettings.
- value
-
any
Valor que se va a asignar a la configuración.
Devoluciones
use(IMiddlewareMap[])
Instala middleware para el bot. El middleware le permite interceptar eventos o mensajes entrantes y salientes.
function use(args: IMiddlewareMap[])
Parámetros
- args
Uno o varios conjuntos de enlaces de middleware que se van a instalar.