SettingsMemoryScope class

SettingsMemoryScope 映射“settings”-> dc.context.turnState['settings']

扩展

构造函数

SettingsMemoryScope(Record<string, unknown>)

初始化 SettingsMemoryScope 类的新实例。

继承属性

includeInSnapshot

获取一个值,该值指示是否应将此内存包含在快照中。

name

获取或设置范围的名称

方法

getMemory(DialogContext)

获取此范围的后盾内存。

load(DialogContext)

继承的方法

delete(DialogContext)

删除范围的后盾内存。

saveChanges(DialogContext)

在轮次结束时保存支持内存的范围。

setMemory(DialogContext, object)

更改内存范围的后盾对象。

构造函数详细信息

SettingsMemoryScope(Record<string, unknown>)

初始化 SettingsMemoryScope 类的新实例。

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

参数

initialSettings

Record<string, unknown>

要提供的初始设置集

继承属性详细信息

includeInSnapshot

获取一个值,该值指示是否应将此内存包含在快照中。

includeInSnapshot: boolean

属性值

boolean

继承自MemoryScope.includeInSnapshot

name

获取或设置范围的名称

name: string

属性值

string

继承自MemoryScope.name

方法详细信息

getMemory(DialogContext)

获取此范围的后盾内存。

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

参数

dc
DialogContext

此轮次的 DialogContext 对象。

返回

Record<string, unknown>

范围的内存。

load(DialogContext)

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

参数

dc
DialogContext

当前对话上下文。

返回

Promise<void>

继承的方法详细信息

delete(DialogContext)

删除范围的后盾内存。

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

参数

_dc
DialogContext

当前对话上下文。

返回

Promise<void>

继承自MemoryScope.delete

saveChanges(DialogContext)

在轮次结束时保存支持内存的范围。

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

参数

_dc
DialogContext

当前对话上下文。

返回

Promise<void>

继承自MemoryScope.saveChanges

setMemory(DialogContext, object)

更改内存范围的后盾对象。

function setMemory(_dc: DialogContext, _memory: object)

参数

_dc
DialogContext

当前对话上下文

_memory

object

要分配的内存

继承自MemoryScope.setMemory