Class ClassMemoryScope

A memory scope that provides access to the properties of the active dialog. This scope binds to the active dialog and clones its properties for use in memory.

Hierarchy (View Summary)

MemoryScope
- ClassMemoryScope
  - DialogClassMemoryScope

Index

Constructors

Properties

includeInSnapshot name

Methods

delete getMemory load onFindDialog saveChanges setMemory

Constructors

constructor

new ClassMemoryScope(name?: string): ClassMemoryScope
Initializes a new instance of the ClassMemoryScope class.
Parameters
- name: string = ScopePath.class
  Name of the scope class. Defaults to ScopePath.class.
Returns ClassMemoryScope
Overrides MemoryScope.constructor
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/classMemoryScope.ts:20

Properties

`Readonly`includeInSnapshot

includeInSnapshot: boolean

`Readonly`name

name: string

Methods

delete

delete(_dialogContext: DialogContext): Promise<void>
Deletes the backing memory for a scope.
Parameters
- _dialogContext: DialogContext
  Current dialog context.
Returns Promise<void>
Inherited from MemoryScope.delete
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/memoryScope.ts:74

getMemory

getMemory(dialogContext: DialogContext): object
Gets the backing memory for this scope.
Parameters
- dialogContext: DialogContext
  The DialogContext object for this turn.
Returns object
The memory for the scope, containing cloned properties of the active dialog.
Overrides MemoryScope.getMemory
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/classMemoryScope.ts:30

load

load(_dialogContext: DialogContext): Promise<void>
Loads a scopes backing memory at the start of a turn.
Parameters
- _dialogContext: DialogContext
  Current dialog context.
Returns Promise<void>
Inherited from MemoryScope.load
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/memoryScope.ts:56

`Protected`onFindDialog

onFindDialog(dialogContext: DialogContext): Dialog<{}>
Override to find the dialog instance referenced by the scope.
Parameters
- dialogContext: DialogContext
  Current dialog context.
Returns Dialog<{}>
The dialog instance referenced by the scope, or undefined if not found.
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/classMemoryScope.ts:64

saveChanges

saveChanges(_dialogContext: DialogContext): Promise<void>
Saves a scopes backing memory at the end of a turn.
Parameters
- _dialogContext: DialogContext
  Current dialog context.
Returns Promise<void>
Inherited from MemoryScope.saveChanges
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/memoryScope.ts:65

setMemory

setMemory(_dialogContext: DialogContext, _memory: object): void
Changes the backing object for the memory scope.
Parameters
- _dialogContext: DialogContext
  Current dialog context
- _memory: object
  memory to assign
Returns void
Inherited from MemoryScope.setMemory
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/memoryScope.ts:42