BotStateMemoryScope class
Clase base para ámbitos de memoria basados en BotState.
- Extends
Constructores
| Bot |
Inicializa una nueva instancia de la clase BotStateMemoryScope. |
Propiedades heredadas
| include |
Obtiene un valor que indica si esta memoria debe incluirse en la instantánea. |
| name | Obtiene o establece el nombre del ámbito. |
Métodos
| delete(Dialog |
Elimina cualquier estado en el almacenamiento y la memoria caché de este BotState. |
| get |
Obtenga la memoria de respaldo para este ámbito. |
| load(Dialog |
Rellena la caché de estado de este BotState desde la capa de almacenamiento. |
| save |
Escribe la caché de estado de este BotState en la capa de almacenamiento. |
| set |
Cambia el objeto de respaldo del ámbito de memoria. |
Detalles del constructor
BotStateMemoryScope(string)
Inicializa una nueva instancia de la clase BotStateMemoryScope.
new BotStateMemoryScope(name: string)Parámetros
- name
-
string
nombre de la propiedad.
Detalles de las propiedades heredadas
includeInSnapshot
Obtiene un valor que indica si esta memoria debe incluirse en la instantánea.
includeInSnapshot: booleanValor de propiedad
boolean
Heredado deMemoryScope.includeInSnapshot
name
Obtiene o establece el nombre del ámbito.
name: stringValor de propiedad
string
heredado deMemoryScope.name
Detalles del método
delete(DialogContext)
Elimina cualquier estado en el almacenamiento y la memoria caché de este BotState.
function delete(_dc: DialogContext): Promise<void>Parámetros
- _dc
- DialogContext
Objeto DialogContext para este turno.
Devoluciones
Promise<void>
Promesa que representa el trabajo en cola que se va a ejecutar.
getMemory(DialogContext)
Obtenga la memoria de respaldo para este ámbito.
function getMemory(dc: DialogContext): objectParámetros
contexto de diálogo actual.
Devoluciones
object
Memoria para el ámbito.
load(DialogContext, boolean)
Rellena la caché de estado de este BotState desde la capa de almacenamiento.
function load(dc: DialogContext, force?: boolean): Promise<void>Parámetros
Objeto DialogContext para este turno.
- force
-
boolean
Opcional, true para sobrescribir cualquier caché de estado existente; o false cargar el estado desde el almacenamiento solo si la memoria caché aún no existe.
Devoluciones
Promise<void>
Promesa que representa el trabajo en cola que se va a ejecutar.
saveChanges(DialogContext, boolean)
Escribe la caché de estado de este BotState en la capa de almacenamiento.
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>Parámetros
Objeto DialogContext para este turno.
- force
-
boolean
Opcional, true para guardar la caché de estado en el almacenamiento; o false guardar el estado en el almacenamiento solo si ha cambiado una propiedad de la memoria caché.
Devoluciones
Promise<void>
Promesa que representa el trabajo en cola que se va a ejecutar.
setMemory(DialogContext, object)
Cambia el objeto de respaldo del ámbito de memoria.
function setMemory(dc: DialogContext, _memory: object)Parámetros
contexto de diálogo actual
- _memory
-
object
memoria