DialogStateManager class
DialogStateManager gestisce gli ambiti di memoria e i resolver del percorso.
Commenti
MemoryScopes sono oggetti a livello radice denominati, che possono esistere nel contesto della finestra di dialogo o disattivato dello stato di disattivazione. I resolver di percorso consentono il comportamento di collegamento per il mapping di elementi come $foo -> dialog.foo
Costruttori
Dialog |
Inizializza una nuova istanza della classe DialogStateManager . |
Proprietà
configuration | Ottiene o imposta gli ambiti di risoluzione dei percorsi e memoria configurati per la gestione dello stato della finestra di dialogo. |
Metodi
any |
Verificare se il percorso è cambiato dopo la filigrana. |
delete |
Elimina tutta la memoria di backup per un determinato ambito. |
delete |
Eliminare la proprietà dalla memoria |
get |
Ottiene tutti gli ambiti di memoria adatti per la registrazione. |
get |
Ottenere il valore dalla memoria usando l'espressione di percorso. |
load |
Assicura che tutti gli ambiti di memoria siano stati caricati per il turno corrente. |
parse |
Normalizza i segmenti di percorso di un percorso passato. |
save |
Salva le modifiche apportate agli ambiti di memoria. |
set |
Impostare memoria su valore. |
track |
Tenere traccia quando vengono modificati percorsi specifici. |
transform |
Trasformare il percorso usando i trasformatori di percorso registrati. |
version() | Ottiene il numero di versione. |
Dettagli costruttore
DialogStateManager(DialogContext, DialogStateManagerConfiguration)
Inizializza una nuova istanza della classe DialogStateManager .
new DialogStateManager(dc: DialogContext, configuration?: DialogStateManagerConfiguration)
Parametri
Contesto della finestra di dialogo per il turno corrente della conversazione.
- configuration
- DialogStateManagerConfiguration
Configurazione per la gestione dello stato della finestra di dialogo.
Dettagli proprietà
configuration
Ottiene o imposta gli ambiti di risoluzione dei percorsi e memoria configurati per la gestione dello stato della finestra di dialogo.
configuration: DialogStateManagerConfiguration
Valore della proprietà
Commenti
È disponibile un singolo set di informazioni di configurazione per una determinata catena di contesti di dialogo. L'assegnazione di una nuova configurazione a qualsiasi DialogStateManager all'interno della catena aggiornerà la configurazione per l'intera catena.
Dettagli metodo
anyPathChanged(number, string[])
Verificare se il percorso è cambiato dopo la filigrana.
function anyPathChanged(counter: number, paths: string[]): boolean
Parametri
- counter
-
number
Contatore del tempo da confrontare.
- paths
-
string[]
Percorsi da trackPaths() da controllare.
Restituisce
boolean
True se qualsiasi percorso è cambiato dal contatore.
deleteScopesMemory(string)
Elimina tutta la memoria di backup per un determinato ambito.
function deleteScopesMemory(name: string): Promise<void>
Parametri
- name
-
string
Nome dell'ambito.
Restituisce
Promise<void>
deleteValue(string)
Eliminare la proprietà dalla memoria
function deleteValue(pathExpression: string)
Parametri
- pathExpression
-
string
Proprietà foglia da rimuovere.
getMemorySnapshot()
Ottiene tutti gli ambiti di memoria adatti per la registrazione.
function getMemorySnapshot(): object
Restituisce
object
Oggetto che rappresenta tutti gli ambiti di memoria.
getValue<T>(string, T | () => T)
Ottenere il valore dalla memoria usando l'espressione di percorso.
function getValue<T>(pathExpression: string, defaultValue?: T | () => T): T
Parametri
- pathExpression
-
string
Espressione di percorso da usare.
- defaultValue
-
T | () => T
(Facoltativo) valore predefinito da usare se il percorso non viene trovato. Può essere una funzione che restituisce il valore predefinito da usare.
Restituisce
T
Valore trovato o non definito se non trovato e non defaultValue
specificato.
Commenti
Questo restituisce sempre un CLONE della memoria, le modifiche apportate al risultato non influiscono sulla memoria.
loadAllScopes()
Assicura che tutti gli ambiti di memoria siano stati caricati per il turno corrente.
function loadAllScopes(): Promise<void>
Restituisce
Promise<void>
Commenti
Questo deve essere chiamato all'inizio del turno.
parsePath(string, boolean)
Normalizza i segmenti di percorso di un percorso passato.
function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]
Parametri
- pathExpression
-
string
Percorso da normalizzare.
- allowNestedPaths
-
boolean
Facoltativa. Se false
il rilevamento di un percorso annidato causerà la restituzione di un percorso vuoto. Il valore predefinito è "true".
Restituisce
string | number[]
Percorso normalizzato.
Commenti
Un percorso di profile.address[0]
verrà normalizzato in profile.address.0
.
saveAllChanges()
Salva le modifiche apportate agli ambiti di memoria.
function saveAllChanges(): Promise<void>
Restituisce
Promise<void>
Commenti
Questa operazione deve essere chiamata alla fine del turno.
setValue(string, any)
Impostare memoria su valore.
function setValue(pathExpression: string, value: any)
Parametri
- pathExpression
-
string
Percorso di memoria.
- value
-
any
Valore da impostare.
trackPaths(string[])
Tenere traccia quando vengono modificati percorsi specifici.
function trackPaths(paths: string[]): string[]
Parametri
- paths
-
string[]
Percorsi da tenere traccia.
Restituisce
string[]
Percorsi normalizzati da passare a anyPathChanged().
transformPath(string)
Trasformare il percorso usando i trasformatori di percorso registrati.
function transformPath(pathExpression: string): string
Parametri
- pathExpression
-
string
Percorso di trasformazione.
Restituisce
string
Percorso trasformato.
version()
Ottiene il numero di versione.
function version(): string
Restituisce
string
Stringa con il numero di versione.