BotStateSet class
1 つのユニットとして並列に読み込むか保存する必要があるプラグインのコレクション BotState 。
このクラスの実装については、 を参照してください AutoSaveStateMiddleware 。
コンストラクター
| Bot |
新しい BotStateSet インスタンスを作成します。 |
プロパティ
| bot |
セット |
メソッド
| add(Bot |
セットに 1 つ以上 |
| load |
セット内のすべての BotState プラグインを呼び出 |
| save |
セット内のすべての BotState プラグインを呼び出 |
コンストラクターの詳細
BotStateSet(BotState[])
新しい BotStateSet インスタンスを作成します。
new BotStateSet(botStates: BotState[])パラメーター
- botStates
-
BotState[]
登録する 1 つ以上の BotState プラグイン。
プロパティの詳細
botStates
メソッドの詳細
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);