Class TurnMemoryScope

A memory scope that provides access to the turn's state. This scope is used to store and retrieve information specific to the current turn.

Hierarchy (View Summary)

MemoryScope
- TurnMemoryScope

Index

Constructors

Properties

includeInSnapshot name

Methods

delete getMemory load saveChanges setMemory

Constructors

constructor

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

Returns TurnMemoryScope
Overrides MemoryScope.constructor
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/turnMemoryScope.ts:24

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.
Overrides MemoryScope.getMemory
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/turnMemoryScope.ts:34

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
  The DialogContext object for this turn.
- memory: object
  Memory object to set for the scope.
Returns void
Overrides MemoryScope.setMemory
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/turnMemoryScope.ts:50