MemoryScope Classe

  • Référence
Paquet:
com.microsoft.bot.dialogs.memory.scopes
Artefact Maven:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.memory.scopes.MemoryScope

public abstract class MemoryScope

MemoryScope représente une classe abstraite d’étendue de mémoire nommée.

Récapitulatif du constructeur

Constructeur Description
MemoryScope(String name, Boolean includeInSnapshot)

Initialise une nouvelle instance de la classe.

Résumé de la méthode

Modificateur et type Méthode et description
java.util.concurrent.CompletableFuture<java.lang.Void> delete(DialogContext dialogContext)

Supprime tout état dans le stockage et le cache pour cela.
java.lang.Boolean getIncludeInSnapshot()
abstract java.lang.Object getMemory(DialogContext dialogContext)

Obtenez la mémoire de stockage pour cette étendue.
java.lang.String getName()
java.util.concurrent.CompletableFuture<java.lang.Void> load(DialogContext dialogContext, Boolean force)

Remplit le cache d’état pour cela à partir de la couche de stockage.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(DialogContext dialogContext, Boolean force)

Écrit le cache d’état pour cela dans la couche de stockage.
void setIncludeInSnapshot(Boolean withIncludeInSnapshot)
abstract void setMemory(DialogContext dialogContext, Object memory)

Modifie l’objet de stockage pour l’étendue de mémoire.
void setName(String withName)

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

MemoryScope

public MemoryScope(String name, Boolean includeInSnapshot)

Initialise une nouvelle instance de la classe.

Paramètres:

name - Nom de l’étendue.
includeInSnapshot - Valeur indiquant si cette mémoire doit être incluse dans l’instantané.

Détails de la méthode

delete

public CompletableFuture delete(DialogContext dialogContext)

Supprime tout état dans le stockage et le cache pour cela.

Paramètres:

dialogContext - Objet de contexte de boîte de dialogue pour ce tour.

Retours:

CompletableFuture A future qui représente le travail mis en file d’attente à exécuter.

getIncludeInSnapshot

public Boolean getIncludeInSnapshot()

Retours:

Boolean Renvoie la valeur indiquant si cette mémoire doit être incluse dans l’instantané.

getMemory

public abstract Object getMemory(DialogContext dialogContext)

Obtenez la mémoire de stockage pour cette étendue.

Paramètres:

dialogContext - DialogContext à obtenir à partir du magasin de mémoire.

Retours:

Objet Mémoire de cette étendue.

getName

public String getName()

Retours:

Chaîne Obtient le nom de l’étendue.

load

public CompletableFuture load(DialogContext dialogContext, Boolean force)

Remplit le cache d’état pour cela à partir de la couche de stockage.

Paramètres:

dialogContext - Objet de contexte de boîte de dialogue pour ce tour.
force - True pour remplacer un cache d’état existant ou false pour charger l’état à partir du stockage uniquement si le cache n’existe pas déjà.

Retours:

CompletableFuture A future qui représente le travail mis en file d’attente à exécuter.

saveChanges

public CompletableFuture saveChanges(DialogContext dialogContext, Boolean force)

Écrit le cache d’état pour cela dans la couche de stockage.

Paramètres:

dialogContext - Objet de contexte de boîte de dialogue 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:

CompletableFuture A future qui représente le travail mis en file d’attente à exécuter.

setIncludeInSnapshot

public void setIncludeInSnapshot(Boolean withIncludeInSnapshot)

Paramètres:

withIncludeInSnapshot - Définit la valeur indiquant si cette mémoire doit être incluse dans l’instantané.

setMemory

public abstract void setMemory(DialogContext dialogContext, Object memory)

Modifie l’objet de stockage pour l’étendue de mémoire.

Paramètres:

dialogContext - DialogContext à définir dans le magasin de mémoire.
memory - Mémoire sur laquelle définir DialogContext.

setName

public void setName(String withName)

Paramètres:

withName - Définit le nom de l’étendue.

S’applique à