UserState クラス

  • リファレンス

定義

名前空間:
Microsoft.Bot.Builder
アセンブリ:
Microsoft.Bot.Builder.dll
パッケージ:
Microsoft.Bot.Builder v4.18.1

ユーザー状態の状態管理オブジェクトを定義します。

public class UserState : Microsoft.Bot.Builder.BotState
type UserState = class
    inherit BotState
Public Class UserState
Inherits BotState
継承
Object
BotState
UserState

注釈

ユーザーの状態は、会話に関係なく、ボットがそのチャネルでそのユーザーと対話している任意のターンで使用できます。

コンストラクター

UserState(IStorage)

UserState クラスの新しいインスタンスを初期化します。

メソッド

ClearStateAsync(ITurnContext, CancellationToken)

この BotStateの状態キャッシュをクリアします。

(継承元 BotState)
CreateProperty<T>(String)

のスコープ BotState 内に名前付き状態プロパティを作成し、 プロパティのアクセサーを返します。

(継承元 BotState)
DeleteAsync(ITurnContext, CancellationToken)

ストレージ内の状態と、この BotStateのキャッシュを削除します。

(継承元 BotState)
DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

この BotStateの状態キャッシュからプロパティを削除します。

(継承元 BotState)
Get(ITurnContext)

ターン コンテキストから、この BotState の生キャッシュ データのコピーを取得します。

(継承元 BotState)
GetCachedState(ITurnContext)

ターン コンテキストから、この BotState キャッシュされた生データをラップするキャッシュされたボット状態インスタンスを取得します。

(継承元 BotState)
GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)

この BotStateの状態キャッシュからプロパティの値を取得します。

(継承元 BotState)
GetStorageKey(ITurnContext)

ストレージとの間で状態を読み書きするときに使用するキーを取得します。
LoadAsync(ITurnContext, Boolean, CancellationToken)

ストレージ レイヤーから、この BotState 状態キャッシュを設定します。

(継承元 BotState)
SaveChangesAsync(ITurnContext, Boolean, CancellationToken)

この BotState 状態キャッシュをストレージ レイヤーに書き込みます。

(継承元 BotState)
SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)

この BotStateの状態キャッシュ内のプロパティの値を設定します。

(継承元 BotState)

適用対象