DialogStateManager class

  • Riferimento
Pacchetto:
botbuilder-dialogs

DialogStateManager gestisce gli ambiti di memoria e i resolver di percorso.

Commenti

MemoryScopes sono oggetti a livello radice denominati, che possono esistere nel contesto del dialogo o disattivati dello stato di attivazione. I resolver di percorso consentono il comportamento di collegamento per il mapping di elementi come $foo -> dialog.foo

Costruttori

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Inizializza una nuova istanza della classe DialogStateManager .

Proprietà

configuration

Ottiene o imposta i resolver di percorso e gli ambiti di memoria configurati per la gestione dello stato del dialogo.

Metodi

anyPathChanged(number, string[])

Controllare se un percorso è cambiato dopo la filigrana.
deleteScopesMemory(string)

Elimina tutta la memoria di backup per un determinato ambito.
deleteValue(string)

Eliminare la proprietà dalla memoria
getMemorySnapshot()

Ottiene tutti gli ambiti di memoria adatti per la registrazione.
getValue<T>(string, T | () => T)

Ottenere il valore dalla memoria usando l'espressione path.
loadAllScopes()

Assicura che tutti gli ambiti di memoria siano stati caricati per il turno corrente.
parsePath(string, boolean)

Normalizza i segmenti di percorso di un percorso passato.
saveAllChanges()

Salva le modifiche apportate agli ambiti di memoria.
setValue(string, any)

Impostare la memoria su value.
trackPaths(string[])

Tenere traccia di quando vengono modificati percorsi specifici.
transformPath(string)

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

dc
DialogContext

Contesto del dialogo per il turno corrente della conversazione.

configuration
DialogStateManagerConfiguration

Configurazione per gestione dello stato del dialogo.

Dettagli proprietà

configuration

Ottiene o imposta i resolver di percorso e gli ambiti di memoria configurati per la gestione dello stato del dialogo.

configuration: DialogStateManagerConfiguration

Valore della proprietà

DialogStateManagerConfiguration

Commenti

Esiste 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[])

Controllare se un percorso è cambiato dopo la filigrana.

function anyPathChanged(counter: number, paths: string[]): boolean

Parametri

counter

number

Contatore del tempo a cui confrontare.

paths

string[]

Percorsi da trackPaths() da controllare.

Restituisce

boolean

True se un percorso è stato modificato dopo il 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 path.

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 nessun defaultValue specificato.

Commenti

Questo restituisce sempre un CLONE della memoria, tutte le modifiche apportate al risultato non influiranno 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

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

Opzionale. 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 per 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 la memoria su value.

function setValue(pathExpression: string, value: any)

Parametri

pathExpression

string

Percorso della memoria.

value

any

Valore da impostare.

trackPaths(string[])

Tenere traccia di 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 da trasformare.

Restituisce

string

Percorso trasformato.

version()

Ottiene il numero di versione.

function version(): string

Restituisce

string

Stringa con il numero di versione.