Compartir a través de

Library class

  • Referencia
Paquete:
botbuilder-calling

Biblioteca de diálogos relacionados que se usan con fines de enrutamiento. Las bibliotecas se pueden encadenar juntas para permitir el desarrollo de bots complejos. La clase UniversalCallBot es una biblioteca que forma la raíz de esta cadena. Las bibliotecas de elementos reutilizables se pueden desarrollar mediante la creación de una nueva instancia de biblioteca y la adición de diálogos como lo haría con un bot. La biblioteca debe tener un nombre único que se corresponda con el sitio web de las bibliotecas o el nombre del módulo NPM. Los bots pueden reutilizar la biblioteca simplemente agregando la instancia de biblioteca de elementos a su bot mediante UniversalCallBot.library(). Si la propia biblioteca depende de otras bibliotecas, debe agregarlas a la biblioteca como dependencia mediante Library.library(). Puede administrar fácilmente varias versiones de la biblioteca agregando un número de versión al nombre de la biblioteca.

Para invocar diálogos dentro de los bots de biblioteca, deberá llamar a session.beginDialog() con un identificador de diálogo completo en forma de ":". Normalmente, lo ocultará del devloper exponiendo una función de su módulo que inicia el cuadro de diálogo para ellos. Por lo tanto, llamar a algo como myLib.someDialog(session, { arg: '' }); terminaría llamando a session.beginDialog('myLib:someDialog', args); en segundo plano.

Vale la pena tener en cuenta que los diálogos siempre se invocan dentro del diálogo actual, por lo que una vez que se encuentra dentro de un diálogo de la biblioteca, no es necesario prefijar todas las llamadas beginDialog() con el nombre de las bibliotecas. Solo es cuando se cruza de un contexto de biblioteca a otro que debe incluir el prefijo de nombre de biblioteca.

Constructores

Library(string)

Crea una nueva instancia de la biblioteca.

Propiedades

name

Nombre único de la biblioteca.

Métodos

dialog(string, Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)

Registra o devuelve un cuadro de diálogo de la biblioteca.
findDialog(string, string)

Busca en la biblioteca y en todas sus dependencias un cuadro de diálogo específico. Devuelve el cuadro de diálogo si se encuentra; en caso contrario, null.
library(Library | string)

Registra o devuelve una dependencia de biblioteca.

Detalles del constructor

Library(string)

Crea una nueva instancia de la biblioteca.

new Library(name: string)

Parámetros

name

string

Detalles de las propiedades

name

Nombre único de la biblioteca.

name: string

Valor de propiedad

string

Detalles del método

dialog(string, Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)

Registra o devuelve un cuadro de diálogo de la biblioteca.

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

Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep

(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

Dialog

findDialog(string, string)

Busca en la biblioteca y en todas sus dependencias un cuadro de diálogo específico. Devuelve el cuadro de diálogo si se encuentra; en caso contrario, null.

function findDialog(libName: string, dialogId: string)

Parámetros

libName

string

Nombre de la biblioteca que contiene el cuadro de diálogo.

dialogId

string

Identificador único del cuadro de diálogo dentro de la biblioteca.

Devoluciones

Dialog

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

Library