SettingsMemoryScope class
SettingsMemoryScope mappe « settings » -> dc.context.turnState['settings']
- Extends
Constructeurs
Settings |
Initialise une nouvelle instance de la classe SettingsMemoryScope. |
Propriétés héritées
include |
Obtient une valeur indiquant si cette mémoire doit être incluse dans l’instantané. |
name | Obtient ou définit le nom de l’étendue |
Méthodes
get |
Obtient la mémoire de stockage pour cette étendue. |
load(Dialog |
Méthodes héritées
delete(Dialog |
Supprime la mémoire de stockage d’une étendue. |
save |
Enregistre une étendue de sauvegarde de la mémoire à la fin d’un tour. |
set |
Modifie l’objet de stockage pour l’étendue de mémoire. |
Détails du constructeur
SettingsMemoryScope(Record<string, unknown>)
Initialise une nouvelle instance de la classe SettingsMemoryScope.
new SettingsMemoryScope(initialSettings?: Record<string, unknown>)
Paramètres
- initialSettings
-
Record<string, unknown>
ensemble initial de paramètres à fournir
Détails de la propriété héritée
includeInSnapshot
Obtient une valeur indiquant si cette mémoire doit être incluse dans l’instantané.
includeInSnapshot: boolean
Valeur de propriété
boolean
héritée deMemoryScope.includeInSnapshot
name
Obtient ou définit le nom de l’étendue
name: string
Valeur de propriété
string
héritée deMemoryScope.name
Détails de la méthode
getMemory(DialogContext)
Obtient la mémoire de stockage pour cette étendue.
function getMemory(dc: DialogContext): Record<string, unknown>
Paramètres
Objet DialogContext pour ce tour.
Retours
Record<string, unknown>
Mémoire de l’étendue.
load(DialogContext)
function load(dc: DialogContext): Promise<void>
Paramètres
Contexte de boîte de dialogue actuel.
Retours
Promise<void>
Détails de la méthode héritée
delete(DialogContext)
Supprime la mémoire de stockage d’une étendue.
function delete(_dc: DialogContext): Promise<void>
Paramètres
- _dc
- DialogContext
Contexte de boîte de dialogue actuel.
Retours
Promise<void>
héritée deMemoryScope.delete
saveChanges(DialogContext)
Enregistre une étendue de sauvegarde de la mémoire à la fin d’un tour.
function saveChanges(_dc: DialogContext): Promise<void>
Paramètres
- _dc
- DialogContext
Contexte de boîte de dialogue actuel.
Retours
Promise<void>
héritée deMemoryScope.saveChanges
setMemory(DialogContext, object)
Modifie l’objet de stockage pour l’étendue de mémoire.
function setMemory(_dc: DialogContext, _memory: object)
Paramètres
- _dc
- DialogContext
Contexte de boîte de dialogue actuel
- _memory
-
object
mémoire à affecter
héritée deMemoryScope.setMemory