StatePropertyAccessor interface
Definiert Methoden für den Zugriff auf eine Zustandseigenschaft, die in einem BotState -Objekt erstellt wurde.
Hinweise
Verwenden Sie zum Erstellen einer Statuseigenschaft in einem Statusverwaltungsobjekt die createProperty<T>-Methode.
Methoden
| delete(Turn |
Löscht die beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt. |
| get(Turn |
Liest eine beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt. |
| get(Turn |
|
| set(Turn |
Weist den Eigenschaften, die das Speicherobjekt sichern, einen neuen Wert zu. |
Details zur Methode
delete(TurnContext)
Löscht die beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt.
function delete(context: TurnContext): Promise<void>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende 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 beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt.
function get(context: TurnContext): Promise<T | undefined>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende 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 für das Speicherobjekt nicht vorhanden ist und ein defaultValue angegeben wurde, wird ein Klon der defaultValue SOLLTE in das Speicherobjekt kopiert werden. Wenn kein defaultValue angegeben wurde, wird ein Wert von undefined SOLLTE zurückgegeben werden.
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 die aktuelle Unterhaltungswende mit dem Benutzer.
- value
-
T
Wert, der zugewiesen werden soll.
Gibt zurück
Promise<void>
Hinweise
Die Eigenschaften, die das Speicherobjekt sichern, SOLLTEN beim ersten Zugriff in den Arbeitsspeicher geladen werden.
Je nach Implementierung der Zustandssysteme ist möglicherweise ein zusätzlicher Schritt erforderlich, um die tatsächlichen Änderungen auf dem Datenträger beizubehalten.
await myProperty.set(context, value);