BotState クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
状態管理オブジェクトを定義し、関連する状態プロパティの読み取りと書き込みをストレージ レイヤーに自動化します。
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManagertype BotState = class
interface IPropertyManagerPublic MustInherit Class BotState
Implements IPropertyManager- 継承
-
BotState
- 派生
- 実装
注釈
各状態管理オブジェクトは、ストレージ レイヤーのスコープを定義します。
状態プロパティは状態管理スコープ内に作成され、Bot Framework によって、、UserStateおよび PrivateConversationStateのConversationStateスコープが定義されます。
ボットの追加のスコープを定義できます。
コンストラクター
| BotState(IStorage, String) |
BotState クラスの新しいインスタンスを初期化します。 |
メソッド
| ClearStateAsync(ITurnContext, CancellationToken) |
この BotStateの状態キャッシュをクリアします。 |
| CreateProperty<T>(String) |
のスコープ BotState 内に名前付き状態プロパティを作成し、 プロパティのアクセサーを返します。 |
| DeleteAsync(ITurnContext, CancellationToken) |
ストレージ内の状態と、この BotStateのキャッシュを削除します。 |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
この BotStateの状態キャッシュからプロパティを削除します。 |
| Get(ITurnContext) |
ターン コンテキストから、この BotState の生キャッシュ データのコピーを取得します。 |
| GetCachedState(ITurnContext) |
ターン コンテキストから、この BotState キャッシュされた生データをラップするキャッシュされたボット状態インスタンスを取得します。 |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
この BotStateの状態キャッシュからプロパティの値を取得します。 |
| GetStorageKey(ITurnContext) |
派生クラスでオーバーライドされると、ストレージとの間で状態を読み書きするときに使用するキーを取得します。 |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
ストレージ レイヤーから、この BotState 状態キャッシュを設定します。 |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
この BotState 状態キャッシュをストレージ レイヤーに書き込みます。 |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
この BotStateの状態キャッシュ内のプロパティの値を設定します。 |