BotState Klasse

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Paket:: Microsoft.Bot.Builder v4.22.7

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Definiert ein Zustandsverwaltungsobjekt und automatisiert das Lesen und Schreiben von zugeordneten Zustandseigenschaften in eine Speicherebene.

public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager

type BotState = class
    interface IPropertyManager

Public MustInherit Class BotState
Implements IPropertyManager

Vererbung: Object
BotState

Abgeleitet: Microsoft.Bot.Builder.ConversationState

Microsoft.Bot.Builder.InspectionState

Microsoft.Bot.Builder.PrivateConversationState

Microsoft.Bot.Builder.UserState

Implementiert: IPropertyManager

Hinweise

Jedes Zustandsverwaltungsobjekt definiert einen Bereich für eine Speicherebene.

Statuseigenschaften werden in einem Zustandsverwaltungsbereich erstellt, und das Bot Framework definiert die folgenden Bereiche: ConversationState, UserStateund PrivateConversationState.

Sie können zusätzliche Bereiche für Ihren Bot definieren.

Konstruktoren

Name	Beschreibung
BotState(IStorage, String)	Initialisiert eine neue Instanz der BotState-Klasse.

Methoden

Name	Beschreibung
ClearStateAsync(ITurnContext, CancellationToken)	Löscht den Zustandscache für dieses .BotState
CreateProperty<T>(String)	Erstellt eine benannte Staatseigenschaft im Anwendungsbereich von a BotState und gibt einen Accessor für die Eigenschaft zurück.
DeleteAsync(ITurnContext, CancellationToken)	Löscht jeglichen Zustand im Speicher und den Cache dafür BotState.
DeletePropertyValueAsync(ITurnContext, String, CancellationToken)	Löscht eine Eigenschaft aus dem Zustandscache für dieses .BotState
Get(ITurnContext)	Erhält eine Kopie der rohen zwischengespeicherten Daten BotState aus dem Zugkontext.
GetCachedState(ITurnContext)	Erhält die zwischengespeicherte Bot-Zustandsinstanz, die die rohen zwischengespeicherten Daten BotState aus dem Turn-Kontext umwickelt.
GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)	Erhält den Wert einer Eigenschaft aus dem Zustandscache für dieses BotState.
GetStorageKey(ITurnContext)	Wenn sie in einer abgeleiteten Klasse überschrieben werden, ruft den Schlüssel ab, der beim Lesen und Schreiben des Zustands in und vom Speicher verwendet werden soll.
LoadAsync(ITurnContext, Boolean, CancellationToken)	Füllt den Zustandscache dafür BotState aus der Speicherschicht.
SaveChangesAsync(ITurnContext, Boolean, CancellationToken)	Schreibt den Zustandscache dafür BotState in die Speicherschicht.
SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)	Setzt den Wert einer Eigenschaft im Zustandscache für dieses BotState.

Gilt für: