InspectionState class
Advertencia
Esta API ya está en desuso.
This class will be removed in a future version of the framework.
InspectionState para su uso en InspectionMiddleware para la inspección del emulador de actividades en tiempo de ejecución y BotState.
- Extends
-
BotState
Comentarios
InspectionState para su uso en InspectionMiddleware para la inspección del emulador de actividades en tiempo de ejecución y BotState.
Constructores
Inspection |
Crea una nueva instancia de la clase InspectionState . |
Métodos heredados
clear(Turn |
Borra el objeto de estado actual de un turno. |
create |
Crea un nuevo descriptor de acceso de propiedad para leer y escribir una propiedad individual en el objeto de almacenamiento de estados del bot. |
delete(Turn |
Elimine el objeto de estado de respaldo del turno actual. |
get(Turn |
Devuelve un objeto de estado almacenado en caché o undefined si no se almacena en caché. |
load(Turn |
Lee y almacena en caché el objeto de estado de respaldo para un turno. |
save |
Guarda el objeto de estado almacenado en caché si se ha cambiado. |
Detalles del constructor
InspectionState(Storage)
Crea una nueva instancia de la clase InspectionState .
new InspectionState(storage: Storage)
Parámetros
- storage
-
Storage
La capa de almacenamiento que usará este objeto de administración de estado para almacenar y recuperar el estado.
Detalles de los métodos heredados
clear(TurnContext)
Borra el objeto de estado actual de un turno.
function clear(context: TurnContext): Promise<void>
Parámetros
- context
-
TurnContext
Contexto para el turno actual de conversación con el usuario.
Devoluciones
Promise<void>
Promesa que representa la operación asincrónica.
Comentarios
El objeto de estado borrado no se conservará hasta que se haya llamado a saveChanges().
await botState.clear(context);
await botState.saveChanges(context);
Heredado de BotState.clear
createProperty<T>(string)
Crea un nuevo descriptor de acceso de propiedad para leer y escribir una propiedad individual en el objeto de almacenamiento de estados del bot.
function createProperty<T>(name: string): StatePropertyAccessor<T>
Parámetros
- name
-
string
Nombre de la propiedad que se va a agregar.
Devoluciones
StatePropertyAccessor<T>
Descriptor de acceso de la propiedad .
Heredado de BotState.createProperty
delete(TurnContext)
Elimine el objeto de estado de respaldo del turno actual.
function delete(context: TurnContext): Promise<void>
Parámetros
- context
-
TurnContext
Contexto para el turno actual de conversación con el usuario.
Devoluciones
Promise<void>
Promesa que representa la operación asincrónica.
Comentarios
El objeto de estado se quitará del almacenamiento si existe. Si el objeto de estado se ha leído y almacenado en caché, se borrará la memoria caché.
await botState.delete(context);
Heredado de BotState.delete
get(TurnContext)
Devuelve un objeto de estado almacenado en caché o undefined si no se almacena en caché.
function get(context: TurnContext): any | undefined
Parámetros
- context
-
TurnContext
Contexto para el turno actual de conversación con el usuario.
Devoluciones
any | undefined
Objeto de estado almacenado en caché o indefinido si no se almacena en caché.
Comentarios
En este ejemplo se muestra cómo obtener de forma sincrónica un objeto de estado ya cargado y almacenado en caché:
const state = botState.get(context);
Heredado de BotState.get
load(TurnContext, boolean)
Lee y almacena en caché el objeto de estado de respaldo para un turno.
function load(context: TurnContext, force?: boolean): Promise<any>
Parámetros
- context
-
TurnContext
Contexto para el turno actual de conversación con el usuario.
- force
-
boolean
(Opcional) Si true
se omitirá la memoria caché y el estado siempre se leerá directamente desde el almacenamiento. Tiene como valor predeterminado false
.
Devoluciones
Promise<any>
Estado almacenado en caché.
Comentarios
Las lecturas posteriores devolverán el objeto almacenado en caché a menos que se pase la force
marca en la que se forzará la lectura del objeto de estado.
Este método se llama automáticamente al primer acceso de cualquiera de los descriptores de acceso de propiedad creados.
const state = await botState.load(context);
Heredado de BotState.load
saveChanges(TurnContext, boolean)
Guarda el objeto de estado almacenado en caché si se ha cambiado.
function saveChanges(context: TurnContext, force?: boolean): Promise<void>
Parámetros
- context
-
TurnContext
Contexto para el turno actual de conversación con el usuario.
- force
-
boolean
(Opcional) si true
el estado siempre se escribirá independientemente de su estado de cambio. Tiene como valor predeterminado false
.
Devoluciones
Promise<void>
Promesa que representa la operación asincrónica.
Comentarios
Si la force
marca se pasa en el objeto de estado almacenado en caché se guardará independientemente de si se ha cambiado o no y si no se ha almacenado en caché ningún objeto, se creará un objeto vacío y, a continuación, se guardará.
await botState.saveChanges(context);
Heredado de BotState.saveChanges