Freigeben über

SettingsMemoryScope class

  • Referenz
Paket:
botbuilder-dialogs

SettingsMemoryScope ordnet "settings" zu -> dc.context.turnState['settings']

Extends
MemoryScope

Konstruktoren

SettingsMemoryScope(Record<string, unknown>)

Initialisiert eine neue Instanz der SettingsMemoryScope Klasse.

Geerbte Eigenschaften

includeInSnapshot

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

getMemory(DialogContext)

Ruft den Sicherungsspeicher für diesen Bereich ab.
load(DialogContext)

Geerbte Methoden

delete(DialogContext)

Löscht den Sicherungsspeicher für einen Bereich.
saveChanges(DialogContext)

Speichert einen Bereich, der den Speicher am Ende einer Drehung zurückgibt.
setMemory(DialogContext, object)

Ändert das Sicherungsobjekt für den Speicherbereich.

Details zum Konstruktor

SettingsMemoryScope(Record<string, unknown>)

Initialisiert eine neue Instanz der SettingsMemoryScope Klasse.

new SettingsMemoryScope(initialSettings?: Record<string, unknown>)

Parameter

initialSettings

Record<string, unknown>

Anfänglicher Satz von Einstellungen, die zur Verfügung gestellt werden sollen

Geerbte Eigenschaftsdetails

includeInSnapshot

Ruft einen Wert ab, der angibt, ob dieser Speicher in momentaufnahme enthalten sein soll.

includeInSnapshot: boolean

Eigenschaftswert

boolean

Geerbt vonMemoryScope.includeInSnapshot

name

Ruft den Namen des Bereichs ab oder legt diesen fest.

name: string

Eigenschaftswert

string

geerbt vonMemoryScope.name

Details zur Methode

getMemory(DialogContext)

Ruft den Sicherungsspeicher für diesen Bereich ab.

function getMemory(dc: DialogContext): Record<string, unknown>

Parameter

dc
DialogContext

Das DialogContext Objekt für diese Drehung.

Gibt zurück

Record<string, unknown>

Der Speicher für den Bereich.

load(DialogContext) 

function load(dc: DialogContext): Promise<void>

Parameter

dc
DialogContext

Aktueller Dialogfeldkontext.

Gibt zurück

Promise<void>

Details zur geerbten Methode

delete(DialogContext)

Löscht den Sicherungsspeicher für einen Bereich.

function delete(_dc: DialogContext): Promise<void>

Parameter

_dc
DialogContext

Aktueller Dialogfeldkontext.

Gibt zurück

Promise<void>

vonMemoryScope.delete geerbt

saveChanges(DialogContext)

Speichert einen Bereich, der den Speicher am Ende einer Drehung zurückgibt.

function saveChanges(_dc: DialogContext): Promise<void>

Parameter

_dc
DialogContext

Aktueller Dialogfeldkontext.

Gibt zurück

Promise<void>

Geerbt vonMemoryScope.saveChanges

setMemory(DialogContext, object)

Ändert das Sicherungsobjekt für den Speicherbereich.

function setMemory(_dc: DialogContext, _memory: object)

Parameter

_dc
DialogContext

Aktueller Dialogfeldkontext

_memory

object

Speicher, der zugewiesen werden soll

geerbt vonMemoryScope.setMemory