DialogStateManager class

Paket:

botbuilder-dialogs

Der DialogStateManager verwaltet Speicherbereiche und Pfadlöser.

Hinweise

MemoryScopes sind benannte Objekte auf Stammebene, die entweder im Dialogfeldkontext vorhanden oder deaktiviert werden können. Pfadlöser ermöglichen das Verknüpfungsverhalten für die Zuordnung von Elementen wie $foo –> dialog.foo

Konstruktoren

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Initialisiert eine neue Instanz der DialogStateManager Klasse.

Eigenschaften

configuration

Ruft die konfigurierten Pfadlöser und Speicherbereiche für den Dialogstatus-Manager ab oder legt sie fest.

Methoden

anyPathChanged(number, string[])	Überprüfen Sie, ob sich ein Pfad seit dem Wasserzeichen geändert hat.
deleteScopesMemory(string)	Löscht den gesamten Sicherungsspeicher für einen bestimmten Bereich.
deleteValue(string)	Eigenschaft aus dem Speicher löschen
getMemorySnapshot()	Ruft alle Speicherbereiche ab, die für die Protokollierung geeignet sind.
getValue<T>(string, T | () => T)	Rufen Sie den Wert aus dem Arbeitsspeicher mithilfe des Pfadausdrucks ab.
loadAllScopes()	Stellt sicher, dass alle Speicherbereiche für die aktuelle Drehung geladen wurden.
parsePath(string, boolean)	Normalisiert die Pfadsegmente eines übergebenen Pfads.
saveAllChanges()	Speichert alle Änderungen, die an Speicherbereichen vorgenommen wurden.
setValue(string, any)	Legen Sie den Speicher auf "Wert" fest.
trackPaths(string[])	Verfolgen Sie, wann bestimmte Pfade geändert werden.
transformPath(string)	Transformieren Sie den Pfad mithilfe der registrierten Pfadtransformatoren.
version()	Ruft die Versionsnummer ab.

Details zum Konstruktor

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Initialisiert eine neue Instanz der DialogStateManager Klasse.

new DialogStateManager(dc: DialogContext, configuration?: DialogStateManagerConfiguration)

Parameter

dc

DialogContext

Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.

configuration

DialogStateManagerConfiguration

Konfiguration für den Dialogstatus-Manager.

Details zur Eigenschaft

configuration

Ruft die konfigurierten Pfadlöser und Speicherbereiche für den Dialogstatus-Manager ab oder legt sie fest.

configuration: DialogStateManagerConfiguration

Eigenschaftswert

DialogStateManagerConfiguration

Hinweise

Es gibt eine einzelne Gruppe von Konfigurationsinformationen für eine bestimmte Kette von Dialogkontexten. Durch das Zuweisen einer neuen Konfiguration zu einem DialogStateManager innerhalb der Kette wird die Konfiguration für die gesamte Kette aktualisiert.

Details zur Methode

anyPathChanged(number, string[])

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

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

Parameter

counter

number

Zeitzähler, mit dem verglichen werden soll.

paths

string[]

Pfade aus trackPaths(), die überprüft werden sollen.

Gibt zurück

boolean

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

deleteScopesMemory(string)

Löscht den gesamten Sicherungsspeicher für einen bestimmten Bereich.

function deleteScopesMemory(name: string): Promise<void>

Parameter

name

string

Name des Bereichs.

Gibt zurück

Promise<void>

deleteValue(string)

Eigenschaft aus dem Speicher löschen

function deleteValue(pathExpression: string)

Parameter

pathExpression

string

Die zu entfernende Blatteigenschaft.

getMemorySnapshot()

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

function getMemorySnapshot(): object

Gibt zurück

object

Objekt, das alle Speicherbereiche darstellt.

getValue<T>(string, T | () => T)

Rufen Sie den Wert aus dem Arbeitsspeicher mithilfe des Pfadausdrucks ab.

function getValue<T>(pathExpression: string, defaultValue?: T | () => T): T

Parameter

pathExpression

string

Pfadausdruck, der verwendet werden soll.

defaultValue

T | () => T

(Optional) Standardwert, der verwendet werden soll, wenn der Pfad nicht gefunden wird. Kann eine Funktion sein, die den zu verwendenden Standardwert zurückgibt.

Gibt zurück

T

Der gefundene Wert oder nicht definiert, wenn er nicht gefunden wurde, und kein defaultValue angegeben.

Hinweise

Dadurch wird immer ein CLONE des Arbeitsspeichers zurückgegeben, alle Änderungen am Ergebnis wirken sich nicht auf den Arbeitsspeicher aus.

loadAllScopes()

Stellt sicher, dass alle Speicherbereiche für die aktuelle Drehung geladen wurden.

function loadAllScopes(): Promise<void>

Gibt zurück

Promise<void>

Hinweise

Dies sollte am Anfang der Drehung aufgerufen werden.

parsePath(string, boolean)

Normalisiert die Pfadsegmente eines übergebenen Pfads.

function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]

Parameter

pathExpression

string

Der Pfad zum Normalisieren.

allowNestedPaths

boolean

Wahlfrei. Wenn false dann die Erkennung eines geschachtelten Pfads dazu führt, dass ein leerer Pfad zurückgegeben wird. Der Standardwert ist "true".

Gibt zurück

string | number[]

Der normalisierte Pfad.

Hinweise

Ein Pfad der profile.address[0] wird auf profile.address.0normalisiert.

saveAllChanges()

Speichert alle Änderungen, die an Speicherbereichen vorgenommen wurden.

function saveAllChanges(): Promise<void>

Gibt zurück

Promise<void>

Hinweise

Dies sollte am Ende der Drehung aufgerufen werden.

setValue(string, any)

Legen Sie den Speicher auf "Wert" fest.

function setValue(pathExpression: string, value: any)

Parameter

pathExpression

string

Pfad zum Speicher.

value

any

Festzulegende Wert.

trackPaths(string[])

Verfolgen Sie, wann bestimmte Pfade geändert werden.

function trackPaths(paths: string[]): string[]

Parameter

paths

string[]

Pfade, die nachverfolgt werden sollen.

Gibt zurück

string[]

Normalisierte Pfade, die an anyPathChanged()übergeben werden sollen.

transformPath(string)

Transformieren Sie den Pfad mithilfe der registrierten Pfadtransformatoren.

function transformPath(pathExpression: string): string

Parameter

pathExpression

string

Der Pfad zur Transformation.

Gibt zurück

string

Der transformierte Pfad.

version()

Ruft die Versionsnummer ab.

function version(): string

Gibt zurück

string

Eine Zeichenfolge mit der Versionsnummer.