BotState Klasse

Definition

Definiert ein Zustandsverwaltungsobjekt und automatisiert das Lesen und Schreiben zugeordneter Zustandseigenschaften in einer Speicherebene.

public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager
type BotState = class
    interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
Vererbung
BotState
Abgeleitet
Implementiert

Hinweise

Jedes Zustandsverwaltungsobjekt definiert einen Bereich für eine Speicherebene.

Zustandseigenschaften werden innerhalb eines Zustandsverwaltungsbereichs erstellt, und das Bot Framework definiert die folgenden Bereiche: ConversationState, UserStateund PrivateConversationState.

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

Konstruktoren

BotState(IStorage, String)

Initialisiert eine neue Instanz der BotState-Klasse.

Methoden

ClearStateAsync(ITurnContext, CancellationToken)

Löscht den Zustandscache für diesen BotState.

CreateProperty<T>(String)

Erstellt eine benannte Zustandseigenschaft im Bereich von und BotState gibt einen Accessor für die Eigenschaft zurück.

DeleteAsync(ITurnContext, CancellationToken)

Löscht jeden Zustand im Speicher und im Cache für diesen BotState.

DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

Löscht eine Eigenschaft aus dem Zustandscache für dieses BotState.

Get(ITurnContext)

Ruft eine Kopie der roh zwischengespeicherten Daten dafür BotState aus dem Turnkontext ab.

GetCachedState(ITurnContext)

Ruft die zwischengespeicherte Botzustandsinstanz ab, die die rohen zwischengespeicherten Daten dafür BotState aus dem turn-Kontext umschließt.

GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)

Ruft den Wert einer Eigenschaft aus dem Zustandscache für diesen BotStateab.

GetStorageKey(ITurnContext)

Ruft beim Überschreiben in einer abgeleiteten Klasse den Schlüssel ab, der beim Lesen und Schreiben des Zustands in und aus dem Speicher verwendet werden soll.

LoadAsync(ITurnContext, Boolean, CancellationToken)

Füllt den Zustandscache dafür BotState aus der Speicherebene auf.

SaveChangesAsync(ITurnContext, Boolean, CancellationToken)

Schreibt den Zustandscache dafür in BotState die Speicherebene.

SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)

Legt den Wert einer Eigenschaft im Zustandscache für dieses BotStatefest.

Gilt für:

Weitere Informationen