MemoryScope Clase

  • Referencia
Paquete:
com.microsoft.bot.dialogs.memory.scopes
Artefacto Maven:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.memory.scopes.MemoryScope

public abstract class MemoryScope

MemoryScope representa una clase abstracta de ámbito de memoria con nombre.

Resumen del constructor

Constructor Description
MemoryScope(String name, Boolean includeInSnapshot)

Inicializa una nueva instancia de la clase .

Resumen del método

Modificador y tipo Método y descripción
java.util.concurrent.CompletableFuture<java.lang.Void> delete(DialogContext dialogContext)

Elimina cualquier estado en el almacenamiento y la memoria caché para esto.
java.lang.Boolean getIncludeInSnapshot()
abstract java.lang.Object getMemory(DialogContext dialogContext)

Obtenga la memoria de respaldo para este ámbito.
java.lang.String getName()
java.util.concurrent.CompletableFuture<java.lang.Void> load(DialogContext dialogContext, Boolean force)

Rellena la caché de estado de esta desde la capa de almacenamiento.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(DialogContext dialogContext, Boolean force)

Escribe la caché de estado para esto en la capa de almacenamiento.
void setIncludeInSnapshot(Boolean withIncludeInSnapshot)
abstract void setMemory(DialogContext dialogContext, Object memory)

Cambia el objeto de respaldo del ámbito de memoria.
void setName(String withName)

Métodos heredados 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

Detalles del constructor

MemoryScope

public MemoryScope(String name, Boolean includeInSnapshot)

Inicializa una nueva instancia de la clase .

Parámetros:

name - Nombre del ámbito.
includeInSnapshot - Valor que indica si esta memoria debe incluirse en la instantánea.

Detalles del método

delete

public CompletableFuture delete(DialogContext dialogContext)

Elimina cualquier estado en el almacenamiento y la memoria caché para esto.

Parámetros:

dialogContext - Objeto de contexto de diálogo para este turno.

Devoluciones:

CompletableFuture Un futuro que representa el trabajo en cola que se va a ejecutar.

getIncludeInSnapshot

public Boolean getIncludeInSnapshot()

Devoluciones:

Boolean Devuelve el valor que indica si esta memoria debe incluirse en la instantánea.

getMemory

public abstract Object getMemory(DialogContext dialogContext)

Obtenga la memoria de respaldo para este ámbito.

Parámetros:

dialogContext - DialogContext que se va a obtener del almacén de memoria.

Devoluciones:

Objeto Memoria de este ámbito.

getName

public String getName()

Devoluciones:

String Obtiene el nombre del ámbito.

load

public CompletableFuture load(DialogContext dialogContext, Boolean force)

Rellena la caché de estado de esta desde la capa de almacenamiento.

Parámetros:

dialogContext - Objeto de contexto de diálogo para este turno.
force - True para sobrescribir cualquier caché de estado existente o false para cargar el estado desde el almacenamiento solo si la memoria caché aún no existe.

Devoluciones:

CompletableFuture Un futuro que representa el trabajo en cola que se va a ejecutar.

saveChanges

public CompletableFuture saveChanges(DialogContext dialogContext, Boolean force)

Escribe la caché de estado para esto en la capa de almacenamiento.

Parámetros:

dialogContext - Objeto de contexto de diálogo para este turno.
force - True para guardar la caché de estado en el almacenamiento. o false para guardar el estado en el almacenamiento solo si ha cambiado una propiedad de la memoria caché.

Devoluciones:

CompletableFuture Un futuro que representa el trabajo en cola que se va a ejecutar.

setIncludeInSnapshot

public void setIncludeInSnapshot(Boolean withIncludeInSnapshot)

Parámetros:

withIncludeInSnapshot - Establece el valor que indica si esta memoria debe incluirse en la instantánea.

setMemory

public abstract void setMemory(DialogContext dialogContext, Object memory)

Cambia el objeto de respaldo del ámbito de memoria.

Parámetros:

dialogContext - DialogContext que se va a establecer en el almacén de memoria.
memory - Memoria en la que se va a establecer DialogContext.

setName

public void setName(String withName)

Parámetros:

withName - Establece el nombre del ámbito.

Se aplica a