MemoryScope Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.dialogs.memory.scopes
Artefatto Maven:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.memory.scopes.MemoryScope

public abstract class MemoryScope

MemoryScope rappresenta una classe astratta con ambito di memoria denominata.

Riepilogo dei costruttori

Costruttore Descrizione
MemoryScope(String name, Boolean includeInSnapshot)

Inizializza una nuova istanza della classe .

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
java.util.concurrent.CompletableFuture<java.lang.Void> delete(DialogContext dialogContext)

Elimina qualsiasi stato nella risorsa di archiviazione e nella cache.
java.lang.Boolean getIncludeInSnapshot()
abstract java.lang.Object getMemory(DialogContext dialogContext)

Ottenere la memoria di backup per questo ambito.
java.lang.String getName()
java.util.concurrent.CompletableFuture<java.lang.Void> load(DialogContext dialogContext, Boolean force)

Popola la cache di stato per questo dal livello di archiviazione.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(DialogContext dialogContext, Boolean force)

Scrive la cache di stato per questo nel livello di archiviazione.
void setIncludeInSnapshot(Boolean withIncludeInSnapshot)
abstract void setMemory(DialogContext dialogContext, Object memory)

Modifica l'oggetto di backup per l'ambito della memoria.
void setName(String withName)

Metodi ereditati da 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

Dettagli costruttore

MemoryScope

public MemoryScope(String name, Boolean includeInSnapshot)

Inizializza una nuova istanza della classe .

Parametri:

name - Nome dell'ambito.
includeInSnapshot - Valore che indica se la memoria deve essere inclusa nello snapshot.

Dettagli metodo

delete

public CompletableFuture delete(DialogContext dialogContext)

Elimina qualsiasi stato nella risorsa di archiviazione e nella cache.

Parametri:

dialogContext - Contesto del dialogo Oggetto per questo turno.

Restituisce:

CompletableFuture Un futuro che rappresenta il lavoro in coda da eseguire.

getIncludeInSnapshot

public Boolean getIncludeInSnapshot()

Restituisce:

Boolean Restituisce il valore che indica se la memoria deve essere inclusa nello snapshot.

getMemory

public abstract Object getMemory(DialogContext dialogContext)

Ottenere la memoria di backup per questo ambito.

Parametri:

dialogContext - DialogContext da ottenere dall'archivio di memoria.

Restituisce:

Oggetto Memoria per questo ambito.

getName

public String getName()

Restituisce:

String Ottiene il nome dell'ambito.

load

public CompletableFuture load(DialogContext dialogContext, Boolean force)

Popola la cache di stato per questo dal livello di archiviazione.

Parametri:

dialogContext - Oggetto contesto del dialogo per questo turno.
force - True per sovrascrivere qualsiasi cache di stato esistente o false per caricare lo stato dall'archiviazione solo se la cache non esiste già.

Restituisce:

CompletableFuture Un futuro che rappresenta il lavoro in coda da eseguire.

saveChanges

public CompletableFuture saveChanges(DialogContext dialogContext, Boolean force)

Scrive la cache di stato per questo nel livello di archiviazione.

Parametri:

dialogContext - Contesto del dialogo Oggetto per questo turno.
force - True per salvare la cache di stato nell'archiviazione. o false per salvare lo stato nell'archiviazione solo se una proprietà nella cache è stata modificata.

Restituisce:

CompletableFuture Un futuro che rappresenta il lavoro in coda da eseguire.

setIncludeInSnapshot

public void setIncludeInSnapshot(Boolean withIncludeInSnapshot)

Parametri:

withIncludeInSnapshot - Imposta il valore che indica se la memoria deve essere inclusa nello snapshot.

setMemory

public abstract void setMemory(DialogContext dialogContext, Object memory)

Modifica l'oggetto di backup per l'ambito della memoria.

Parametri:

dialogContext - DialogContext da impostare nell'archivio memoria.
memory - Memoria su cui impostare DialogContext.

setName

public void setName(String withName)

Parametri:

withName - Imposta il nome dell'ambito.

Si applica a