StatePropertyAccessor interface
Définit des méthodes pour accéder à une propriété d’état créée dans un objet BotState .
Remarques
Pour créer une propriété d’état dans un objet de gestion d’état, utilisez la méthode T> createProperty<.
Méthodes
| delete(Turn |
Supprime la propriété persistante de son objet de stockage de stockage de stockage. |
| get(Turn |
Lit une propriété persistante à partir de son objet de stockage de stockage de stockage. |
| get(Turn |
|
| set(Turn |
Affecte une nouvelle valeur aux propriétés qui sauvegardent l’objet de stockage. |
Détails de la méthode
delete(TurnContext)
Supprime la propriété persistante de son objet de stockage de stockage de stockage.
function delete(context: TurnContext): Promise<void>Paramètres
- context
- TurnContext
Contexte de la conversation actuelle avec l’utilisateur.
Retours
Promise<void>
Remarques
Les propriétés qui sauvegardent l’objet de stockage DOIVENT être chargées en mémoire lors du premier accès.
await myProperty.delete(context);
get(TurnContext)
Lit une propriété persistante à partir de son objet de stockage de stockage de stockage.
function get(context: TurnContext): Promise<T | undefined>Paramètres
- context
- TurnContext
Contexte de la conversation actuelle avec l’utilisateur.
Retours
Promise<T | undefined>
Remarques
Les propriétés qui sauvegardent l’objet de stockage DOIVENT être chargées en mémoire lors du premier accès.
Si la propriété n’existe pas actuellement sur l’objet de stockage et qu’un defaultValue a été spécifié, un clone du defaultValue doit être copié dans l’objet de stockage. Si un defaultValue n’a pas été spécifié, la valeur undefined DOIT être retournée.
const value = await myProperty.get(context, { count: 0 });
get(TurnContext, T)
function get(context: TurnContext, defaultValue: T): Promise<T>Paramètres
- context
- TurnContext
- defaultValue
-
T
Retours
Promise<T>
set(TurnContext, T)
Affecte une nouvelle valeur aux propriétés qui sauvegardent l’objet de stockage.
function set(context: TurnContext, value: T): Promise<void>Paramètres
- context
- TurnContext
Contexte de la conversation actuelle avec l’utilisateur.
- value
-
T
Valeur à affecter.
Retours
Promise<void>
Remarques
Les propriétés qui sauvegardent l’objet de stockage DOIVENT être chargées en mémoire lors du premier accès.
Selon l’implémentation des systèmes d’état, une étape supplémentaire peut être nécessaire pour conserver les modifications réelles apportées au disque.
await myProperty.set(context, value);