BotStateSet class

包:

botbuilder-core

应作为单个单元并行加载或保存的插件集合 BotState 。 有关此类的实现，请参阅 AutoSaveStateMiddleware 。

构造函数

BotStateSet(BotState[])

创建新的 BotStateSet 实例。

属性

botStates

集 BotState 插件的数组。

方法

add(BotState[])	向 集注册一个或多个 BotState 插件。
loadAll(TurnContext, boolean)	对 BotState.load() 集中的所有 BotState 插件调用。
saveAllChanges(TurnContext, boolean)	对 BotState.saveChanges() 集中的所有 BotState 插件调用。

构造函数详细信息

BotStateSet(BotState[])

创建新的 BotStateSet 实例。

new BotStateSet(botStates: BotState[])

参数

botStates

BotState[]

要注册的一个或多个 BotState 插件。

属性详细信息

botStates

集 BotState 插件的数组。

botStates: BotState[]

属性值

BotState[]

方法详细信息

add(BotState[])

向 集注册一个或多个 BotState 插件。

function add(botStates: BotState[]): this

参数

botStates

BotState[]

要注册的一个或多个 BotState 插件。

返回

this

更新后的 BotStateSet。

loadAll(TurnContext, boolean)

对 BotState.load() 集中的所有 BotState 插件调用。

function loadAll(context: TurnContext, force?: boolean): Promise<void>

参数

context

TurnContext

与用户当前轮次对话的上下文。

force

boolean

(可选) 如果 true 将绕过缓存，并且始终直接从存储中读取状态。 默认为 false。

返回

Promise<void>

注解

这将触发所有插件并行读取其状态。

await stateSet.readAll(context);

saveAllChanges(TurnContext, boolean)

对 BotState.saveChanges() 集中的所有 BotState 插件调用。

function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>

参数

context

TurnContext

与用户当前轮次对话的上下文。

force

boolean

(可选) ，如果 true 无论其更改状态如何，都会始终写出状态。 默认为 false。

返回

Promise<void>

注解

这将触发所有插件并行写出其状态。

await stateSet.saveAllChanges(context);