UserMemoryScope class

Paquete:

botbuilder-dialogs

Memoria cuyo ámbito es el usuario actual.

Extends

BotStateMemoryScope

Constructores

UserMemoryScope()

Inicializa una nueva instancia de la clase UserMemoryScope de .

Propiedades heredadas

includeInSnapshot	Obtiene un valor que indica si esta memoria debe incluirse en la instantánea.
name	Obtiene o establece el nombre del ámbito.

Métodos heredados

delete(DialogContext)	Elimina cualquier estado en el almacenamiento y la memoria caché de este BotState.
getMemory(DialogContext)	Obtenga la memoria de respaldo para este ámbito.
load(DialogContext, boolean)	Rellena la caché de estado de este BotState desde la capa de almacenamiento.
saveChanges(DialogContext, boolean)	Escribe la caché de estado de este BotState en la capa de almacenamiento.
setMemory(DialogContext, object)	Cambia el objeto de respaldo del ámbito de memoria.

Detalles del constructor

UserMemoryScope()

Inicializa una nueva instancia de la clase UserMemoryScope de .

new UserMemoryScope()

Detalles de las propiedades heredadas

includeInSnapshot

Obtiene un valor que indica si esta memoria debe incluirse en la instantánea.

includeInSnapshot: boolean

Valor de propiedad

boolean

Heredado deMemoryScope.includeInSnapshot

name

Obtiene o establece el nombre del ámbito.

name: string

Valor de propiedad

string

heredado deMemoryScope.name

Detalles de los métodos heredados

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.

Heredado deBotStateMemoryScope.delete

getMemory(DialogContext)

Obtenga la memoria de respaldo para este ámbito.

function getMemory(dc: DialogContext): object

Parámetros

dc

DialogContext

contexto de diálogo actual.

Devoluciones

object

Memoria para el ámbito.

heredado deBotStateMemoryScope.getMemory

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

dc

DialogContext

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.

heredado debotStateMemoryScope.load

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

dc

DialogContext

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.

Heredado deBotStateMemoryScope.saveChanges

setMemory(DialogContext, object)

Cambia el objeto de respaldo del ámbito de memoria.

function setMemory(dc: DialogContext, _memory: object)

Parámetros

dc

DialogContext

contexto de diálogo actual

_memory

object

memoria

heredado deBotStateMemoryScope.setMemory