StatePropertyAccessor interface
BotState オブジェクトで作成された状態プロパティにアクセスするためのメソッドを定義します。
注釈
状態管理オブジェクトで状態プロパティを作成するには、createProperty<T> メソッドを使用します。
メソッド
| delete(Turn |
バッキング ストレージ オブジェクトから永続化されたプロパティを削除します。 |
| get(Turn |
バッキング ストレージ オブジェクトから永続化されたプロパティを読み取ります。 |
| get(Turn |
|
| set(Turn |
ストレージ オブジェクトをバッキングするプロパティに新しい値を割り当てます。 |
メソッドの詳細
delete(TurnContext)
バッキング ストレージ オブジェクトから永続化されたプロパティを削除します。
function delete(context: TurnContext): Promise<void>パラメーター
- context
- TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
戻り値
Promise<void>
注釈
ストレージ オブジェクトをバッキングするプロパティは、最初のアクセス時にメモリに読み込む必要があります (SHOULD)。
await myProperty.delete(context);
get(TurnContext)
バッキング ストレージ オブジェクトから永続化されたプロパティを読み取ります。
function get(context: TurnContext): Promise<T | undefined>パラメーター
- context
- TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
戻り値
Promise<T | undefined>
注釈
ストレージ オブジェクトをバッキングするプロパティは、最初のアクセス時にメモリに読み込む必要があります (SHOULD)。
プロパティがストレージ オブジェクトに現在存在せず、defaultValue が指定されている場合は、defaultValue の複製をストレージ オブジェクトにコピーする必要があります (SHOULD)。
defaultValue が指定されていない場合は、undefined の値を返す必要があります。
const value = await myProperty.get(context, { count: 0 });
get(TurnContext, T)
function get(context: TurnContext, defaultValue: T): Promise<T>パラメーター
- context
- TurnContext
- defaultValue
-
T
戻り値
Promise<T>
set(TurnContext, T)
ストレージ オブジェクトをバッキングするプロパティに新しい値を割り当てます。
function set(context: TurnContext, value: T): Promise<void>パラメーター
- context
- TurnContext
ユーザーとの会話の現在のターンのコンテキスト。
- value
-
T
割り当てる値。
戻り値
Promise<void>
注釈
ストレージ オブジェクトをバッキングするプロパティは、最初のアクセス時にメモリに読み込む必要があります (SHOULD)。
状態システムの実装によっては、実際の変更をディスクに保持するために追加の手順が必要になる場合があります。
await myProperty.set(context, value);