BotState class

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

new BotState(storage: Storage, storageKey: StorageKeyFactory)

パラメーター

ターンの現在の状態オブジェクトをクリアします。

function clear(context: TurnContext): Promise<void>

パラメーター

戻り値

非同期操作を表す promise。

注釈

saveChanges() が呼び出されるまで、クリア状態オブジェクトは保持されません。

await botState.clear(context);
await botState.saveChanges(context);

個々のプロパティを読み取り、ボット状態のストレージ オブジェクトに書き込む新しいプロパティ アクセサーを作成します。

function createProperty<T>(name: string): StatePropertyAccessor<T>

パラメーター

戻り値

プロパティのアクセサー。

現在のターンのバッキング状態オブジェクトを削除します。

function delete(context: TurnContext): Promise<void>

パラメーター

戻り値

非同期操作を表す promise。

注釈

状態オブジェクトが存在する場合、ストレージから削除されます。 状態オブジェクトが読み取られ、キャッシュされている場合、キャッシュはクリアされます。

await botState.delete(context);

キャッシュされた状態オブジェクトを返します。キャッシュされていない場合は未定義です。

function get(context: TurnContext): any | undefined

パラメーター

戻り値

キャッシュされた状態オブジェクト。キャッシュされていない場合は未定義です。

注釈

この例では、既に読み込まれ、キャッシュされた状態オブジェクトを同期的に取得する方法を示します。

const state = botState.get(context);

を読み取り、ターンのバッキング状態オブジェクトをキャッシュします。

function load(context: TurnContext, force?: boolean): Promise<any>

パラメーター

戻り値

キャッシュされた状態。

注釈

後続の読み取りでは、状態オブジェクトを強制的に force 再読み取りするフラグが渡されない限り、キャッシュされたオブジェクトが返されます。

このメソッドは、作成されたプロパティ アクセサーの最初のアクセス時に自動的に呼び出されます。

const state = await botState.load(context);

キャッシュされた状態オブジェクトが変更された場合は保存します。

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

パラメーター

戻り値

非同期操作を表す promise。

注釈

フラグが force キャッシュ状態オブジェクトに渡されると、そのフラグが変更されているかどうかに関係なく保存され、オブジェクトがキャッシュされていない場合は、空のオブジェクトが作成されて保存されます。

await botState.saveChanges(context);