BotStateMemoryScope class
基于 BotState 的内存范围的基类。
- 扩展
构造函数
Bot |
初始化 BotStateMemoryScope 类的新实例。 |
继承属性
include |
获取一个值,该值指示是否应将此内存包含在快照中。 |
name | 获取或设置范围的名称 |
方法
delete(Dialog |
删除此 BotState存储中的任何状态和缓存。 |
get |
获取此范围的后盾内存。 |
load(Dialog |
从存储层填充此 BotState 的状态缓存。 |
save |
|
set |
更改内存范围的后盾对象。 |
构造函数详细信息
BotStateMemoryScope(string)
继承属性详细信息
includeInSnapshot
name
获取或设置范围的名称
name: string
属性值
string
继承自
方法详细信息
delete(DialogContext)
删除此 BotState存储中的任何状态和缓存。
function delete(_dc: DialogContext): Promise<void>
参数
- _dc
- DialogContext
此轮次的 DialogContext 对象。
返回
Promise<void>
表示要执行的工作的 Promise。
getMemory(DialogContext)
获取此范围的后盾内存。
function getMemory(dc: DialogContext): object
参数
当前对话上下文。
返回
object
范围的内存。
load(DialogContext, boolean)
从存储层填充此 BotState 的状态缓存。
function load(dc: DialogContext, force?: boolean): Promise<void>
参数
此轮次的 DialogContext 对象。
- force
-
boolean
可选,true
覆盖任何现有状态缓存;或 false
仅当缓存尚不存在时,才能从存储加载状态。
返回
Promise<void>
表示要执行的工作的 Promise。
saveChanges(DialogContext, boolean)
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>
参数
此轮次的 DialogContext 对象。
- force
-
boolean
可选,true
将状态缓存保存到存储;或 false
仅当缓存中的属性已更改时,才会将状态保存到存储。
返回
Promise<void>
表示要执行的工作的 Promise。
setMemory(DialogContext, object)
更改内存范围的后盾对象。
function setMemory(dc: DialogContext, _memory: object)
参数
当前对话上下文
- _memory
-
object
记忆