StatePropertyAccessor interface
Definiert Methoden für den Zugriff auf eine Zustandseigenschaft, die in einem BotState-Objekt erstellt wurde.
Hinweise
Um eine Zustandseigenschaft in einem Statusverwaltungsobjekt zu erstellen, verwenden Sie die createProperty<T-Methode> .
Methoden
| delete(Turn |
Löscht die persistente Eigenschaft aus dem Sicherungsspeicherobjekt. |
| get(Turn |
Liest eine persistente Eigenschaft aus dem Sicherungsspeicherobjekt. |
| get(Turn |
|
| set(Turn |
Weist den Eigenschaften, die das Speicherobjekt sichern, einen neuen Wert zu. |
Details zur Methode
delete(TurnContext)
Löscht die persistente Eigenschaft aus dem Sicherungsspeicherobjekt.
function delete(context: TurnContext): Promise<void>Parameter
- context
- TurnContext
Kontext für den aktuellen Gesprächsverlauf mit dem Benutzer.
Gibt zurück
Promise<void>
Hinweise
Die Eigenschaften, die das Speicherobjekt sichern, sollten beim ersten Zugriff in den Arbeitsspeicher geladen werden.
await myProperty.delete(context);
get(TurnContext)
Liest eine persistente Eigenschaft aus dem Sicherungsspeicherobjekt.
function get(context: TurnContext): Promise<T | undefined>Parameter
- context
- TurnContext
Kontext für den aktuellen Gesprächsverlauf mit dem Benutzer.
Gibt zurück
Promise<T | undefined>
Hinweise
Die Eigenschaften, die das Speicherobjekt sichern, sollten beim ersten Zugriff in den Arbeitsspeicher geladen werden.
Wenn die -Eigenschaft derzeit nicht für das Speicherobjekt vorhanden ist und ein defaultValue angegeben wurde, wird ein Klon des defaultValue -Objekts in das Speicherobjekt kopiert. Wenn kein defaultValue angegeben wurde, wird ein Wert von undefined SOLLTE zurückgegeben.
const value = await myProperty.get(context, { count: 0 });
get(TurnContext, T)
function get(context: TurnContext, defaultValue: T): Promise<T>Parameter
- context
- TurnContext
- defaultValue
-
T
Gibt zurück
Promise<T>
set(TurnContext, T)
Weist den Eigenschaften, die das Speicherobjekt sichern, einen neuen Wert zu.
function set(context: TurnContext, value: T): Promise<void>Parameter
- context
- TurnContext
Kontext für den aktuellen Gesprächsverlauf mit dem Benutzer.
- value
-
T
Zuzuweisenden Wert.
Gibt zurück
Promise<void>
Hinweise
Die Eigenschaften, die das Speicherobjekt sichern, sollten beim ersten Zugriff in den Arbeitsspeicher geladen werden.
Abhängig von der Implementierung des Zustandssystems ist möglicherweise ein zusätzlicher Schritt erforderlich, um die tatsächlichen Änderungen auf dem Datenträger beizubehalten.
await myProperty.set(context, value);