BotState Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Define um objeto de gerenciamento de estado e automatiza a leitura e gravação de propriedades de estado associadas a uma camada de armazenamento.
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManagertype BotState = class
interface IPropertyManagerPublic MustInherit Class BotState
Implements IPropertyManager- Herança
-
BotState
- Derivado
- Implementações
Comentários
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 estes escopos: ConversationState, UserStatee PrivateConversationState.
Você pode definir escopos adicionais para o bot.
Construtores
| Nome | Description |
|---|---|
| BotState(IStorage, String) |
Inicializa uma nova instância da classe BotState. |
Métodos
| Nome | Description |
|---|---|
| ClearStateAsync(ITurnContext, CancellationToken) |
Limpa o cache de estado para esse BotState. |
| CreateProperty<T>(String) |
Cria uma propriedade de estado nomeado dentro do escopo de um BotState e retorna um acessório para a propriedade. |
| DeleteAsync(ITurnContext, CancellationToken) |
Exclui qualquer estado no armazenamento e o cache para isso BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Exclui uma propriedade do cache de estados para esse BotState. |
| Get(ITurnContext) |
Obtém uma cópia dos dados brutos em cache disso BotState a partir do contexto do turno. |
| GetCachedState(ITurnContext) |
Obtém a instância de estado do bot em cache que envolve os dados brutos em cache para isso BotState a partir do contexto do turno. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Obtém o valor de uma propriedade do cache de estados para este BotState. |
| GetStorageKey(ITurnContext) |
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. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Preenche o cache de estado para isso BotState a partir da camada de armazenamento. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Grava o cache de estado disso BotState na camada de armazenamento. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Define o valor de uma propriedade no cache de estados para este BotState. |