DialogStateManager Klasse

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

Implementiert

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

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

Der DialogStateManager verwaltet Speicherbereiche und Pfadresolver MemoryScopes sind benannte Objekte auf Stammebene, die entweder im Dialogcontext vorhanden sein können, oder das Deaktivieren des Zustands "PathResolvers" ermöglichen das Tastenkombinationsverhalten zum Zuordnen von Elementen wie $foo zu dialog.foo.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
DialogStateManager(DialogContext dc)

Initialisiert eine neue Instanz der DialogStateManager Klasse.

DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

Initialisiert eine neue Instanz der DialogStateManager Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
T <T>getValue(String pathExpression, T defaultValue, Class<T> clsType)

Rufen Sie den Wert aus dem Arbeitsspeicher mithilfe des Pfadausdrucks ab (HINWEIS: Dies gibt immer den Klon des Werts zurück).

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

Rufen Sie den Wert aus dem Arbeitsspeicher mithilfe des Pfadausdrucks ab (HINWEIS: Dies gibt immer den Klon des Werts zurück).

void add(String key, Object value)

Fügt dem Dialogstatus-Manager ein Element hinzu.

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

Fügt dem Dialogstatus-Manager ein Element hinzu.

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

Überprüfen Sie, ob sich ein Pfad seit dem Wasserzeichen geändert hat.

void clear()

Entfernt alle Elemente aus dem Dialogstatus-Manager.

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

Bestimmt, ob der Dialogstatus-Manager einen bestimmten Wert enthält.

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

Bestimmt, ob der Dialogstatus-Manager ein Element mit dem angegebenen Schlüssel enthält.

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

Kopiert die Elemente des Dialogstatus-Managers in ein Array, das mit einem bestimmten Index beginnt.

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

Löschen Sie den Speicher für einen Bereich.

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)

Rufen Sie einen booleschen Wert aus dem Arbeitsspeicher mithilfe eines Pfadausdrucks ab.

DialogStateManagerConfiguration getConfiguration()

Legt die konfigurierten Pfadlöser und Speicherbereiche für das Dialogfeld fest.

java.lang.Object getElement(String key)

Ruft die Elemente mit dem angegebenen Schlüssel ab.

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

Gibt einen Iterator zurück, der die Auflistung durchläuft.

int getIntValue(String pathExpression, int defaultValue)

Abrufen eines Int-Werts aus dem Arbeitsspeicher mithilfe eines Pfadausdrucks.

java.lang.Boolean getIsReadOnly()

Ruft einen Wert ab, der angibt, ob der Dialogstatus-Manager schreibgeschützt ist.

MemoryScope getMemoryScope(String name)

Abrufen des SpeichersBereichs nach Namen.

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

Ruft alle MemoryScopes ab, die für die Protokollierung geeignet sind.

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

Abrufen eines Zeichenfolgenwerts aus dem Arbeitsspeicher mithilfe eines Pfadausdrucks.

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

Laden Sie alle Bereiche.

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)

Entfernt das Element mit dem angegebenen Schlüssel aus dem Dialogstatus-Manager.

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

Entfernt das erste Vorkommen eines bestimmten Objekts aus dem Dialogstatus-Manager.

void removeValue(String path)

Eigenschaft aus dem Speicher entfernen.

MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

Wenn SieSpeicherBereich auflösen, wird der SpeicherBereich gefunden und der verbleibende Pfad zurückgegeben.

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

Speichern Sie alle Änderungen für alle Bereiche.

void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

Legt die konfigurierten Pfadlöser und Speicherbereiche für das Dialogfeld fest.

void setElement(String key, Object element)

Legt die Elemente mit dem angegebenen Schlüssel fest.

void setValue(String path, Object value)

Legen Sie den Speicher auf "Wert" fest.

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

Verfolgen Sie, wann bestimmte Pfade geändert werden.

java.lang.String transformPath(String path)

Transformieren Sie den Pfad mithilfe des registrierten PfadsTransformatoren.

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

Ruft den Wert ab, der dem angegebenen Schlüssel zugeordnet ist.

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

Versionshilfe-Aufrufer, um die Updates zu identifizieren und cache zu entscheiden oder nicht.

Geerbte Methoden von 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

Details zum Konstruktor

DialogStateManager

public DialogStateManager(DialogContext dc)

Initialisiert eine neue Instanz der DialogStateManager Klasse.

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.

DialogStateManager

public DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

Initialisiert eine neue Instanz der DialogStateManager Klasse.

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.
configuration - Konfiguration für den Dialogstatus-Manager.

Details zur Methode

<T>getValue

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

Rufen Sie den Wert aus dem Arbeitsspeicher mithilfe des Pfadausdrucks ab (HINWEIS: Dies gibt immer den Klon des Werts zurück).

Parameter:

pathExpression - Pfadausdruck, der verwendet werden soll.
defaultValue - Standardwert, der zurückgegeben werden soll, wenn keine gefunden wurde.
clsType - Typ des Werts, der als Rückgabe angefordert wird.

