BotState Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Define um objeto de gerenciamento de estado e automatiza a leitura e a 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
Observações
Cada objeto de gestão de estados define um âmbito para uma camada de armazenamento.
As propriedades de estado são criadas dentro de um âmbito de gestão de estado, e o Bot Framework define estes âmbitos: ConversationState, UserState, e PrivateConversationState.
Pode definir escopos adicionais para o seu bot.
Construtores
| Name | Descrição |
|---|---|
| BotState(IStorage, String) |
Inicializa uma nova instância da BotState classe. |
Métodos
| Name | Descrição |
|---|---|
| ClearStateAsync(ITurnContext, CancellationToken) |
Limpa a cache de estado para isto BotState. |
| CreateProperty<T>(String) |
Cria uma propriedade de estado nomeada dentro do âmbito de um BotState e devolve um acessório para a propriedade. |
| DeleteAsync(ITurnContext, CancellationToken) |
Apaga qualquer estado no armazenamento e a cache para isto BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Apaga uma propriedade da cache de estados para este BotState. |
| Get(ITurnContext) |
Obtém uma cópia dos dados brutos em cache disto 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 isto BotState a partir do contexto do turn. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Obtém o valor de uma propriedade a partir da cache de estados para este BotState. |
| GetStorageKey(ITurnContext) |
Quando sobrescrito numa classe derivada, obtém a chave para usar ao ler e escrever estado para e a partir do armazenamento. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Preenche a cache de estado para isto BotState a partir da camada de armazenamento. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Escreve a cache de estado disto BotState na camada de armazenamento. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Define o valor de uma propriedade na cache de estados para este BotState. |