BotState Klasse

Definition

Definiert ein Zustands Verwaltungs Objekt und automatisiert das Lesen und Schreiben von zugeordneten Zustands Eigenschaften zu einer Speicher Ebene.Defines a state management object and automates the reading and writing of associated state properties to a storage layer.

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 Zustands Verwaltungs Objekt definiert einen Bereich für eine Speicher Ebene.Each state management object defines a scope for a storage layer.

Zustands Eigenschaften werden innerhalb eines Zustands Verwaltungsbereichs erstellt, und das bot Framework definiert diese Bereiche: ConversationState , UserState und PrivateConversationState .State properties are created within a state management scope, and the Bot Framework defines these scopes: ConversationState, UserState, and PrivateConversationState.

Sie können zusätzliche Bereiche für den bot definieren.You can define additional scopes for your bot.

Konstruktoren

BotState(IStorage, String)

Initialisiert eine neue Instanz der BotState-Klasse.Initializes a new instance of the BotState class.

Methoden

ClearStateAsync(ITurnContext, CancellationToken)

Löscht den Zustands Cache für dieses BotState .Clears the state cache for this BotState.

CreateProperty<T>(String)

Erstellt eine benannte Zustands Eigenschaft innerhalb des Gültigkeits Bereichs eines BotState und gibt einen Accessor für die Eigenschaft zurück.Creates a named state property within the scope of a BotState and returns an accessor for the property.

DeleteAsync(ITurnContext, CancellationToken)

Löscht einen beliebigen Zustand im Speicher und den Cache für diesen BotState .Deletes any state in storage and the cache for this BotState.

DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

Löscht eine Eigenschaft aus dem Zustands Cache für diesen BotState .Deletes a property from the state cache for this BotState.

Get(ITurnContext)

Ruft eine Kopie der unformatierten zwischengespeicherten Daten für dieses BotState aus dem Turn-Kontext ab.Gets a copy of the raw cached data for this BotState from the turn context.

GetCachedState(ITurnContext)

Ruft die zwischengespeicherte botstatusinstanz ab, die die unformatierten zwischengespeicherten Daten für dieses BotState aus dem Kontext umschließt.Gets the cached bot state instance that wraps the raw cached data for this BotState from the turn context.

GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)

Ruft den Wert einer Eigenschaft aus dem Zustands Cache für dieses ab BotState .Gets the value of a property from the state cache for this BotState.

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.When overridden in a derived class, gets the key to use when reading and writing state to and from storage.

LoadAsync(ITurnContext, Boolean, CancellationToken)

Füllt den Zustands Cache für diesen auf BotState der Speicher Ebene auf.Populates the state cache for this BotState from the storage layer.

SaveChangesAsync(ITurnContext, Boolean, CancellationToken)

Schreibt den Zustands Cache für diesen BotState in die Speicher Ebene.Writes the state cache for this BotState to the storage layer.

SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)

Legt den Wert einer Eigenschaft im Zustands Cache für dieses fest BotState .Sets the value of a property in the state cache for this BotState.

Gilt für:

Weitere Informationen