BotStateSet class
Eine Sammlung von BotState Plugins, die parallel als einzelne Einheit geladen oder gespeichert werden sollen.
Eine Implementierung dieser Klasse finden Sie unter AutoSaveStateMiddleware.
Konstruktoren
| Bot |
Erstellt eine neue BotStateSet-Instanz. |
Eigenschaften
| bot |
Array der Sets |
Methoden
| add(Bot |
Registriert ein oder mehrere |
| load |
Ruft |
| save |
Ruft |
Details zum Konstruktor
BotStateSet(BotState[])
Erstellt eine neue BotStateSet-Instanz.
new BotStateSet(botStates: BotState[])Parameter
- botStates
-
BotState[]
Mindestens ein BotState-Plug-In zur Registrierung.
Details zur Eigenschaft
botStates
Details zur Methode
add(BotState[])
Registriert ein oder mehrere BotState Plug-Ins mit dem Satz.
function add(botStates: BotState[]): thisParameter
- botStates
-
BotState[]
Mindestens ein BotState-Plug-In zur Registrierung.
Gibt zurück
this
Das aktualisierte BotStateSet.
loadAll(TurnContext, boolean)
Ruft BotState.load() für alle BotState-Plug-Ins im Satz auf.
function loadAll(context: TurnContext, force?: boolean): Promise<void>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- force
-
boolean
(Optional) Wenn true der Cache umgangen wird und der Zustand immer direkt aus dem Speicher gelesen wird. Standardmäßig wird false.
Gibt zurück
Promise<void>
Hinweise
Dadurch werden alle Plug-Ins parallel in ihrem Zustand gelesen.
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
Ruft BotState.saveChanges() für alle BotState-Plug-Ins im Satz auf.
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- force
-
boolean
(Optional) wenn true der Zustand unabhängig vom Änderungszustand immer ausgeschrieben wird. Standardmäßig wird false.
Gibt zurück
Promise<void>
Hinweise
Dadurch werden alle Plug-Ins ausgelöst, um ihren Zustand parallel zu schreiben.
await stateSet.saveAllChanges(context);