Sdílet prostřednictvím


BotState Třída

Definice

Definuje objekt správy stavu a automatizuje čtení a zápis přidružených vlastností stavu do vrstvy úložiště.

public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager
type BotState = class
    interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
Dědičnost
BotState
Odvozené
Implementuje

Poznámky

Každý objekt správy stavu definuje obor vrstvy úložiště.

Vlastnosti stavu se vytvářejí v rámci oboru správy stavu a bot Framework definuje tyto obory: ConversationState, UserStatea PrivateConversationState.

Pro robota můžete definovat další obory.

Konstruktory

BotState(IStorage, String)

Inicializuje novou instanci BotState třídy .

Metody

ClearStateAsync(ITurnContext, CancellationToken)

Vymaže mezipaměť stavu pro tento BotState.

CreateProperty<T>(String)

Vytvoří pojmenovanou vlastnost stavu v rámci oboru BotState a vrátí přístup pro vlastnost.

DeleteAsync(ITurnContext, CancellationToken)

Odstraní všechny stavy v úložišti a mezipaměti pro tento BotStateobjekt .

DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

Odstraní vlastnost z mezipaměti stavu pro tento BotStateobjekt .

Get(ITurnContext)

Získá kopii nezpracovaných dat uložených v mezipaměti z BotState kontextu turn.

GetCachedState(ITurnContext)

Získá instanci stavu robota v mezipaměti, která zabalí nezpracovaná data uložená v mezipaměti z BotState kontextu turn.

GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)

Získá hodnotu vlastnosti z mezipaměti stavu pro tento BotStateobjekt .

GetStorageKey(ITurnContext)

Při přepsání v odvozené třídě získá klíč, který se má použít při čtení a zápisu stavu do a z úložiště.

LoadAsync(ITurnContext, Boolean, CancellationToken)

Naplní mezipaměť stavu z BotState vrstvy úložiště.

SaveChangesAsync(ITurnContext, Boolean, CancellationToken)

Zapíše stavové mezipaměti do BotState vrstvy úložiště.

SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)

Nastaví hodnotu vlastnosti v mezipaměti stavu pro tento BotStateobjekt .

Platí pro

Viz také