BotState Osztály

Definíció

Definiál egy állapotkezelési objektumot, és automatizálja a társított állapottulajdonságok olvasását és írását egy tárolási rétegbe.

public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager
type BotState = class
    interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
Öröklődés
BotState
Származtatott
Megvalósítás

Megjegyzések

Minden állapotkezelési objektum meghatároz egy tárolóréteg hatókörét.

Az állapottulajdonságok egy állapotkezelési hatókörben jönnek létre, és a Bot Framework a következő hatóköröket definiálja: ConversationState, UserState, és PrivateConversationState.

A robothoz további hatóköröket is megadhat.

Konstruktorok

BotState(IStorage, String)

Inicializálja a osztály új példányát BotState .

Metódusok

ClearStateAsync(ITurnContext, CancellationToken)

Törli az állapot-gyorsítótárat ehhez a BotStateelemhez.

CreateProperty<T>(String)

Létrehoz egy elnevezett állapottulajdonságot egy hatókörben BotState , és visszaadja a tulajdonság egy tartozékát.

DeleteAsync(ITurnContext, CancellationToken)

Törli a tárolóban lévő összes állapotot és a gyorsítótárat ehhez BotStatea fájlhoz.

DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

Töröl egy tulajdonságot a(z) állapot-gyorsítótárából.BotState

Get(ITurnContext)

Lekéri a nyers gyorsítótárazott adatok BotState másolatát a turn környezetből.

GetCachedState(ITurnContext)

Lekéri a gyorsítótárazott robotállapot-példányt, amely a nyers gyorsítótárazott adatokat BotState a turn környezetből burkolja.

GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)

Lekéri egy tulajdonság értékét az állapot-gyorsítótárból ehhez a BotStateelemhez.

GetStorageKey(ITurnContext)

Ha felülbírált egy származtatott osztályban, lekéri a tárolóba és a tárolóból történő állapotolvasáshoz és -íráshoz használandó kulcsot.

LoadAsync(ITurnContext, Boolean, CancellationToken)

Feltölti ehhez az állapot-gyorsítótárat BotState a tárolási rétegből.

SaveChangesAsync(ITurnContext, Boolean, CancellationToken)

Ennek állapot-gyorsítótárát BotState a tárolási rétegbe írja.

SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)

Beállítja egy tulajdonság értékét az állapot-gyorsítótárban ehhez a BotStateelemhez.

A következőre érvényes:

Lásd még