BotStateMemoryScope class
Classe di base per gli ambiti di memoria basati su BotState.
- Extends
Costruttori
Bot |
Inizializza una nuova istanza della classe BotStateMemoryScope. |
Proprietà ereditate
include |
Ottiene un valore che indica se la memoria deve essere inclusa nello snapshot. |
name | Ottiene o imposta il nome dell'ambito |
Metodi
delete(Dialog |
Elimina qualsiasi stato nell'archiviazione e nella cache per questo BotState. |
get |
Ottenere la memoria di backup per questo ambito. |
load(Dialog |
Popola la cache di stato per questo BotState dal livello di archiviazione. |
save |
Scrive la cache di stato per questo BotState nel livello di archiviazione. |
set |
Modifica l'oggetto di backup per l'ambito della memoria. |
Dettagli costruttore
BotStateMemoryScope(string)
Inizializza una nuova istanza della classe BotStateMemoryScope.
new BotStateMemoryScope(name: string)
Parametri
- name
-
string
nome della proprietà.
Dettagli proprietà ereditate
includeInSnapshot
Ottiene un valore che indica se la memoria deve essere inclusa nello snapshot.
includeInSnapshot: boolean
Valore della proprietà
boolean
Ereditato daMemoryScope.includeInSnapshot
name
Ottiene o imposta il nome dell'ambito
name: string
Valore della proprietà
string
ereditato daMemoryScope.name
Dettagli metodo
delete(DialogContext)
Elimina qualsiasi stato nell'archiviazione e nella cache per questo BotState.
function delete(_dc: DialogContext): Promise<void>
Parametri
- _dc
- DialogContext
Oggetto DialogContext
Restituisce
Promise<void>
Promessa che rappresenta il lavoro in coda da eseguire.
getMemory(DialogContext)
Ottenere la memoria di backup per questo ambito.
function getMemory(dc: DialogContext): object
Parametri
contesto del dialogo corrente.
Restituisce
object
Memoria per l'ambito.
load(DialogContext, boolean)
Popola la cache di stato per questo BotState dal livello di archiviazione.
function load(dc: DialogContext, force?: boolean): Promise<void>
Parametri
Oggetto DialogContext
- force
-
boolean
Facoltativo, true
per sovrascrivere qualsiasi cache di stato esistente; o false
per caricare lo stato dall'archiviazione solo se la cache non esiste già.
Restituisce
Promise<void>
Promessa che rappresenta il lavoro in coda da eseguire.
saveChanges(DialogContext, boolean)
Scrive la cache di stato per questo BotState nel livello di archiviazione.
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>
Parametri
Oggetto DialogContext
- force
-
boolean
Facoltativo, true
per salvare la cache di stato nella risorsa di archiviazione; o false
per salvare lo stato nell'archiviazione solo se una proprietà nella cache è stata modificata.
Restituisce
Promise<void>
Promessa che rappresenta il lavoro in coda da eseguire.
setMemory(DialogContext, object)
Modifica l'oggetto di backup per l'ambito della memoria.
function setMemory(dc: DialogContext, _memory: object)
Parametri
contesto del dialogo corrente
- _memory
-
object
memoria