Compartilhar via

MemoryScope Classe

  • Referência
Pacote:
com.microsoft.bot.dialogs.memory.scopes
Artefato Maven:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.memory.scopes.MemoryScope

public abstract class MemoryScope

MemoryScope representa uma classe abstrata de escopo de memória nomeada.

Resumo do Construtor

Construtor Description
MemoryScope(String name, Boolean includeInSnapshot)

Inicializa uma nova instância da classe.

Resumo do método

Modificador e tipo Método e descrição
java.util.concurrent.CompletableFuture<java.lang.Void> delete(DialogContext dialogContext)

Exclui qualquer estado no armazenamento e o cache para isso.
java.lang.Boolean getIncludeInSnapshot()
abstract java.lang.Object getMemory(DialogContext dialogContext)

Obtenha a memória de backup para esse escopo.
java.lang.String getName()
java.util.concurrent.CompletableFuture<java.lang.Void> load(DialogContext dialogContext, Boolean force)

Preenche o cache de estado para isso da camada de armazenamento.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(DialogContext dialogContext, Boolean force)

Grava o cache de estado para isso na camada de armazenamento.
void setIncludeInSnapshot(Boolean withIncludeInSnapshot)
abstract void setMemory(DialogContext dialogContext, Object memory)

Altera o objeto de backup para o escopo da memória.
void setName(String withName)

Métodos herdados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalhes do construtor

MemoryScope

public MemoryScope(String name, Boolean includeInSnapshot)

Inicializa uma nova instância da classe.

Parâmetros:

name - Nome do escopo.
includeInSnapshot - Valor que indica se essa memória deve ser incluída no instantâneo.

Detalhes do método

delete

public CompletableFuture delete(DialogContext dialogContext)

Exclui qualquer estado no armazenamento e o cache para isso.

Parâmetros:

dialogContext - O objeto de contexto da caixa de diálogo para esta vez.

Retornos:

CompletableFuture A future that represents the work enfileirado to execute.

getIncludeInSnapshot

public Boolean getIncludeInSnapshot()

Retornos:

Boolean Retorna o valor que indica se essa memória deve ser incluída no instantâneo.

getMemory

public abstract Object getMemory(DialogContext dialogContext)

Obtenha a memória de backup para esse escopo.

Parâmetros:

dialogContext - O DialogContext a ser obtido do repositório de memória.

Retornos:

Objeto A memória para este escopo.

getName

public String getName()

Retornos:

A cadeia de caracteres obtém o nome do escopo.

load

public CompletableFuture load(DialogContext dialogContext, Boolean force)

Preenche o cache de estado para isso da camada de armazenamento.

Parâmetros:

dialogContext - O objeto de contexto da caixa de diálogo para esta vez.
force - True para substituir qualquer cache de estado existente ou false para carregar o estado do armazenamento somente se o cache ainda não existir.

Retornos:

CompletableFuture A future that represents the work enfileirado to execute.

saveChanges

public CompletableFuture saveChanges(DialogContext dialogContext, Boolean force)

Grava o cache de estado para isso na camada de armazenamento.

Parâmetros:

dialogContext - O objeto de contexto da caixa de diálogo para esta vez.
force - True para salvar o cache de estado no armazenamento. ou false para salvar o estado no armazenamento somente se uma propriedade no cache tiver sido alterada.

Retornos:

CompletableFuture A future that represents the work enfileirado to execute.

setIncludeInSnapshot

public void setIncludeInSnapshot(Boolean withIncludeInSnapshot)

Parâmetros:

withIncludeInSnapshot - Define o valor que indica se essa memória deve ser incluída no instantâneo.

setMemory

public abstract void setMemory(DialogContext dialogContext, Object memory)

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

Parâmetros:

dialogContext - O DialogContext a ser definido no repositório de memória.
memory - A memória para a qual definir o DialogContext.

setName

public void setName(String withName)

Parâmetros:

withName - Define o nome do escopo.

Aplica-se a