BotState Classe

  • Référence
Paquet:
com.microsoft.bot.builder
Artefact Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.BotState

Implémente

PropertyManager

public abstract class BotState
implements PropertyManager

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.

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.

Récapitulatif du constructeur

Constructeur Description
BotState(Storage withStorage, String withContextServiceKey)

Initialise une nouvelle instance de la classe BotState.

Résumé de la méthode

Modificateur et type Méthode et description
StatePropertyAccessor<T> <T>createProperty(String name)

Crée une propriété d’état nommé dans l’étendue d’un botÉtat et retourne un accesseur pour la propriété.
protected java.util.concurrent.CompletableFuture<T> <T>getPropertyValue(TurnContext turnContext, String propertyName)

Obtient la valeur d’une propriété à partir du cache d’état de ce BotState.
java.util.concurrent.CompletableFuture<java.lang.Void> clearState(TurnContext turnContext)

Efface le cache d’état pour cet étatBot.
java.util.concurrent.CompletableFuture<java.lang.Void> delete(TurnContext turnContext)

Supprimez n’importe quel état actuellement stocké dans cette étendue d’état.
protected java.util.concurrent.CompletableFuture<java.lang.Void> deletePropertyValue(TurnContext turnContext, String propertyName)

Supprime une propriété du cache d’état de ce BotState.
com.fasterxml.jackson.databind.JsonNode get(TurnContext turnContext)

Obtient une copie des données mises en cache brutes pour cet étatBot à partir du contexte de tour.
CachedBotState getCachedState(TurnContext turnContext)

Obtient l’instance d’état du bot mis en cache qui encapsule les données mises en cache brutes pour ce bot'état à partir du contexte de tour.
abstract java.lang.String getStorageKey(TurnContext turnContext)

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 dans et depuis le stockage.
java.util.concurrent.CompletableFuture<java.lang.Void> load(TurnContext turnContext)

Remplit le cache d’état de ce botÉtat à partir de la couche de stockage.
java.util.concurrent.CompletableFuture<java.lang.Void> load(TurnContext turnContext, boolean force)

Lit dans l’objet d’état actuel et le met en cache dans l’objet de contexte pour ce tour.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(TurnContext turnContext)

Écrit le cache d’état de ce botÉtat dans la couche de stockage.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(TurnContext turnContext, boolean force)

Écrit le cache d’état de ce botÉtat dans la couche de stockage.
protected java.util.concurrent.CompletableFuture<java.lang.Void> setPropertyValue(TurnContext turnContext, String propertyName, Object value)

Définit la valeur d’une propriété dans le cache d’état de ce BotState.

Méthodes héritées de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Détails du constructeur

BotState

public BotState(Storage withStorage, String withContextServiceKey)

Initialise une nouvelle instance de la classe BotState.

Paramètres:

withStorage - Fournisseur de stockage à utiliser.
withContextServiceKey - Clé du cache d’état pour ce BotState.

Exception:

java.lang.IllegalArgumentException - Arguments de clé de service null ou stockage vide.

Détails de la méthode

<T>createProperty

public StatePropertyAccessor createProperty(String name)

Crée une propriété d’état nommé dans l’étendue d’un BotState et retourne un accesseur pour la propriété.

Paramètres:

name - nom de la propriété.

Retours:

Une StatePropertyAccessor<T> pour la propriété.

Exception:

java.lang.IllegalArgumentException - Nom vide

<T>getPropertyValue

protected CompletableFuture getPropertyValue(TurnContext turnContext, String propertyName)

Obtient la valeur d’une propriété à partir du cache d’état de ce BotState.

Paramètres:

turnContext - Objet de contexte pour ce tour.
propertyName - Nom de la propriété à obtenir.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. Si la tâche réussit, le résultat contient la valeur de la propriété.

clearState

public CompletableFuture clearState(TurnContext turnContext)

Efface le cache d’état de ce BotState.

Cette méthode efface le cache d’état dans le contexte de tour. Appelez saveChanges(TurnContext turnContext, boolean force) pour conserver cette modification dans la couche de stockage.

Paramètres:

turnContext - Objet de contexte pour ce tour.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

delete

public CompletableFuture delete(TurnContext turnContext)

Supprimez n’importe quel état actuellement stocké dans cette étendue d’état.

Paramètres:

turnContext - Objet de contexte pour ce tour.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

deletePropertyValue

protected CompletableFuture deletePropertyValue(TurnContext turnContext, String propertyName)

Supprime une propriété du cache d’état pour ce BotState.

Paramètres:

turnContext - Objet de contexte pour ce tour.
propertyName - Nom de la propriété à supprimer.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

get

public JsonNode get(TurnContext turnContext)

Obtient une copie des données mises en cache brutes pour ce BotState à partir du contexte de tour.

Paramètres:

turnContext - Objet de contexte pour ce tour.

Retours:

Représentation JSON de l’état mis en cache.

getCachedState

public BotState.CachedBotState getCachedState(TurnContext turnContext)

Obtient l’instance d’état du bot mis en cache qui encapsule les données mises en cache brutes pour ce BotState à partir du contexte de tour.

Paramètres:

turnContext - Objet de contexte pour ce tour.

Retours:

Instance d’état du bot mis en cache.

getStorageKey

public abstract String getStorageKey(TurnContext turnContext)

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 dans et depuis le stockage.

Paramètres:

turnContext - Objet de contexte pour ce tour.

Retours:

Clé de stockage.

Exception:

java.lang.IllegalArgumentException - TurnContext ne contient pas toutes les données requises.

load

public CompletableFuture load(TurnContext turnContext)

Remplit le cache d’état de ce BotState à partir de la couche de stockage.

Paramètres:

turnContext - Objet de contexte pour ce tour.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

load

public CompletableFuture load(TurnContext turnContext, boolean force)

Lit dans l’objet d’état actuel et le met en cache dans l’objet de contexte pour ce tour.

Paramètres:

turnContext - Objet de contexte pour ce tour.
force - true pour remplacer tout cache d’état existant ; ou false pour charger l’état à partir du stockage uniquement si le cache n’existe pas déjà.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext)

Écrit le cache d’état de ce BotState dans la couche de stockage.

Paramètres:

turnContext - Objet de contexte pour ce tour.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext, boolean force)

Écrit le cache d’état de ce BotState dans la couche de stockage.

Paramètres:

turnContext - Objet de contexte pour ce tour.
force - true pour enregistrer le cache d’état dans le stockage ; ou false pour enregistrer l’état dans le stockage uniquement si une propriété dans le cache a changé.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

setPropertyValue

protected CompletableFuture setPropertyValue(TurnContext turnContext, String propertyName, Object value)

Définit la valeur d’une propriété dans le cache d’état de ce BotState.

Paramètres:

turnContext - Objet de contexte pour ce tour.
propertyName - Nom de la propriété à définir.
value - Valeur à définir sur la propriété.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

S’applique à