BotStateSet class

パッケージ:

botbuilder-core

1 つのユニットとして並列に読み込むか、並列に保存する必要がある BotState プラグインのコレクション。 このクラスの実装については、AutoSaveStateMiddleware を参照してください。

コンストラクター

BotStateSet(BotState[])

新しい BotStateSet インスタンスを作成します。

プロパティ

botStates

プラグイン BotState セットの配列。

メソッド

add(BotState[])	セットに 1 つ以上の BotState プラグインを登録します。
loadAll(TurnContext, boolean)	セット内のすべての BotState プラグインで BotState.load() を呼び出します。
saveAllChanges(TurnContext, boolean)	セット内のすべての BotState プラグインで BotState.saveChanges() を呼び出します。

コンストラクターの詳細

BotStateSet(BotState[])

新しい BotStateSet インスタンスを作成します。

new BotStateSet(botStates: BotState[])

パラメーター

botStates

BotState[]

登録する 1 つ以上の BotState プラグイン。

プロパティの詳細

botStates

プラグイン BotState セットの配列。

botStates: BotState[]

プロパティ値

BotState[]

メソッドの詳細

add(BotState[])

セットに 1 つ以上の BotState プラグインを登録します。

function add(botStates: BotState[]): this

パラメーター

botStates

BotState[]

登録する 1 つ以上の 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);