BotStatePropertyAccessor class
インターフェイスの BotState 特定の StatePropertyAccessor 実装。
注釈
プロパティは、 を使用して特定 BotState のインスタンスに対して createProperty()定義できます。
const dialogStateProperty = ConversationState.createProperty('dialogState');
const dialogs = new DialogSet(dialogStateProperty);
コンストラクター
| Bot |
新しい BotStatePropertyAccessor インスタンスを作成します。 |
プロパティ
| name |
メソッド
| delete(Turn |
バッキング ストレージ オブジェクトから永続化されたプロパティを削除します。 |
| get(Turn |
バッキング ストレージ オブジェクトから永続化されたプロパティを読み取ります。 |
| get(Turn |
|
| set(Turn |
ストレージ オブジェクトをバッキングするプロパティに新しい値を割り当てます。 |
コンストラクターの詳細
BotStatePropertyAccessor(BotState, string)
新しい BotStatePropertyAccessor インスタンスを作成します。
new BotStatePropertyAccessor(state: BotState, name: string)パラメーター
- state
- BotState
親 BotState インスタンス。
- name
-
string
親 BotState のプロパティの一意の名前。
プロパティの詳細
name
name: stringプロパティ値
string
メソッドの詳細
delete(TurnContext)
バッキング ストレージ オブジェクトから永続化されたプロパティを削除します。
function delete(context: TurnContext): Promise<void>パラメーター
- context
- TurnContext
(xref:botbuilder-core。このターンの TurnContext) オブジェクト。
戻り値
Promise<void>
get(TurnContext)
バッキング ストレージ オブジェクトから永続化されたプロパティを読み取ります。
function get(context: TurnContext): Promise<T | undefined>パラメーター
- context
- TurnContext
(xref:botbuilder-core。このターンの TurnContext) オブジェクト。
戻り値
Promise<T | undefined>
キャッシュされた状態の JSON 表現。
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
(xref:botbuilder-core。このターンの TurnContext) オブジェクト。
- value
-
T
プロパティに設定する値。
戻り値
Promise<void>