DialogStateManager Classe

  • java.lang.Object
    • com.microsoft.bot.dialogs.memory.DialogStateManager

Implementazioni

java.util.Map<java.lang.String,java.lang.Object>

public class DialogStateManager
implements java.util.Map<java.lang.String,java.lang.Object>

DialogStateManager gestisce gli ambiti di memoria e pathresolvers MemoryScopes sono denominati oggetti a livello radice, che possono esistere nel dialogcontext o disattivando lo stato PathResolvers consentono il comportamento di collegamento per eseguire il mapping di elementi come $foo a dialog.foo.

Riepilogo dei costruttori

Costruttore Descrizione
DialogStateManager(DialogContext dc)

Inizializza una nuova istanza della classe DialogStateManager.

DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

Inizializza una nuova istanza della classe DialogStateManager.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
T <T>getValue(String pathExpression, T defaultValue, Class<T> clsType)

Ottenere il valore dalla memoria usando l'espressione di percorso (NOTA: restituisce sempre clone di valore).

ResultPair<TypeT> <TypeT>tryGetValue(String path, Class<TypeT> clsType)

Ottenere il valore dalla memoria usando l'espressione di percorso (NOTA: restituisce sempre clone di valore).

void add(String key, Object value)

Aggiunge un elemento al gestore dello stato del dialogo.

void add(AbstractMap.SimpleEntry<String,Object> item)

Aggiunge un elemento alla gestione dello stato del dialogo.

java.lang.Boolean anyPathChanged(int counter, Iterable<String> paths)

Controllare se un percorso è cambiato dopo la filigrana.

void clear()

Rimuove tutti gli elementi dal gestore dello stato del dialogo.

java.lang.Boolean contains(AbstractMap.SimpleEntry<String,Object> item)

Determina se la gestione dello stato della finestra di dialogo contiene un valore specifico.

final boolean containsKey(Object key)
java.lang.Boolean containsKey(String key)

Determina se la gestione dello stato del dialogo contiene un elemento con la chiave specificata.

final boolean containsValue(Object value)
void copyTo(AbstractMap.SimpleEntry<String,Object>[] array, int arrayIndex)

Copia gli elementi della gestione dello stato del dialogo in una matrice a partire da un indice specifico.

java.util.concurrent.CompletableFuture<java.lang.Void> deleteScopesMemory(String name)

Eliminare la memoria per un ambito.

final java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
final java.lang.Object get(Object key)
java.lang.Boolean getBoolValue(String pathExpression, Boolean defaultValue)

Ottenere un valore booleano dalla memoria usando un'espressione di percorso.

DialogStateManagerConfiguration getConfiguration()

Imposta i resolver di percorso e gli ambiti di memoria configurati per la finestra di dialogo.

java.lang.Object getElement(String key)

Ottiene gli elementi con la chiave specificata.

java.lang.Iterable<java.util.AbstractMap.SimpleEntry<java.lang.String,java.lang.Object>> getEnumerator()

Restituisce un iteratore che scorre l'insieme.

int getIntValue(String pathExpression, int defaultValue)

Ottenere un valore int dalla memoria usando un'espressione di percorso.

java.lang.Boolean getIsReadOnly()

Ottiene un valore che indica se il gestore dello stato del dialogo è di sola lettura.

MemoryScope getMemoryScope(String name)

Ottenere memoriaAmbito in base al nome.

com.fasterxml.jackson.databind.JsonNode getMemorySnapshot()

Ottiene tutti gli ambiti di memoria adatti per la registrazione.

java.lang.String getStringValue(String pathExpression, String defaultValue)

Ottenere un valore String dalla memoria usando un'espressione di percorso.

final boolean isEmpty()
final java.util.Set<java.lang.String> keySet()
java.util.concurrent.CompletableFuture<java.lang.Void> loadAllScopes()

Caricare tutti gli ambiti.

final java.lang.Object put(String key, Object value)
final void putAll(Map<? extends String,? extends Object> m)
final java.lang.Object remove(Object key)
java.lang.Boolean remove(String key)

Rimuove l'elemento con la chiave specificata dal gestore dello stato del dialogo.

boolean remove(AbstractMap.SimpleEntry<String,Object> item)

Rimuove la prima occorrenza di un oggetto specifico dal gestore dello stato del dialogo.

void removeValue(String path)

Rimuovere la proprietà dalla memoria.

MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

Risolverel'ambitomemoria troverà l'ambitomemoria per e restituirà il percorso rimanente.

java.util.concurrent.CompletableFuture<java.lang.Void> saveAllChanges()

Salvare tutte le modifiche per tutti gli ambiti.

void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

Imposta i resolver di percorso e gli ambiti di memoria configurati per la finestra di dialogo.

void setElement(String key, Object element)

Imposta gli elementi con la chiave specificata.

void setValue(String path, Object value)

Impostare la memoria su value.

