MemoryScope class

Paquet:

botbuilder-dialogs

Classe de base abstraite pour toutes les étendues de mémoire.

Constructeurs

MemoryScope(string, boolean)

Initialise une nouvelle instance de la classe MemoryScope .

Propriétés

includeInSnapshot	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

delete(DialogContext)	Supprime la mémoire de stockage d’une étendue.
getMemory(DialogContext)	Obtenir la mémoire de stockage pour cette étendue
load(DialogContext)	Charge une mémoire de stockage d’étendues au début d’un tour.
saveChanges(DialogContext)	Enregistre une mémoire de sauvegarde des étendues à la fin d’un tour.
setMemory(DialogContext, object)	Modifie l’objet de stockage pour l’étendue de mémoire.

Détails du constructeur

MemoryScope(string, boolean)

Initialise une nouvelle instance de la classe MemoryScope .

new MemoryScope(name: string, includeInSnapshot?: boolean)

Paramètres

name

string

Nom de l’étendue.

includeInSnapshot

boolean

Valeur booléenne indiquant si cette mémoire doit être incluse dans l’instantané. La valeur par défaut est true.

Détails de la propriété

includeInSnapshot

Obtient une valeur indiquant si cette mémoire doit être incluse dans l’instantané.

includeInSnapshot: boolean

Valeur de propriété

boolean

name

Obtient ou définit le nom de l’étendue

name: string

Valeur de propriété

string

Détails de la méthode

delete(DialogContext)

Supprime la mémoire de stockage d’une étendue.

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

Paramètres

_dc

DialogContext

Contexte de dialogue actuel.

Retours

Promise<void>

getMemory(DialogContext)

Obtenir la mémoire de stockage pour cette étendue

function getMemory(dc: DialogContext): object

Paramètres

dc

DialogContext

Contexte de dialogue actuel.

Retours

object

mémoire pour l’étendue

load(DialogContext)

Charge une mémoire de stockage d’étendues au début d’un tour.

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

Paramètres

_dc

DialogContext

Contexte de dialogue actuel.

Retours

Promise<void>

saveChanges(DialogContext)

Enregistre une mémoire de sauvegarde des étendues à la fin d’un tour.

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

Paramètres

_dc

DialogContext

Contexte de dialogue actuel.

Retours

Promise<void>

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 dialogue actuel

_memory

object

mémoire à affecter