Compartilhar via

MemoryScope class

  • Referência
Pacote:
botbuilder-dialogs

Classe base abstrata para todos os escopos de memória.

Construtores

MemoryScope(string, boolean)

Inicializa uma nova instância da classe MemoryScope.

Propriedades

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

delete(DialogContext)

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

Obter a memória de backup para este escopo
load(DialogContext)

Carrega uma memória de backup de escopos no início de uma curva.
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

MemoryScope(string, boolean)

Inicializa uma nova instância da classe MemoryScope.

new MemoryScope(name: string, includeInSnapshot?: boolean)

Parâmetros

name

string

Nome do escopo.

includeInSnapshot

boolean

Valor booliano que indica se essa memória deve ser incluída no instantâneo. O valor padrão é verdadeiro.

Detalhes da propriedade

includeInSnapshot

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

includeInSnapshot: boolean

Valor da propriedade

boolean

name

Obtém ou define o nome do escopo

name: string

Valor da propriedade

string

Detalhes do método

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>

getMemory(DialogContext)

Obter a memória de backup para este escopo

function getMemory(dc: DialogContext): object

Parâmetros

dc
DialogContext

Contexto da caixa de diálogo atual.

Retornos

object

memória para o escopo

load(DialogContext)

Carrega uma memória de backup de escopos no início de uma curva.

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

Parâmetros

_dc
DialogContext

Contexto da caixa de diálogo atual.

Retornos

Promise<void>

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>

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