SettingsMemoryScope class

Package:

botbuilder-dialogs

SettingsMemoryScope maps "settings" -> dc.context.turnState['settings']

Extends

MemoryScope

Constructors

SettingsMemoryScope(Record<string, unknown>)

Initializes a new instance of the SettingsMemoryScope 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)	Gets the backing memory for this scope.
load(DialogContext)

Inherited Methods

delete(DialogContext)	Deletes the backing memory for a scope.
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

SettingsMemoryScope(Record<string, unknown>)

Initializes a new instance of the SettingsMemoryScope class.

new SettingsMemoryScope(initialSettings?: Record<string, unknown>)

Parameters

initialSettings

Record<string, unknown>

initial set of settings to supply

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)

Gets the backing memory for this scope.

function getMemory(dc: DialogContext): Record<string, unknown>

Parameters

dc

DialogContext

The DialogContext object for this turn.

Returns

Record<string, unknown>

The memory for the scope.

load(DialogContext)

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

Parameters

dc

DialogContext

Current dialog context.

Returns

Promise<void>

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

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