BotStateSet class
Eine Sammlung von Plug-Ins BotState
, die parallel als einzelne Einheit geladen oder gespeichert werden sollen.
Eine Implementierung dieser Klasse finden Sie AutoSaveStateMiddleware
unter.
Konstruktoren
Bot |
Erstellt eine neue BotStateSet-Instanz. |
Eigenschaften
bot |
Array der Sets-Plug-Ins |
Methoden
add(Bot |
Registriert ein oder |
load |
Ruft |
save |
Ruft |
Details zum Konstruktor
BotStateSet(BotState[])
Erstellt eine neue BotStateSet-Instanz.
new BotStateSet(botStates: BotState[])
Parameter
- botStates
-
BotState[]
Mindestens ein zu registrierende BotState-Plug-In.
Details zur Eigenschaft
botStates
Details zur Methode
add(BotState[])
Registriert ein oder BotState
mehrere Plug-Ins bei der Gruppe.
function add(botStates: BotState[]): this
Parameter
- botStates
-
BotState[]
Mindestens ein zu registrierende BotState-Plug-In.
Gibt zurück
this
Das aktualisierte BotStateSet.
loadAll(TurnContext, boolean)
Ruft BotState.load()
alle BotState-Plug-Ins im Satz auf.
function loadAll(context: TurnContext, force?: boolean): Promise<void>
Parameter
- context
- TurnContext
Kontext für den aktuellen Gesprächsverlauf 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<void>
Hinweise
Dadurch werden alle Plug-Ins zum parallelen Lesen in ihrem Zustand ausgelöst.
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
Ruft BotState.saveChanges()
alle BotState-Plug-Ins im Satz auf.
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>
Parameter
- context
- TurnContext
Kontext für den aktuellen Gesprächsverlauf mit dem Benutzer.
- force
-
boolean
(Optional), wenn true
der Zustand unabhängig vom Änderungszustand immer ausgeschrieben wird. Wird standardmäßig auf false
festgelegt.
Gibt zurück
Promise<void>
Hinweise
Dadurch werden alle Plug-Ins ausgelöst, um ihren Zustand parallel auszuschreiben.
await stateSet.saveAllChanges(context);