InspectionState class
警告
この API は非推奨になりました。
This class will be removed in a future version of the framework.
実行時アクティビティと BotState のエミュレーター検査のために InspectionMiddleware によって使用される InspectionState。
- Extends
-
BotState
注釈
実行時アクティビティと BotState のエミュレーター検査のために InspectionMiddleware によって使用される InspectionState。
コンストラクター
Inspection |
InspectionState クラスの新しいインスタンスを作成します。 |
継承されたメソッド
clear(Turn |
ターンの現在の状態オブジェクトをクリアします。 |
create |
個々のプロパティを読み取り、ボット状態ストレージ オブジェクトに書き込むための新しいプロパティ アクセサーを作成します。 |
delete(Turn |
現在のターンのバッキング状態オブジェクトを削除します。 |
get(Turn |
キャッシュされた状態オブジェクトを返すか、キャッシュされていない場合は未定義を返します。 |
load(Turn |
ターンのバッキング状態オブジェクトを読み取ってキャッシュします。 |
save |
キャッシュされた状態オブジェクトが変更された場合に保存します。 |
コンストラクターの詳細
InspectionState(Storage)
InspectionState クラスの新しいインスタンスを作成します。
new InspectionState(storage: Storage)
パラメーター
- storage
-
Storage
この状態管理オブジェクトが状態の格納と取得に使用する ストレージ レイヤー。
継承済みメソッドの詳細
clear(TurnContext)
ターンの現在の状態オブジェクトをクリアします。
function clear(context: TurnContext): Promise<void>
パラメーター
- context
-
TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
戻り値
Promise<void>
非同期操作を表す promise。
注釈
saveChanges() が呼び出されるまで、クリア状態オブジェクトは保持されません。
await botState.clear(context);
await botState.saveChanges(context);
継承元 BotState.clear
createProperty<T>(string)
個々のプロパティを読み取り、ボット状態ストレージ オブジェクトに書き込むための新しいプロパティ アクセサーを作成します。
function createProperty<T>(name: string): StatePropertyAccessor<T>
パラメーター
- name
-
string
追加するプロパティの名前。
戻り値
StatePropertyAccessor<T>
プロパティのアクセサー。
継承元 BotState.createProperty
delete(TurnContext)
現在のターンのバッキング状態オブジェクトを削除します。
function delete(context: TurnContext): Promise<void>
パラメーター
- context
-
TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
戻り値
Promise<void>
非同期操作を表す promise。
注釈
状態オブジェクトが存在する場合、ストレージから削除されます。 状態オブジェクトが読み取られ、キャッシュされている場合、キャッシュはクリアされます。
await botState.delete(context);
継承元 BotState.delete
get(TurnContext)
キャッシュされた状態オブジェクトを返すか、キャッシュされていない場合は未定義を返します。
function get(context: TurnContext): any | undefined
パラメーター
- context
-
TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
戻り値
any | undefined
キャッシュされた状態オブジェクト。キャッシュされていない場合は未定義です。
注釈
この例では、既に読み込まれ、キャッシュされている状態オブジェクトを同期的に取得する方法を示します。
const state = botState.get(context);
継承元 BotState.get
load(TurnContext, boolean)
ターンのバッキング状態オブジェクトを読み取ってキャッシュします。
function load(context: TurnContext, force?: boolean): Promise<any>
パラメーター
- context
-
TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
- force
-
boolean
(省略可能)キャッシュがバイパスされ、状態が常にストレージから直接読み込まれる場合 true
。 既定値は false
です。
戻り値
Promise<any>
キャッシュされた状態。
注釈
後続の読み取りでは、状態オブジェクトを強制的に再読み取りするフラグが渡されない限り force
、キャッシュされたオブジェクトが返されます。
このメソッドは、作成されたプロパティ アクセサーの最初のアクセス時に自動的に呼び出されます。
const state = await botState.load(context);
継承元 BotState.load
saveChanges(TurnContext, boolean)
キャッシュされた状態オブジェクトが変更された場合に保存します。
function saveChanges(context: TurnContext, force?: boolean): Promise<void>
パラメーター
- context
-
TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
- force
-
boolean
(省略可能) 状態が変更状態に関係なく常に書き出される場合 true
。 既定値は false
です。
戻り値
Promise<void>
非同期操作を表す promise。
注釈
フラグが force
キャッシュされた状態オブジェクトに渡された場合、そのフラグが変更されているかどうかに関係なく保存され、オブジェクトがキャッシュされていない場合は、空のオブジェクトが作成されて保存されます。
await botState.saveChanges(context);
継承元 BotState.saveChanges