BotStateMemoryScope class
Basisklasse für Speicherbereiche, die auf BotState basieren.
- Extends
Konstruktoren
| Bot |
Initialisiert eine neue Instanz der BotStateMemoryScope Klasse. |
Geerbte Eigenschaften
| include |
Ruft einen Wert ab, der angibt, ob dieser Speicher in momentaufnahme enthalten sein soll. |
| name | Ruft den Namen des Bereichs ab oder legt diesen fest. |
Methoden
| delete(Dialog |
Löscht jeden Zustand im Speicher und den Cache für diesen BotState-. |
| get |
Rufen Sie den Sicherungsspeicher für diesen Bereich ab. |
| load(Dialog |
Füllt den Statuscache für diesen BotState aus der Speicherebene auf. |
| save |
Schreibt den Statuscache für diesen BotState- in die Speicherebene. |
| set |
Ändert das Sicherungsobjekt für den Speicherbereich. |
Details zum Konstruktor
BotStateMemoryScope(string)
Initialisiert eine neue Instanz der BotStateMemoryScope Klasse.
new BotStateMemoryScope(name: string)Parameter
- name
-
string
Name der Eigenschaft.
Geerbte Eigenschaftsdetails
includeInSnapshot
Ruft einen Wert ab, der angibt, ob dieser Speicher in momentaufnahme enthalten sein soll.
includeInSnapshot: booleanEigenschaftswert
boolean
Geerbt vonMemoryScope.includeInSnapshot
name
Ruft den Namen des Bereichs ab oder legt diesen fest.
name: stringEigenschaftswert
string
geerbt vonMemoryScope.name
Details zur Methode
delete(DialogContext)
Löscht jeden Zustand im Speicher und den Cache für diesen BotState-.
function delete(_dc: DialogContext): Promise<void>Parameter
- _dc
- DialogContext
Das DialogContext Objekt für diese Drehung.
Gibt zurück
Promise<void>
Eine Zusage, die die auszuführende Arbeitswarteschlange darstellt.
getMemory(DialogContext)
Rufen Sie den Sicherungsspeicher für diesen Bereich ab.
function getMemory(dc: DialogContext): objectParameter
aktueller Dialogfeldkontext.
Gibt zurück
object
Speicher für den Bereich.
load(DialogContext, boolean)
Füllt den Statuscache für diesen BotState aus der Speicherebene auf.
function load(dc: DialogContext, force?: boolean): Promise<void>Parameter
Das DialogContext Objekt für diese Drehung.
- force
-
boolean
Optional, true alle vorhandenen Statuscaches zu überschreiben; oder false, den Zustand nur aus dem Speicher zu laden, wenn der Cache noch nicht vorhanden ist.
Gibt zurück
Promise<void>
Eine Zusage, die die auszuführende Arbeitswarteschlange darstellt.
saveChanges(DialogContext, boolean)
Schreibt den Statuscache für diesen BotState- in die Speicherebene.
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>Parameter
Das DialogContext Objekt für diese Drehung.
- force
-
boolean
Optional, true, um den Zustandscache im Speicher zu speichern; oder false, den Zustand nur im Speicher zu speichern, wenn sich eine Eigenschaft im Cache geändert hat.
Gibt zurück
Promise<void>
Eine Zusage, die die auszuführende Arbeitswarteschlange darstellt.
setMemory(DialogContext, object)
Ändert das Sicherungsobjekt für den Speicherbereich.
function setMemory(dc: DialogContext, _memory: object)Parameter
Aktueller Dialogfeldkontext
- _memory
-
object
Gedächtnis