DialogStateManager class

パッケージ:

botbuilder-dialogs

DialogStateManager は、メモリ スコープとパス リゾルバーを管理します。

注釈

MemoryScopes はルート レベルのオブジェクトという名前で、ダイアログ コンテキスト内に存在することも、ターン状態からオフにすることもできます。 パス リゾルバーを使用すると、$foo -> dialog.foo などのマッピングのショートカット動作が可能になります。

コンストラクター

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

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

プロパティ

configuration

ダイアログ状態マネージャーの構成済みのパス リゾルバーとメモリ スコープを取得または設定します。

メソッド

anyPathChanged(number, string[])	透かし以降にパスが変更されているかどうかを確認します。
deleteScopesMemory(string)	特定のスコープのすべてのバッキング メモリを削除します。
deleteValue(string)	メモリからプロパティを削除する
getMemorySnapshot()	ログに適したすべてのメモリ スコープを取得します。
getValue<T>(string, T | () => T)	パス式を使用してメモリから値を取得します。
loadAllScopes()	現在のターンのすべてのメモリ スコープが読み込まれたことを確認します。
parsePath(string, boolean)	渡されたパスのパス セグメントを正規化します。
saveAllChanges()	メモリ スコープに加えられた変更を保存します。
setValue(string, any)	メモリを値に設定します。
trackPaths(string[])	特定のパスが変更されたタイミングを追跡します。
transformPath(string)	登録されたパス トランスフォーマーを使用してパスを変換します。
version()	バージョン番号を取得します。

コンストラクターの詳細

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

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

new DialogStateManager(dc: DialogContext, configuration?: DialogStateManagerConfiguration)

パラメーター

dc

DialogContext

会話の現在のターンのダイアログ コンテキスト。

configuration

DialogStateManagerConfiguration

ダイアログ状態マネージャーの構成。

プロパティの詳細

configuration

ダイアログ状態マネージャーの構成済みのパス リゾルバーとメモリ スコープを取得または設定します。

configuration: DialogStateManagerConfiguration

プロパティ値

DialogStateManagerConfiguration

注釈

ダイアログ コンテキストの特定のチェーンに対して、構成情報のセットが 1 つ存在します。 チェーン内の DialogStateManager に新しい構成を割り当てると、チェーン全体の構成が更新されます。

メソッドの詳細

anyPathChanged(number, string[])

透かし以降にパスが変更されているかどうかを確認します。

function anyPathChanged(counter: number, paths: string[]): boolean

パラメーター

counter

number

比較する時間カウンター。

paths

string[]

trackPaths() からのパス 確認する。

戻り値

boolean

True カウンター以降にパスが変更された場合です。

deleteScopesMemory(string)

特定のスコープのすべてのバッキング メモリを削除します。

function deleteScopesMemory(name: string): Promise<void>

パラメーター

name

string

スコープの名前。

戻り値

Promise<void>

deleteValue(string)

メモリからプロパティを削除する

function deleteValue(pathExpression: string)

パラメーター

pathExpression

string

削除するリーフ プロパティ。

getMemorySnapshot()

ログに適したすべてのメモリ スコープを取得します。

function getMemorySnapshot(): object

戻り値

object

すべてのメモリ スコープを表すオブジェクト。

getValue<T>(string, T | () => T)

パス式を使用してメモリから値を取得します。

function getValue<T>(pathExpression: string, defaultValue?: T | () => T): T

パラメーター

pathExpression

string

使用するパス式。

defaultValue

T | () => T

(省略可能) パスが見つからない場合に使用する既定値。 使用する既定値を返す関数を指定できます。

戻り値

T

見つかった値、または見つからない場合は未定義で、defaultValue 指定されていません。

注釈

これは常にメモリの CLONE を返します。結果に対する変更はメモリに影響しません。

loadAllScopes()

現在のターンのすべてのメモリ スコープが読み込まれたことを確認します。

function loadAllScopes(): Promise<void>

戻り値

Promise<void>

注釈

これはターンの開始時に呼び出す必要があります。

parsePath(string, boolean)

渡されたパスのパス セグメントを正規化します。

function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]

パラメーター

pathExpression

string

正規化するパス。

allowNestedPaths

boolean

随意。 false 場合、入れ子になったパスを検出すると、空のパスが返されます。 既定値は 'true' です。

戻り値

string | number[]

正規化されたパス。

注釈

profile.address[0] のパスは、profile.address.0に正規化されます。

saveAllChanges()

メモリ スコープに加えられた変更を保存します。

function saveAllChanges(): Promise<void>

戻り値

Promise<void>

注釈

これはターンの最後に呼び出す必要があります。

setValue(string, any)

メモリを値に設定します。

function setValue(pathExpression: string, value: any)

パラメーター

pathExpression

string

メモリへのパス。

value

any

設定する値。

trackPaths(string[])

特定のパスが変更されたタイミングを追跡します。

function trackPaths(paths: string[]): string[]

パラメーター

paths

string[]

追跡するパス。

戻り値

string[]

anyPathChanged()に渡す正規化されたパス。

transformPath(string)

登録されたパス トランスフォーマーを使用してパスを変換します。

function transformPath(pathExpression: string): string

パラメーター

pathExpression

string

変換するパス。

戻り値

string

変換されたパス。

version()

バージョン番号を取得します。

function version(): string

戻り値

string

バージョン番号を含む文字列。