final int size()
java.util.List<java.lang.String> trackPaths(Iterable<String> paths)

Tenere traccia di quando vengono modificati percorsi specifici.

java.lang.String transformPath(String path)

Trasformare il percorso usando il percorso registratoTransformers.

ResultPair<java.lang.Object> tryGetValue(String key, Object value)

Ottiene il valore associato alla chiave specificata.

final java.util.Collection<java.lang.Object> values()
java.lang.String version()

Chiamante della Guida alla versione per identificare gli aggiornamenti e decidere o meno la cache.

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

DialogStateManager

public DialogStateManager(DialogContext dc)

Inizializza una nuova istanza della classe DialogStateManager.

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.

DialogStateManager

public DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

Inizializza una nuova istanza della classe DialogStateManager.

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
configuration - Configurazione per gestione dello stato del dialogo.

Dettagli metodo

<T>getValue

public T getValue(String pathExpression, T defaultValue, Class clsType)

Ottenere il valore dalla memoria usando l'espressione di percorso (NOTA: restituisce sempre clone di valore).

Parametri:

pathExpression - Espressione di percorso da usare.
defaultValue - Valore predefinito da restituire se non è stato trovato alcuno.
clsType - Tipo di valore richiesto come restituito.

Restituisce:

Risultato o valore predefinito se il percorso non è valido.

<TypeT>tryGetValue

public ResultPair tryGetValue(String path, Class clsType)

Ottenere il valore dalla memoria usando l'espressione di percorso (NOTA: restituisce sempre clone di valore).

Parametri:

path - espressione di percorso da usare.
clsType - Tipo richiesto di conseguenza

Restituisce:

ResultPair con tipo booleano e tipo richiesto TypeT come risultato

add

public void add(String key, Object value)

Aggiunge un elemento al gestore dello stato del dialogo.

Parametri:

key - Chiave dell'elemento da aggiungere.
value - Valore dell'elemento da aggiungere.

add

public void add(AbstractMap.SimpleEntry item)

Aggiunge un elemento alla gestione dello stato del dialogo.

Parametri:

item - SimpleEntry con la chiave e l'oggetto dell'elemento da aggiungere.

anyPathChanged

public Boolean anyPathChanged(int counter, Iterable paths)

Controllare se un percorso è cambiato dopo la filigrana.

Parametri:

counter - Contatore del tempo a cui confrontare.
paths - Percorsi da Trackpaths da controllare.

Restituisce:

True se un percorso è stato modificato dopo il contatore.

clear

public void clear()

Rimuove tutti gli elementi dal gestore dello stato del dialogo.

contains

public Boolean contains(AbstractMap.SimpleEntry item)

Determina se la gestione dello stato della finestra di dialogo contiene un valore specifico.

Parametri:

item - Oggetto dell'elemento da individuare.

Restituisce:

True se l'elemento viene trovato nel gestore dello stato del dialogo; in caso contrario, false

containsKey

public final boolean containsKey(Object key)

Parametri:

key

containsKey

public Boolean containsKey(String key)

Determina se la gestione dello stato del dialogo contiene un elemento con la chiave specificata.

Parametri:

key - Chiave da individuare nel gestore dello stato della finestra di dialogo.

Restituisce:

true se il gestore dello stato del dialogo contiene un elemento con la chiave; in caso contrario, false.

containsValue

public final boolean containsValue(Object value)

Parametri:

value

copyTo

public void copyTo(AbstractMap.SimpleEntry[] array, int arrayIndex)

Copia gli elementi della gestione dello stato del dialogo in una matrice a partire da un indice specifico.

Parametri:

array - Matrice unidimensionale che rappresenta la destinazione degli elementi copiati dal gestore dello stato del dialogo. La matrice deve avere l'indicizzazione in base zero.
arrayIndex - Indice in base zero nella matrice in corrispondenza del quale inizia la copia.

deleteScopesMemory

public CompletableFuture deleteScopesMemory(String name)

Eliminare la memoria per un ambito.

Parametri:

name - nome dell'ambito

Restituisce:

Completata CompletableFuture

entrySet

public final Set> entrySet()

get

public final Object get(Object key)

Parametri:

key

getBoolValue

public Boolean getBoolValue(String pathExpression, Boolean defaultValue)

Ottenere un valore booleano dalla memoria usando un'espressione di percorso.

Parametri:

pathExpression - Espressione di percorso.
defaultValue - Valore predefinito se il valore non esiste.

Restituisce:

Valore o valore predefinito se path non è valido.

getConfiguration

public DialogStateManagerConfiguration getConfiguration()

Imposta i resolver di percorso e gli ambiti di memoria configurati per la finestra di dialogo.

Restituisce:

The DialogStateManagerConfiguration.

getElement

public Object getElement(String key)

Ottiene gli elementi con la chiave specificata.

Parametri:

