BotStateSet class
应作为单个单元并行加载或保存的 BotState 插件的集合。
有关此类的实现，请参阅 AutoSaveStateMiddleware。
构造函数
| Bot |
创建新的 BotStateSet 实例。 |
属性
| bot |
|
方法
| add(Bot |
向集注册一个或多个 |
| load |
对集中所有 BotState 插件调用 |
| save |
对集中所有 BotState 插件调用 |
构造函数详细信息
BotStateSet(BotState[])
创建新的 BotStateSet 实例。
new BotStateSet(botStates: BotState[])参数
- botStates
-
BotState[]
要注册的一个或多个 BotState 插件。
属性详细信息
botStates
方法详细信息
add(BotState[])
向集注册一个或多个 BotState 插件。
function add(botStates: BotState[]): this参数
- botStates
-
BotState[]
要注册的一个或多个 BotState 插件。
返回
this
更新后的 BotStateSet。
loadAll(TurnContext, boolean)
对集中所有 BotState 插件调用 BotState.load()。
function loadAll(context: TurnContext, force?: boolean): Promise<void>参数
- context
- TurnContext
与用户的当前会话轮次的上下文。
- force
-
boolean
（可选）如果 true 将绕过缓存，并且状态始终直接从存储中读取。 默认为 false。
返回
Promise<void>
注解
这会触发所有插件以并行状态读取。
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
对集中所有 BotState 插件调用 BotState.saveChanges()。
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>参数
- context
- TurnContext
与用户的当前会话轮次的上下文。
- force
-
boolean
（可选）如果 true 状态将始终写出，而不考虑其更改状态。 默认为 false。
返回
Promise<void>
注解
这会触发所有插件以并行写出其状态。
await stateSet.saveAllChanges(context);