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 gestão de estado e automatiza a leitura e escrita das 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 estado define um âmbito para uma camada de armazenamento.
As propriedades de estado são criadas num âmbito de gestão de estado e o Bot Framework define estes âmbitos: ConversationState, UserStatee PrivateConversationState.
Pode definir âmbitos adicionais para o bot.
Construtores
| BotState(IStorage, String) |
Inicializa uma nova instância da BotState classe. |
Métodos
| ClearStateAsync(ITurnContext, CancellationToken) |
Limpa a cache de estado para este BotState. |
| CreateProperty<T>(String) |
Cria uma propriedade de estado com nome no âmbito de um BotState e devolve um acessório para a propriedade. |
| DeleteAsync(ITurnContext, CancellationToken) |
Elimina qualquer estado no armazenamento e na cache para este BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Elimina uma propriedade da cache de estado para este BotState. |
| Get(ITurnContext) |
Obtém uma cópia dos dados em cache não processados deste BotState contexto a partir do contexto de viragem. |
| GetCachedState(ITurnContext) |
Obtém a instância de estado do bot em cache que molda os dados em cache não processados deste BotState contexto a partir do contexto de viragem. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Obtém o valor de uma propriedade da cache de estado para este BotState. |
| GetStorageKey(ITurnContext) |
Quando substituída numa classe derivada, obtém a chave a utilizar ao ler e escrever o estado de e para o armazenamento. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Preenche a cache de estado desta BotState opção a partir da camada de armazenamento. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Escreve a cache de estado para esta BotState opção na camada de armazenamento. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Define o valor de uma propriedade na cache de estado para esta BotState. |