DialogClassMemoryScope class

Package:

botbuilder-dialogs

DialogClassMemoryScope maps "dialogClass" -> dc.parent.activeDialog.properties

Extends

ClassMemoryScope

Constructors

DialogClassMemoryScope()

Initializes a new instance of the DialogClassMemoryScope class.

Inherited Properties

includeInSnapshot	Gets a value indicating whether this memory should be included in snapshot.
name	Gets or sets name of the scope

Inherited Methods

delete(DialogContext)	Deletes the backing memory for a scope.
getMemory(DialogContext)	Gets the backing memory for this 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.
setMemory(DialogContext, object)	Changes the backing object for the memory scope.

Constructor Details

DialogClassMemoryScope()

Initializes a new instance of the DialogClassMemoryScope class.

new DialogClassMemoryScope()

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

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

getMemory(DialogContext)

Gets the backing memory for this scope.

function getMemory(dc: DialogContext): object

Parameters

dc

DialogContext

The DialogContext object for this turn.

Returns

object

The memory for the scope.

Inherited From ClassMemoryScope.getMemory

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

setMemory(DialogContext, object)

Changes the backing object for the memory scope.

function setMemory(_dc: DialogContext, _memory: object)

Parameters

_dc

DialogContext

Current dialog context

_memory

object

memory to assign

Inherited From MemoryScope.setMemory