UserMemoryScope class
Memoria con ambito per l'utente corrente.
- Extends
Costruttori
| User |
Inizializza una nuova istanza della classe UserMemoryScope |
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 ereditati
| 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
UserMemoryScope()
Inizializza una nuova istanza della classe UserMemoryScope
new UserMemoryScope()Dettagli proprietà ereditate
includeInSnapshot
Ottiene un valore che indica se la memoria deve essere inclusa nello snapshot.
includeInSnapshot: booleanValore della proprietà
boolean
Ereditato daMemoryScope.includeInSnapshot
name
Ottiene o imposta il nome dell'ambito
name: stringValore della proprietà
string
ereditato daMemoryScope.name
Dettagli dei metodi ereditati
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.
ereditato daBotStateMemoryScope.delete
getMemory(DialogContext)
Ottenere la memoria di backup per questo ambito.
function getMemory(dc: DialogContext): objectParametri
contesto del dialogo corrente.
Restituisce
object
Memoria per l'ambito.
ereditato daBotStateMemoryScope.getMemory
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.
ereditato daBotStateMemoryScope.load
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.
ereditato daBotStateMemoryScope.saveChanges
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
Ereditato daBotStateMemoryScope.setMemory