Class DialogContextMemoryScope

A memory scope that provides access to the dialog context. This scope includes information about the active dialog, its parent, and the dialog stack.

Hierarchy (View Summary)

MemoryScope
- DialogContextMemoryScope

Index

Constructors

Properties

includeInSnapshot name

Methods

delete getMemory load saveChanges setMemory

Constructors

constructor

new DialogContextMemoryScope(): DialogContextMemoryScope
Initializes a new instance of the DialogContextMemoryScope class.

Returns DialogContextMemoryScope
Overrides MemoryScope.constructor
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/dialogContextMemoryScope.ts:18

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,
): Record<"stack" | "activeDialog" | "parent", unknown>
Gets the backing memory for this scope.
Parameters
- dialogContext: DialogContext
  The DialogContext object for this turn.
Returns Record<"stack" | "activeDialog" | "parent", unknown>
An object containing the dialog stack, active dialog ID, and parent dialog ID.
Overrides MemoryScope.getMemory
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/dialogContextMemoryScope.ts:28

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

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