Gibt zurück:

Ergebnis oder Standardwert, wenn der Pfad ungültig ist.

<TypeT>tryGetValue

public ResultPair tryGetValue(String path, Class clsType)

Rufen Sie den Wert aus dem Arbeitsspeicher mithilfe des Pfadausdrucks ab (HINWEIS: Dies gibt immer den Klon des Werts zurück).

Parameter:

path - pfadausdruck, der verwendet werden soll.
clsType - der Typ, der als Ergebnis angefordert wird

Gibt zurück:

ResultPair mit booleschen und angeforderten Typ TypeT als Ergebnis

add

public void add(String key, Object value)

Fügt dem Dialogstatus-Manager ein Element hinzu.

Parameter:

key - Schlüssel des hinzuzufügenden Elements.
value - Wert des hinzuzufügenden Elements.

add

public void add(AbstractMap.SimpleEntry item)

Fügt dem Dialogstatus-Manager ein Element hinzu.

Parameter:

item - Das SimpleEntry-Element mit dem Schlüssel und dem Objekt des hinzuzufügenden Elements.

anyPathChanged

public Boolean anyPathChanged(int counter, Iterable paths)

Überprüfen Sie, ob sich ein Pfad seit dem Wasserzeichen geändert hat.

Parameter:

counter - Zeitzähler, mit dem verglichen werden soll.
paths - Pfade von Trackpaths, die überprüft werden sollen.

Gibt zurück:

True, wenn sich ein Pfad seit dem Zähler geändert hat.

clear

public void clear()

Entfernt alle Elemente aus dem Dialogstatus-Manager.

contains

public Boolean contains(AbstractMap.SimpleEntry item)

Bestimmt, ob der Dialogstatus-Manager einen bestimmten Wert enthält.

Parameter:

item - Das element, das gesucht werden soll.

Gibt zurück:

True, wenn das Element im Dialogstatus-Manager gefunden wird; andernfalls,false

containsKey

public final boolean containsKey(Object key)

Parameter:

key

containsKey

public Boolean containsKey(String key)

Bestimmt, ob der Dialogstatus-Manager ein Element mit dem angegebenen Schlüssel enthält.

Parameter:

key - Der Schlüssel, der im Dialogstatus-Manager gefunden werden soll.

Gibt zurück:

true, wenn der Dialogstatus-Manager ein Element mit dem Schlüssel enthält; andernfalls "false".

containsValue

public final boolean containsValue(Object value)

Parameter:

value

copyTo

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

Kopiert die Elemente des Dialogstatus-Managers in ein Array, das mit einem bestimmten Index beginnt.

Parameter:

array - Das eindimensionale Array, das das Ziel der Elemente ist, die vom Dialogstatus-Manager kopiert wurden. Das Array muss eine nullbasierte Indizierung aufweisen.
arrayIndex - Der nullbasierte Index im Array, bei dem das Kopieren beginnt.

deleteScopesMemory

public CompletableFuture deleteScopesMemory(String name)

Löschen Sie den Speicher für einen Bereich.

Parameter:

name - Name des Bereichs

Gibt zurück:

Abgeschlossener CompletableFuture

entrySet

public final Set> entrySet()

get

public final Object get(Object key)

Parameter:

key

getBoolValue

public Boolean getBoolValue(String pathExpression, Boolean defaultValue)

Rufen Sie einen booleschen Wert aus dem Arbeitsspeicher mithilfe eines Pfadausdrucks ab.

Parameter:

pathExpression - Pfadausdruck.
defaultValue - Standardwert, wenn der Wert nicht vorhanden ist.

Gibt zurück:

Wert oder Standardwert, wenn der Pfad ungültig ist.

getConfiguration

public DialogStateManagerConfiguration getConfiguration()

Legt die konfigurierten Pfadlöser und Speicherbereiche für das Dialogfeld fest.

Gibt zurück:

The DialogStateManagerConfiguration.

getElement

public Object getElement(String key)

Ruft die Elemente mit dem angegebenen Schlüssel ab.

Parameter:

key - Schlüssel zum Abrufen oder Festlegen des Elements.

Gibt zurück:

Das Element mit dem angegebenen Schlüssel.

getEnumerator

public Iterable> getEnumerator()

Gibt einen Iterator zurück, der die Auflistung durchläuft.

Gibt zurück:

Ein Iterator, der zum Durchlaufen der Sammlung verwendet werden kann.

getIntValue

public int getIntValue(String pathExpression, int defaultValue)

Abrufen eines Int-Werts aus dem Arbeitsspeicher mithilfe eines Pfadausdrucks.

Parameter:

pathExpression - Pfadausdruck.
defaultValue - Standardwert, wenn der Wert nicht vorhanden ist.

Gibt zurück:

Wert oder Standardwert, wenn der Pfad ungültig ist.

getIsReadOnly

public Boolean getIsReadOnly()

