Compartilhar via

BotState Classe

  • Referência

Definição

Namespace:
Microsoft.Bot.Builder
Assembly:
Microsoft.Bot.Builder.dll
Pacote:
Microsoft.Bot.Builder v4.22.7

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.IPropertyManager
type BotState = class
    interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
Herança
Object
BotState
Derivado
Implementações
IPropertyManager

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 esses escopos: ConversationState, UserStatee PrivateConversationState.

Você pode definir escopos adicionais para o bot.

Construtores

BotState(IStorage, String)

Inicializa uma nova instância da classe BotState.

Métodos

ClearStateAsync(ITurnContext, CancellationToken)

Limpa o cache de estado para este BotState.
CreateProperty<T>(String)

Cria uma propriedade de estado nomeado dentro do escopo de um BotState e retorna um acessador para a propriedade .
DeleteAsync(ITurnContext, CancellationToken)

Exclui qualquer estado no armazenamento e o cache para este BotState.
DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

Exclui uma propriedade do cache de estado para este BotState.
Get(ITurnContext)

Obtém uma cópia dos dados brutos armazenados em cache para isso BotState no contexto de turno.
GetCachedState(ITurnContext)

Obtém a instância de estado do bot armazenado em cache que encapsula os dados brutos armazenados em cache para isso BotState no contexto de turno.
GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)

Obtém o valor de uma propriedade do cache de estado 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 da camada de armazenamento.
SaveChangesAsync(ITurnContext, Boolean, CancellationToken)

Grava o cache de estado para isso BotState na camada de armazenamento.
SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)

Define o valor de uma propriedade no cache de estado para este BotState.

Aplica-se a

Confira também