ConversationMemoryScope class
Memória com escopo para a conversa atual.
- Extends
Construtores
Conversation |
Inicializa uma nova instância da classe ConversationMemoryScope. |
Propriedades herdadas
include |
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 herdados
delete(Dialog |
Exclui qualquer estado no armazenamento e o cache deste BotState. |
get |
Obtenha a memória de backup para esse escopo. |
load(Dialog |
Popula o cache de estado para este BotState da camada de armazenamento. |
save |
Grava o cache de estado deste BotState na camada de armazenamento. |
set |
Altera o objeto de backup para o escopo da memória. |
Detalhes do construtor
ConversationMemoryScope()
Inicializa uma nova instância da classe ConversationMemoryScope.
new ConversationMemoryScope()
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 herdado
delete(DialogContext)
Exclui qualquer estado no armazenamento e o cache deste BotState.
function delete(_dc: DialogContext): Promise<void>
Parâmetros
- _dc
- DialogContext
O objeto DialogContext
Retornos
Promise<void>
Uma promessa que representa o trabalho enfileirado a ser executado.
herdado deBotStateMemoryScope.delete
getMemory(DialogContext)
Obtenha a memória de backup para esse escopo.
function getMemory(dc: DialogContext): object
Parâmetros
contexto da caixa de diálogo atual.
Retornos
object
Memória para o escopo.
load(DialogContext, boolean)
Popula o cache de estado para este BotState da camada de armazenamento.
function load(dc: DialogContext, force?: boolean): Promise<void>
Parâmetros
O objeto DialogContext
- force
-
boolean
Opcional, true
substituir qualquer cache de estado existente; ou false
carregar o estado do armazenamento somente se o cache ainda não existir.
Retornos
Promise<void>
Uma promessa que representa o trabalho enfileirado a ser executado.
herdado deBotStateMemoryScope.load
saveChanges(DialogContext, boolean)
Grava o cache de estado deste BotState na camada de armazenamento.
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>
Parâmetros
O objeto DialogContext
- force
-
boolean
Opcional, true
salvar o cache de estado no armazenamento; ou false
salvar o estado no armazenamento somente se uma propriedade no cache tiver sido alterada.
Retornos
Promise<void>
Uma promessa que representa o trabalho enfileirado a ser executado.
herdado deBotStateMemoryScope.saveChanges
setMemory(DialogContext, object)
Altera o objeto de backup para o escopo da memória.
function setMemory(dc: DialogContext, _memory: object)
Parâmetros
contexto da caixa de diálogo atual
- _memory
-
object
memória