Ruft einen Wert ab, der angibt, ob der Dialogstatus-Manager schreibgeschützt ist.

Gibt zurück:

STIMMT

getMemoryScope

public MemoryScope getMemoryScope(String name)

Rufen Sie MemoryScope anhand des Namens ab.

Parameter:

name - Name des Bereichs.

Gibt zurück:

Ein Speicherbereich.

getMemorySnapshot

public JsonNode getMemorySnapshot()

Ruft alle MemoryScopes ab, die für die Protokollierung geeignet sind.

Gibt zurück:

JsonNode, das alle Speicherbereiche darstellt.

getStringValue

public String getStringValue(String pathExpression, String defaultValue)

Abrufen eines Zeichenfolgenwerts aus dem Arbeitsspeicher mithilfe eines Pfadausdrucks.

Parameter:

pathExpression - Der Pfadausdruck.
defaultValue - Standardwert, wenn der Wert nicht vorhanden ist.

Gibt zurück:

Zeichenfolge oder Standardwert, wenn der Pfad ungültig ist.

isEmpty

public final boolean isEmpty()

keySet

public final Set keySet()

loadAllScopes

public CompletableFuture loadAllScopes()

Laden Sie alle Bereiche.

Gibt zurück:

Eine abgeschlossene Zukunft.

put

public final Object put(String key, Object value)

Parameter:

key
value

putAll

public final void putAll(Map m)

Parameter:

m

remove

public final Object remove(Object key)

Parameter:

key

remove

public Boolean remove(String key)

Entfernt das Element mit dem angegebenen Schlüssel aus dem Dialogstatus-Manager.

Parameter:

key - Der Schlüssel des zu entfernenden Elements.

Gibt zurück:

true, wenn das Element erfolgreich entfernt wird; andernfalls "false".

remove

public boolean remove(AbstractMap.SimpleEntry item)

Entfernt das erste Vorkommen eines bestimmten Objekts aus dem Dialogstatus-Manager.

Parameter:

item - Das Objekt, das aus dem Dialogstatus-Manager entfernt werden soll.

Gibt zurück:

"true", wenn das Element erfolgreich aus dem Dialogstatus-Manager entfernt wurde, andernfalls "false".

removeValue

public void removeValue(String path)

Eigenschaft aus dem Speicher entfernen.

Parameter:

path - Pfad zum Entfernen der Blatteigenschaft.

resolveMemoryScope

public MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

ResolveMemoryScope findet den MemoryScope für und gibt den verbleibenden Pfad zurück.

Parameter:

path - Eingehender Pfad, der zum Bereich und zum verbleibenden Pfad aufgelöst werden soll.
remainingPath - Verbleibender Unterpfad im Bereich.

Gibt zurück:

Der Speicherbereich.

saveAllChanges

public CompletableFuture saveAllChanges()

Speichern Sie alle Änderungen für alle Bereiche.

Gibt zurück:

Abgeschlossene Zukunft

setConfiguration

public void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

Legt die konfigurierten Pfadlöser und Speicherbereiche für das Dialogfeld fest.

Parameter:

withDialogStateManagerConfiguration - Die festzulegende Konfiguration.

setElement

public void setElement(String key, Object element)

Legt die Elemente mit dem angegebenen Schlüssel fest.

Parameter:

key - Schlüssel zum Abrufen oder Festlegen des Elements.
element - Das Element, das mit dem bereitgestellten Schlüssel gespeichert werden soll.

setValue

public void setValue(String path, Object value)

Legen Sie den Speicher auf "Wert" fest.

Parameter:

path - Pfad zum Speicher.
value - Objekt, das festgelegt werden soll.

size

public final int size()

trackPaths

public List trackPaths(Iterable paths)

Verfolgen Sie, wann bestimmte Pfade geändert werden.

Parameter:

paths - Pfade, die nachverfolgt werden sollen.

Gibt zurück:

Normalisierte Pfade, die an AnyPathChanged übergeben werden sollen.

transformPath

public String transformPath(String path)

Transformieren Sie den Pfad mithilfe der registrierten PathTransformers.

Parameter:

path - Pfad zur Transformation.

Gibt zurück:

Der transformierte Pfad.

tryGetValue

public ResultPair tryGetValue(String key, Object value)

Ruft den Wert ab, der dem angegebenen Schlüssel zugeordnet ist.

Parameter:

key - Der Schlüssel, dessen Wert abgerufen werden soll.
value - Wenn diese Methode zurückgegeben wird, wird der dem angegebenen Schlüssel zugeordnete Wert zurückgegeben, wenn der Schlüssel gefunden wird; andernfalls der Standardwert für den Typ des Wertparameters.

Gibt zurück:

true, wenn der Dialogstatus-Manager ein Element mit dem angegebenen Schlüssel enthält;

values

public final Collection values()

version

public String version()

Versionshilfe-Aufrufer, um die Updates zu identifizieren und cache zu entscheiden oder nicht.

Gibt zurück:

Aktuelle Version

Gilt für: