Partager via


UserMemoryScope class

Mémoire étendue à l’utilisateur actuel.

Extends

Constructeurs

UserMemoryScope()

Initialise une nouvelle instance de la classe UserMemoryScope.

Propriétés héritées

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 héritées

delete(DialogContext)

Supprime n’importe quel état dans le stockage et le cache de ce BotState.

getMemory(DialogContext)

Obtenez la mémoire de stockage pour cette étendue.

load(DialogContext, boolean)

Remplit le cache d’état de cette BotState à partir de la couche de stockage.

saveChanges(DialogContext, boolean)

Écrit le cache d’état de cette BotState dans la couche de stockage.

setMemory(DialogContext, object)

Modifie l’objet de stockage pour l’étendue de mémoire.

Détails du constructeur

UserMemoryScope()

Initialise une nouvelle instance de la classe UserMemoryScope.

new UserMemoryScope()

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 héritée

delete(DialogContext)

Supprime n’importe quel état dans le stockage et le cache de ce BotState.

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

Paramètres

_dc
DialogContext

Objet DialogContext pour ce tour.

Retours

Promise<void>

Promesse qui représente le travail mis en file d’attente à exécuter.

héritée deBotStateMemoryScope.delete

getMemory(DialogContext)

Obtenez la mémoire de stockage pour cette étendue.

function getMemory(dc: DialogContext): object

Paramètres

dc
DialogContext

contexte de boîte de dialogue actuel.

Retours

object

Mémoire de l’étendue.

héritée deBotStateMemoryScope.getMemory

load(DialogContext, boolean)

Remplit le cache d’état de cette BotState à partir de la couche de stockage.

function load(dc: DialogContext, force?: boolean): Promise<void>

Paramètres

dc
DialogContext

Objet DialogContext pour ce tour.

force

boolean

Facultatif, true remplacer tout cache d’état existant ; ou false de charger l’état à partir du stockage uniquement si le cache n’existe pas déjà.

Retours

Promise<void>

Promesse qui représente le travail mis en file d’attente à exécuter.

héritée deBotStateMemoryScope.load

saveChanges(DialogContext, boolean)

Écrit le cache d’état de cette BotState dans la couche de stockage.

function saveChanges(dc: DialogContext, force?: boolean): Promise<void>

Paramètres

dc
DialogContext

Objet DialogContext pour ce tour.

force

boolean

Facultatif, true pour enregistrer le cache d’état dans le stockage ; ou false pour enregistrer l’état dans le stockage uniquement si une propriété dans le cache a changé.

Retours

Promise<void>

Promesse qui représente le travail mis en file d’attente à exécuter.

héritée deBotStateMemoryScope.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

héritée deBotStateMemoryScope.setMemory