Dela via


BotState Klass

Definition

Definierar ett tillståndshanteringsobjekt och automatiserar läsning och skrivning av associerade tillståndsegenskaper till ett lagringslager.

public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager
type BotState = class
    interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
Arv
BotState
Härledda
Implementeringar

Kommentarer

Varje tillståndshanteringsobjekt definierar ett omfång för ett lagringslager.

Tillståndsegenskaper skapas inom ett tillståndshanteringsomfång och Bot Framework definierar dessa omfång: ConversationState, UserStateoch PrivateConversationState.

Du kan definiera ytterligare omfång för din robot.

Konstruktorer

BotState(IStorage, String)

Initierar en ny instans av BotState klassen.

Metoder

ClearStateAsync(ITurnContext, CancellationToken)

Rensar tillståndscacheminnet för den här BotState.

CreateProperty<T>(String)

Skapar en namngiven tillståndsegenskap inom omfånget för en BotState och returnerar en accessor för egenskapen.

DeleteAsync(ITurnContext, CancellationToken)

Tar bort alla tillstånd i lagringen och cacheminnet för den här BotState.

DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

Tar bort en egenskap från tillståndscacheminnet för den här BotState.

Get(ITurnContext)

Hämtar en kopia av rådata för detta BotState från turkontexten.

GetCachedState(ITurnContext)

Hämtar den cachelagrade robottillståndsinstansen som omsluter rådata för detta BotState från turkontexten.

GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)

Hämtar värdet för en egenskap från tillståndscacheminnet för den här BotState.

GetStorageKey(ITurnContext)

När den åsidosättas i en härledd klass hämtar den nyckel som ska användas vid läsning och skrivning till och från lagring.

LoadAsync(ITurnContext, Boolean, CancellationToken)

Fyller i tillståndscacheminnet för detta BotState från lagringsskiktet.

SaveChangesAsync(ITurnContext, Boolean, CancellationToken)

Skriver tillståndscacheminnet för detta BotState till lagringsskiktet.

SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)

Anger värdet för en egenskap i tillståndscacheminnet för den här BotState.

Gäller för

Se även