BotState Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Définit un objet de gestion d’état et automatise la lecture et l’écriture des propriétés d’état associées dans une couche de stockage.
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManagertype BotState = class
interface IPropertyManagerPublic MustInherit Class BotState
Implements IPropertyManager- Héritage
-
BotState
- Dérivé
- Implémente
Remarques
Chaque objet de gestion d’état définit une étendue pour une couche de stockage.
Les propriétés d’état sont créées dans une étendue de gestion d’état, et bot Framework définit ces étendues : ConversationState, UserStateet PrivateConversationState.
Vous pouvez définir des étendues supplémentaires pour votre bot.
Constructeurs
| BotState(IStorage, String) |
Initialise une nouvelle instance de la classe BotState. |
Méthodes
| ClearStateAsync(ITurnContext, CancellationToken) |
Efface le cache d’état pour ce BotState. |
| CreateProperty<T>(String) |
Crée une propriété d’état nommée dans l’étendue d’un BotState et retourne un accesseur pour la propriété. |
| DeleteAsync(ITurnContext, CancellationToken) |
Supprime n’importe quel état dans le stockage et le cache pour ce BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Supprime une propriété du cache d’état pour ce BotState. |
| Get(ITurnContext) |
Obtient une copie des données brutes mises en cache pour cela BotState à partir du contexte de tour. |
| GetCachedState(ITurnContext) |
Obtient l’instance d’état du bot mis en cache qui encapsule les données brutes mises en cache pour cela BotState à partir du contexte de tour. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Obtient la valeur d’une propriété à partir du cache d’état pour ce BotState. |
| GetStorageKey(ITurnContext) |
En cas de substitution dans une classe dérivée, obtient la clé à utiliser lors de la lecture et de l’écriture de l’état vers et à partir du stockage. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Remplit le cache d’état pour cela BotState à partir de la couche de stockage. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Écrit le cache d’état pour cela BotState dans la couche de stockage. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Définit la valeur d’une propriété dans le cache d’état pour ce BotState. |