BotState Classe
- java.
lang. Object - com.
microsoft. bot. builder. BotState
- com.
Implementações
public abstract class BotState
implements PropertyManager
Define um objeto de gerenciamento de estado e automatiza a leitura e gravação de propriedades de estado associadas a uma camada de armazenamento.
Cada objeto de gerenciamento de estado define um escopo para uma camada de armazenamento. As propriedades de estado são criadas dentro de um escopo de gerenciamento de estado e o Bot Framework define esses escopos: ConversationState, UserStatee PrivateConversationState. Você pode definir escopos adicionais para o bot.
Resumo do Construtor
Construtor | Description |
---|---|
BotState(Storage withStorage, String withContextServiceKey) |
Inicializa uma nova instância da classe Estado do Bot |
Resumo do método
Modificador e tipo | Método e descrição |
---|---|
State |
<T>createProperty(String name)
Cria uma propriedade de estado nomeado dentro do escopo de um Estado do Bot |
protected java.util.concurrent.CompletableFuture<T> |
<T>getPropertyValue(TurnContext turnContext, String propertyName)
Obtém o valor de uma propriedade do cache de estado para esse Estado do Bot |
java.util.concurrent.CompletableFuture<java.lang.Void> |
clearState(TurnContext turnContext)
Limpa o cache de estado para esse Estado do Bot |
java.util.concurrent.CompletableFuture<java.lang.Void> |
delete(TurnContext turnContext)
Exclua qualquer estado armazenado no momento nesse escopo de estado. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
deletePropertyValue(TurnContext turnContext, String propertyName)
Exclui uma propriedade do cache de estado para esse Estado do Bot |
com.fasterxml.jackson.databind.JsonNode |
get(TurnContext turnContext)
Obtém uma cópia dos dados brutos armazenados em cache para esse Estado do Bot |
Cached |
getCachedState(TurnContext turnContext)
Obtém a instância de estado do bot armazenado em cache que encapsula os dados brutos armazenados em cache para esse Estado do Bot |
abstract java.lang.String |
getStorageKey(TurnContext turnContext)
Quando substituído em uma classe derivada, obtém a chave a ser usada ao ler e gravar o estado de e para o armazenamento. |
java.util.concurrent.CompletableFuture<java.lang.Void> |
load(TurnContext turnContext)
Preenche o cache de estado para esse Estado do Bot |
java.util.concurrent.CompletableFuture<java.lang.Void> |
load(TurnContext turnContext, boolean force)
Lê no objeto de estado atual e o armazena em cache no objeto de contexto para essa vez. |
java.util.concurrent.CompletableFuture<java.lang.Void> |
saveChanges(TurnContext turnContext)
Grava o cache de estado desse Estado do Bot |
java.util.concurrent.CompletableFuture<java.lang.Void> |
saveChanges(TurnContext turnContext, boolean force)
Grava o cache de estado desse Estado do Bot |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
setPropertyValue(TurnContext turnContext, String propertyName, Object value)
Define o valor de uma propriedade no cache de estado para esse Estado do Bot |
Métodos herdados de java.lang.Object
Detalhes do construtor
BotState
public BotState(Storage withStorage, String withContextServiceKey)
Inicializa uma nova instância da classe BotState.
Parameters:
Throws:
Detalhes do método
<T>createProperty
public StatePropertyAccessor
Cria uma propriedade de estado nomeado dentro do escopo de um BotState e retorna um acessador para a propriedade .
Parameters:
Returns:
Throws:
<T>getPropertyValue
protected CompletableFuture
Obtém o valor de uma propriedade do cache de estado para este BotState.
Parameters:
Returns:
clearState
public CompletableFuture
Limpa o cache de estado para este BotState.
Esse método limpa o cache de estado no contexto de turno. Chame saveChanges(TurnContext turnContext, boolean force) para persistir essa alteração na camada de armazenamento.
Parameters:
Returns:
delete
public CompletableFuture
Exclua qualquer estado armazenado no momento nesse escopo de estado.
Parameters:
Returns:
deletePropertyValue
protected CompletableFuture
Exclui uma propriedade do cache de estado para este BotState.
Parameters:
Returns:
get
public JsonNode get(TurnContext turnContext)
Obtém uma cópia dos dados brutos armazenados em cache para esse BotState do contexto de turno.
Parameters:
Returns:
getCachedState
public BotState.CachedBotState getCachedState(TurnContext turnContext)
Obtém a instância de estado do bot armazenado em cache que encapsula os dados brutos armazenados em cache para esse BotState no contexto de turno.
Parameters:
Returns:
getStorageKey
public abstract String getStorageKey(TurnContext turnContext)
Quando substituído em uma classe derivada, obtém a chave a ser usada ao ler e gravar o estado de e para o armazenamento.
Parameters:
Returns:
Throws:
load
public CompletableFuture
Preenche o cache de estado para esse BotState da camada de armazenamento.
Parameters:
Returns:
load
public CompletableFuture
Lê no objeto de estado atual e o armazena em cache no objeto de contexto para essa vez.
Parameters:
Returns:
saveChanges
public CompletableFuture
Grava o cache de estado deste BotState na camada de armazenamento.
Parameters:
Returns:
saveChanges
public CompletableFuture
Grava o cache de estado deste BotState na camada de armazenamento.
Parameters:
Returns:
setPropertyValue
protected CompletableFuture
Define o valor de uma propriedade no cache de estado para este BotState.
Parameters:
Returns: