Compartilhar via

SettingsMemoryScope class

  • Referência
Pacote:
botbuilder-dialogs

SettingsMemoryScope mapeia "configurações" –> dc.context.turnState['settings']

Extends
MemoryScope

Construtores

SettingsMemoryScope(Record<string, unknown>)

Inicializa uma nova instância da classe SettingsMemoryScope.

Propriedades herdadas

includeInSnapshot

Obtém um valor que indica se essa memória deve ser incluída no instantâneo.
name

Obtém ou define o nome do escopo

Métodos

getMemory(DialogContext)

Obtém a memória de backup para esse escopo.
load(DialogContext)

Métodos herdados

delete(DialogContext)

Exclui a memória de backup de um escopo.
saveChanges(DialogContext)

Salva uma memória de backup de escopos no final de uma curva.
setMemory(DialogContext, object)

Altera o objeto de backup para o escopo da memória.

Detalhes do construtor

SettingsMemoryScope(Record<string, unknown>)

Inicializa uma nova instância da classe SettingsMemoryScope.

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

Parâmetros

initialSettings

Record<string, unknown>

conjunto inicial de configurações a serem fornecidos

Detalhes das propriedades herdadas

includeInSnapshot

Obtém um valor que indica se essa memória deve ser incluída no instantâneo.

includeInSnapshot: boolean

Valor da propriedade

boolean

Herdado deMemoryScope.includeInSnapshot

name

Obtém ou define o nome do escopo

name: string

Valor da propriedade

string

herdado deMemoryScope.name

Detalhes do método

getMemory(DialogContext)

Obtém a memória de backup para esse escopo.

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

Parâmetros

dc
DialogContext

O objeto DialogContext para esta vez.

Retornos

Record<string, unknown>

A memória do escopo.

load(DialogContext) 

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

Parâmetros

dc
DialogContext

Contexto da caixa de diálogo atual.

Retornos

Promise<void>

Detalhes do método herdado

delete(DialogContext)

Exclui a memória de backup de um escopo.

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

Parâmetros

_dc
DialogContext

Contexto da caixa de diálogo atual.

Retornos

Promise<void>

herdado doMemoryScope.delete

saveChanges(DialogContext)

Salva uma memória de backup de escopos no final de uma curva.

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

Parâmetros

_dc
DialogContext

Contexto da caixa de diálogo atual.

Retornos

Promise<void>

herdado doMemoryScope.saveChanges

setMemory(DialogContext, object)

Altera o objeto de backup para o escopo da memória.

function setMemory(_dc: DialogContext, _memory: object)

Parâmetros

_dc
DialogContext

Contexto da caixa de diálogo atual

_memory

object

memória a ser atribuída

herdado de MemoryScope.setMemory