Compartir a través de

SettingsMemoryScope class

  • Referencia
Paquete:
botbuilder-dialogs

SettingsMemoryScope asigna "settings":> dc.context.turnState['settings']

Extends
MemoryScope

Constructores

SettingsMemoryScope(Record<string, unknown>)

Inicializa una nueva instancia de la clase settingsMemoryScope 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

getMemory(DialogContext)

Obtiene la memoria de respaldo para este ámbito.
load(DialogContext)

Métodos heredados

delete(DialogContext)

Elimina la memoria de respaldo de un ámbito.
saveChanges(DialogContext)

Guarda una memoria de respaldo de ámbitos al final de un turno.
setMemory(DialogContext, object)

Cambia el objeto de respaldo del ámbito de memoria.

Detalles del constructor

SettingsMemoryScope(Record<string, unknown>)

Inicializa una nueva instancia de la clase settingsMemoryScope de .

new SettingsMemoryScope(initialSettings?: Record<string, unknown>)

Parámetros

initialSettings

Record<string, unknown>

conjunto inicial de configuración que se va a proporcionar

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 del método

getMemory(DialogContext)

Obtiene la memoria de respaldo para este ámbito.

function getMemory(dc: DialogContext): Record<string, unknown>

Parámetros

dc
DialogContext

Objeto DialogContext para este turno.

Devoluciones

Record<string, unknown>

Memoria del ámbito.

load(DialogContext) 

function load(dc: DialogContext): Promise<void>

Parámetros

dc
DialogContext

Contexto de diálogo actual.

Devoluciones

Promise<void>

Detalles de los métodos heredados

delete(DialogContext)

Elimina la memoria de respaldo de un ámbito.

function delete(_dc: DialogContext): Promise<void>

Parámetros

_dc
DialogContext

Contexto de diálogo actual.

Devoluciones

Promise<void>

heredado dememoryScope.delete

saveChanges(DialogContext)

Guarda una memoria de respaldo de ámbitos al final de un turno.

function saveChanges(_dc: DialogContext): Promise<void>

Parámetros

_dc
DialogContext

Contexto de diálogo actual.

Devoluciones

Promise<void>

Heredado deMemoryScope.saveChanges

setMemory(DialogContext, object)

Cambia el objeto de respaldo del ámbito de memoria.

function setMemory(_dc: DialogContext, _memory: object)

Parámetros

_dc
DialogContext

Contexto del cuadro de diálogo actual

_memory

object

memoria que se va a asignar

Heredado deMemoryScope.setMemory