TurnMemoryScope class

TurnMemoryScope represents memory scoped to the current turn.

Extends

Constructors

TurnMemoryScope()

Initializes a new instance of the TurnMemoryScope class.

Inherited Properties

includeInSnapshot

Gets a value indicating whether this memory should be included in snapshot.

name

Gets or sets name of the scope

Methods

getMemory(DialogContext)

Get the backing memory for this scope.

setMemory(DialogContext, object)

Changes the backing object for the memory scope.

Inherited Methods

delete(DialogContext)

Deletes the backing memory for a scope.

load(DialogContext)

Loads a scopes backing memory at the start of a turn.

saveChanges(DialogContext)

Saves a scopes backing memory at the end of a turn.

Constructor Details

TurnMemoryScope()

Initializes a new instance of the TurnMemoryScope class.

new TurnMemoryScope()

Inherited Property Details

includeInSnapshot

Gets a value indicating whether this memory should be included in snapshot.

includeInSnapshot: boolean

Property Value

boolean

Inherited From MemoryScope.includeInSnapshot

name

Gets or sets name of the scope

name: string

Property Value

string

Inherited From MemoryScope.name

Method Details

getMemory(DialogContext)

Get the backing memory for this scope.

function getMemory(dc: DialogContext): object

Parameters

dc
DialogContext

The DialogContext for this turn.

Returns

object

The memory for the scope.

setMemory(DialogContext, object)

Changes the backing object for the memory scope.

function setMemory(dc: DialogContext, memory: object)

Parameters

dc
DialogContext

The DialogContext for this turn.

memory

object

Memory object to set for the scope.

Inherited Method Details

delete(DialogContext)

Deletes the backing memory for a scope.

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

Parameters

_dc
DialogContext

Current dialog context.

Returns

Promise<void>

Inherited From MemoryScope.delete

load(DialogContext)

Loads a scopes backing memory at the start of a turn.

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

Parameters

_dc
DialogContext

Current dialog context.

Returns

Promise<void>

Inherited From MemoryScope.load

saveChanges(DialogContext)

Saves a scopes backing memory at the end of a turn.

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

Parameters

_dc
DialogContext

Current dialog context.

Returns

Promise<void>

Inherited From MemoryScope.saveChanges