BotState class

Paket:

botbuilder-core

Basisklasse für die Frameworks-Zustandsharrlichkeitsbereiche.

Hinweise

Diese Klasse liest und schreibt den Zustand für jede Konversation mit einem Benutzer an einen bereitgestellten Speicheranbieter. Abgeleitete Klassen wie ConversationState und UserStatestellen eine StorageKeyFactory bereit, die verwendet wird, um den Schlüssel zu bestimmen, der zum Beibehalten eines bestimmten Speicherobjekts verwendet wird.

Das geladene Zustandsobjekt wird für die Lebensdauer des Turns automatisch im Kontextobjekt zwischengespeichert und nur in den Speicher geschrieben, wenn es geändert wurde.

Konstruktoren

BotState(Storage, StorageKeyFactory)

Erstellt eine neue BotState-Instanz.

Methoden

clear(TurnContext)	Löscht das aktuelle Zustandsobjekt für einen Turn.
createProperty<T>(string)	Erstellt einen neuen Eigenschaftsaccessor zum Lesen und Schreiben einer einzelnen Eigenschaft in das Botstatusspeicherobjekt.
delete(TurnContext)	Löschen Sie das Sicherungszustandsobjekt für den aktuellen Turn.
get(TurnContext)	Gibt ein zwischengespeichertes Zustandsobjekt oder ein nicht definiertes, wenn nicht zwischengespeichertes Objekt zurück.
load(TurnContext, boolean)	Liest das Sicherungszustandsobjekt für einen Turn ein und speichert es zwischen.
saveChanges(TurnContext, boolean)	Speichert das zwischengespeicherte Zustandsobjekt, wenn es geändert wurde.

Details zum Konstruktor

BotState(Storage, StorageKeyFactory)

Erstellt eine neue BotState-Instanz.

new BotState(storage: Storage, storageKey: StorageKeyFactory)

Parameter

storage

Storage

Speicheranbieter, in dem das Zustandsobjekt beibehalten werden soll.

storageKey

StorageKeyFactory

Die Funktion wird immer aufgerufen, wenn der Speicherschlüssel für einen bestimmten Turn berechnet werden muss.

Details zur Methode

clear(TurnContext)

Löscht das aktuelle Zustandsobjekt für einen Turn.

function clear(context: TurnContext): Promise<void>

Parameter

context

TurnContext

Kontext für den aktuellen Gesprächswechsel mit dem Benutzer.

Gibt zurück

Promise<void>

Eine Zusage, die den asynchronen Vorgang darstellt.

Hinweise

Das gelöschte Zustandsobjekt wird erst beibehalten, wenn saveChanges() aufgerufen wurde.

await botState.clear(context);
await botState.saveChanges(context);

createProperty<T>(string)

Erstellt einen neuen Eigenschaftsaccessor zum Lesen und Schreiben einer einzelnen Eigenschaft in das Botstatusspeicherobjekt.

function createProperty<T>(name: string): StatePropertyAccessor<T>

Parameter

name

string

Name der hinzuzufügenden Eigenschaft.

Gibt zurück

StatePropertyAccessor<T>

Ein Accessor für die Eigenschaft.

delete(TurnContext)

Löschen Sie das Sicherungszustandsobjekt für den aktuellen Turn.

function delete(context: TurnContext): Promise<void>

Parameter

context

TurnContext

Kontext für den aktuellen Gesprächswechsel mit dem Benutzer.

Gibt zurück

Promise<void>

Eine Zusage, die den asynchronen Vorgang darstellt.

Hinweise

Das Zustandsobjekt wird aus dem Speicher entfernt, sofern vorhanden. Wenn das Zustandsobjekt gelesen und zwischengespeichert wurde, wird der Cache gelöscht.

await botState.delete(context);

get(TurnContext)

Gibt ein zwischengespeichertes Zustandsobjekt oder ein nicht definiertes, wenn nicht zwischengespeichertes Objekt zurück.

function get(context: TurnContext): any | undefined

Parameter

context

TurnContext

Kontext für den aktuellen Gesprächswechsel mit dem Benutzer.

Gibt zurück

any | undefined

Ein zwischengespeichertes Zustandsobjekt oder undefiniert, wenn nicht zwischengespeichert.

Hinweise

In diesem Beispiel wird gezeigt, wie Ein bereits geladenes und zwischengespeichertes Zustandsobjekt synchron abgerufen wird:

const state = botState.get(context);

load(TurnContext, boolean)

Liest das Sicherungszustandsobjekt für einen Turn ein und speichert es zwischen.

function load(context: TurnContext, force?: boolean): Promise<any>

Parameter

context

TurnContext

Kontext für den aktuellen Gesprächswechsel mit dem Benutzer.

force

boolean

(Optional) Wenn true der Cache umgangen wird und der Zustand immer direkt aus dem Speicher eingelesen wird. Wird standardmäßig auf false festgelegt.

Gibt zurück

Promise<any>

Der zwischengespeicherte Zustand.

Hinweise

Nachfolgende Lesevorgänge geben das zwischengespeicherte Objekt zurück, es sei denn, das force Flag wird übergeben, wodurch das erneute Lesen des Zustandsobjekts erzwungen wird.

Diese Methode wird automatisch beim ersten Zugriff eines der erstellten Eigenschaftsaccessoren aufgerufen.

const state = await botState.load(context);

saveChanges(TurnContext, boolean)

Speichert das zwischengespeicherte Zustandsobjekt, wenn es geändert wurde.

function saveChanges(context: TurnContext, force?: boolean): Promise<void>

Parameter

context

TurnContext

Kontext für den aktuellen Gesprächswechsel mit dem Benutzer.

force

boolean

(Optional) , wenn true der Zustand unabhängig von seinem Änderungszustand immer ausgeschrieben wird. Wird standardmäßig auf false festgelegt.

Gibt zurück

Promise<void>

Eine Zusage, die den asynchronen Vorgang darstellt.

Hinweise

Wenn das force Flag im zwischengespeicherten Zustandsobjekt übergeben wird, wird unabhängig davon gespeichert, ob es geändert wurde oder nicht, und wenn kein Objekt zwischengespeichert wurde, wird ein leeres Objekt erstellt und dann gespeichert.

await botState.saveChanges(context);