key - Chiave per ottenere o impostare l'elemento.

Restituisce:

Elemento con la chiave specificata.

getEnumerator

public Iterable> getEnumerator()

Restituisce un iteratore che scorre l'insieme.

Restituisce:

Iteratore che può essere utilizzato per scorrere la raccolta.

getIntValue

public int getIntValue(String pathExpression, int defaultValue)

Ottenere un valore int dalla memoria usando un'espressione di percorso.

Parametri:

pathExpression - Espressione di percorso.
defaultValue - Valore predefinito se il valore non esiste.

Restituisce:

Valore o valore predefinito se path non è valido.

getIsReadOnly

public Boolean getIsReadOnly()

Ottiene un valore che indica se il gestore dello stato del dialogo è di sola lettura.

Restituisce:

vero

getMemoryScope

public MemoryScope getMemoryScope(String name)

Ottenere MemoryScope in base al nome.

Parametri:

name - Nome dell'ambito.

Restituisce:

Ambito di memoria.

getMemorySnapshot

public JsonNode getMemorySnapshot()

Ottiene tutti gli ambiti di memoria adatti per la registrazione.

Restituisce:

JsonNode che rappresenta tutti gli ambiti di memoria.

getStringValue

public String getStringValue(String pathExpression, String defaultValue)

Ottenere un valore String dalla memoria usando un'espressione di percorso.

Parametri:

pathExpression - Espressione di percorso.
defaultValue - Valore predefinito se il valore non esiste.

Restituisce:

Stringa o valore predefinito se path non è valido.

isEmpty

public final boolean isEmpty()

keySet

public final Set keySet()

loadAllScopes

public CompletableFuture loadAllScopes()

Caricare tutti gli ambiti.

Restituisce:

Futuro completato.

put

public final Object put(String key, Object value)

Parametri:

key
value

putAll

public final void putAll(Map m)

Parametri:

m

remove

public final Object remove(Object key)

Parametri:

key

remove

public Boolean remove(String key)

Rimuove l'elemento con la chiave specificata dal gestore dello stato del dialogo.

Parametri:

key - Chiave dell'elemento da rimuovere.

Restituisce:

true se l'elemento viene rimosso correttamente; in caso contrario, false.

remove

public boolean remove(AbstractMap.SimpleEntry item)

Rimuove la prima occorrenza di un oggetto specifico dal gestore dello stato del dialogo.

Parametri:

item - Oggetto da rimuovere dalla gestione dello stato del dialogo.

Restituisce:

true se l'elemento è stato rimosso correttamente dal gestore dello stato del dialogo; in caso contrario, false

removeValue

public void removeValue(String path)

Rimuovere la proprietà dalla memoria.

Parametri:

path - Percorso per rimuovere la proprietà foglia.

resolveMemoryScope

public MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

ResolveMemoryScope troverà MemoryScope per e restituirà il percorso rimanente.

Parametri:

path - Percorso in ingresso da risolvere nell'ambito e nel percorso rimanente.
remainingPath - Percorso secondario rimanente nell'ambito.

Restituisce:

Ambito di memoria.

saveAllChanges

public CompletableFuture saveAllChanges()

Salvare tutte le modifiche per tutti gli ambiti.

Restituisce:

Completamento futuro

setConfiguration

public void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

Imposta i resolver di percorso e gli ambiti di memoria configurati per la finestra di dialogo.

Parametri:

withDialogStateManagerConfiguration - Configurazione da impostare.

setElement

public void setElement(String key, Object element)

Imposta gli elementi con la chiave specificata.

Parametri:

key - Chiave per ottenere o impostare l'elemento.
element - Elemento da archiviare con la chiave specificata.

setValue

public void setValue(String path, Object value)

Impostare la memoria su value.

Parametri:

path - Percorso della memoria.
value - Oggetto da impostare.

size

public final int size()

trackPaths

public List trackPaths(Iterable paths)

Tenere traccia di quando vengono modificati percorsi specifici.

Parametri:

paths - Percorsi da tenere traccia.

Restituisce:

Percorsi normalizzati da passare a AnyPathChanged.

transformPath

public String transformPath(String path)

Trasformare il percorso usando PathTransformers registrato.

Parametri:

path - Percorso da trasformare.

Restituisce:

Percorso trasformato.

tryGetValue

public ResultPair tryGetValue(String key, Object value)

Ottiene il valore associato alla chiave specificata.

Parametri:

key - Chiave di cui ottenere il valore.
value - Quando termina, il valore associato alla chiave specificata, se viene trovata la chiave; in caso contrario, il valore predefinito per il tipo del parametro value.

Restituisce:

true se il gestore dello stato del dialogo contiene un elemento con la chiave specificata;

values

public final Collection values()

version

public String version()

Chiamante della Guida alla versione per identificare gli aggiornamenti e decidere o meno la cache.

Restituisce:

Versione corrente

Si applica a