DialogStateManager class

Paquete:

botbuilder-dialogs

DialogStateManager administra los ámbitos de memoria y las resoluciones de ruta de acceso.

Comentarios

MemoryScopes se denominan objetos de nivel raíz, que pueden existir en el contexto de diálogo o desactivar el estado de activación. Los solucionadores de rutas de acceso permiten el comportamiento de acceso directo para asignar elementos como $foo -> dialog.foo

Constructores

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Inicializa una nueva instancia de la clase DialogStateManager .

Propiedades

configuration

Obtiene o establece los solucionadores de rutas de acceso configurados y los ámbitos de memoria para el administrador de estado del cuadro de diálogo.

Métodos

anyPathChanged(number, string[])	Compruebe si alguna ruta ha cambiado desde la marca de agua.
deleteScopesMemory(string)	Elimina toda la memoria de respaldo de un ámbito determinado.
deleteValue(string)	Eliminar propiedad de la memoria
getMemorySnapshot()	Obtiene todos los ámbitos de memoria adecuados para el registro.
getValue<T>(string, T | () => T)	Obtenga el valor de la memoria mediante la expresión path.
loadAllScopes()	Garantiza que se han cargado todos los ámbitos de memoria para el turno actual.
parsePath(string, boolean)	Normaliza los segmentos de ruta de acceso de una ruta de acceso pasada.
saveAllChanges()	Guarda los cambios realizados en los ámbitos de memoria.
setValue(string, any)	Establezca la memoria en valor.
trackPaths(string[])	Realice un seguimiento cuando se cambien rutas de acceso específicas.
transformPath(string)	Transforme la ruta de acceso mediante los transformadores de ruta de acceso registrados.
version()	Obtiene el número de versión.

Detalles del constructor

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Inicializa una nueva instancia de la clase DialogStateManager .

new DialogStateManager(dc: DialogContext, configuration?: DialogStateManagerConfiguration)

Parámetros

dc

DialogContext

Contexto de diálogo para el turno actual de la conversación.

configuration

DialogStateManagerConfiguration

Configuración del administrador de estado del cuadro de diálogo.

Detalles de las propiedades

configuration

Obtiene o establece los solucionadores de rutas de acceso configurados y los ámbitos de memoria para el administrador de estado del cuadro de diálogo.

configuration: DialogStateManagerConfiguration

Valor de propiedad

DialogStateManagerConfiguration

Comentarios

Hay un único conjunto de información de configuración para una cadena determinada de contextos de diálogo. La asignación de una nueva configuración a cualquier DialogStateManager dentro de la cadena actualizará la configuración de toda la cadena.

Detalles del método

anyPathChanged(number, string[])

Compruebe si alguna ruta ha cambiado desde la marca de agua.

function anyPathChanged(counter: number, paths: string[]): boolean

Parámetros

counter

number

Contador de tiempo con el que se va a comparar.

paths

string[]

Rutas de acceso de trackPaths() que se van a comprobar.

Devoluciones

boolean

True si alguna ruta de acceso ha cambiado desde el contador.

deleteScopesMemory(string)

Elimina toda la memoria de respaldo de un ámbito determinado.

function deleteScopesMemory(name: string): Promise<void>

Parámetros

name

string

Nombre del ámbito.

Devoluciones

Promise<void>

deleteValue(string)

Eliminar propiedad de la memoria

function deleteValue(pathExpression: string)

Parámetros

pathExpression

string

Propiedad hoja que se va a quitar.

getMemorySnapshot()

Obtiene todos los ámbitos de memoria adecuados para el registro.

function getMemorySnapshot(): object

Devoluciones

object

Objeto que representa todos los ámbitos de memoria.

getValue<T>(string, T | () => T)

Obtenga el valor de la memoria mediante la expresión path.

function getValue<T>(pathExpression: string, defaultValue?: T | () => T): T

Parámetros

pathExpression

string

Expresión de ruta de acceso que se va a usar.

defaultValue

T | () => T

(Opcional) valor predeterminado que se usará si no se encuentra la ruta de acceso. Puede ser una función que devuelve el valor predeterminado que se va a usar.

Devoluciones

T

El valor encontrado o undefined si no se encuentra y no defaultValue se especifica.

Comentarios

Esto siempre devuelve un CLONE de la memoria, las modificaciones en el resultado no afectarán a la memoria.

loadAllScopes()

Garantiza que se han cargado todos los ámbitos de memoria para el turno actual.

function loadAllScopes(): Promise<void>

Devoluciones

Promise<void>

Comentarios

Se debe llamar al principio del turno.

parsePath(string, boolean)

Normaliza los segmentos de ruta de acceso de una ruta de acceso pasada.

function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]

Parámetros

pathExpression

string

La ruta de acceso para normalizar.

allowNestedPaths

boolean

Opcional. Si, a false continuación, la detección de una ruta de acceso anidada hará que se devuelva una ruta de acceso vacía. El valor predeterminado es "true".

Devoluciones

string | number[]

La ruta de acceso normalizada.

Comentarios

Se normalizará una ruta de acceso a profile.address[0]profile.address.0.

saveAllChanges()

Guarda los cambios realizados en los ámbitos de memoria.

function saveAllChanges(): Promise<void>

Devoluciones

Promise<void>

Comentarios

Se debe llamar a esto al final del turno.

setValue(string, any)

Establezca la memoria en valor.

function setValue(pathExpression: string, value: any)

Parámetros

pathExpression

string

Ruta de acceso a la memoria.

value

any

Valor que se va a establecer.

trackPaths(string[])

Realice un seguimiento cuando se cambien rutas de acceso específicas.

function trackPaths(paths: string[]): string[]

Parámetros

paths

string[]

Rutas de acceso para realizar el seguimiento.

Devoluciones

string[]

Rutas de acceso normalizadas para pasar a anyPathChanged().

transformPath(string)

Transforme la ruta de acceso mediante los transformadores de ruta de acceso registrados.

function transformPath(pathExpression: string): string

Parámetros

pathExpression

string

Ruta de acceso que se va a transformar.

Devoluciones

string

Ruta de acceso transformada.

version()

Obtiene el número de versión.

function version(): string

Devoluciones

string

Cadena con el número de versión.