BotStateMemoryScope class
BotState に基づくメモリ スコープの基本クラス。
- Extends
コンストラクター
| Bot |
BotStateMemoryScope クラスの新しいインスタンスを初期化します。 |
継承されたプロパティ
| include |
このメモリをスナップショットに含める必要があるかどうかを示す値を取得します。 |
| name | スコープの名前を取得または設定します。 |
メソッド
| delete(Dialog |
この BotStateのストレージとキャッシュ内の状態を削除します。 |
| get |
このスコープのバッキング メモリを取得します。 |
| load(Dialog |
ストレージ レイヤーからこの BotState の状態キャッシュを設定します。 |
| save |
この BotState の状態キャッシュをストレージ レイヤーに書き込みます。 |
| set |
メモリ スコープのバッキング オブジェクトを変更します。 |
コンストラクターの詳細
BotStateMemoryScope(string)
BotStateMemoryScope クラスの新しいインスタンスを初期化します。
new BotStateMemoryScope(name: string)パラメーター
- name
-
string
プロパティの名前。
継承されたプロパティの詳細
includeInSnapshot
このメモリをスナップショットに含める必要があるかどうかを示す値を取得します。
includeInSnapshot: booleanプロパティ値
boolean
name
スコープの名前を取得または設定します。
name: stringプロパティ値
string
メソッドの詳細
delete(DialogContext)
この BotStateのストレージとキャッシュ内の状態を削除します。
function delete(_dc: DialogContext): Promise<void>パラメーター
- _dc
- DialogContext
このターンの DialogContext オブジェクト。
戻り値
Promise<void>
実行するキューに登録された作業を表す Promise。
getMemory(DialogContext)
このスコープのバッキング メモリを取得します。
function getMemory(dc: DialogContext): objectパラメーター
現在のダイアログ コンテキスト。
戻り値
object
スコープのメモリ。
load(DialogContext, boolean)
ストレージ レイヤーからこの BotState の状態キャッシュを設定します。
function load(dc: DialogContext, force?: boolean): Promise<void>パラメーター
このターンの DialogContext オブジェクト。
- force
-
boolean
省略可能。既存の状態キャッシュを上書きする true。キャッシュがまだ存在しない場合にのみ、ストレージから状態を読み込む false。
戻り値
Promise<void>
実行するキューに登録された作業を表す Promise。
saveChanges(DialogContext, boolean)
この BotState の状態キャッシュをストレージ レイヤーに書き込みます。
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>パラメーター
このターンの DialogContext オブジェクト。
- force
-
boolean
オプション。状態キャッシュをストレージに保存する true。キャッシュ内のプロパティが変更された場合にのみ、状態をストレージに保存する false。
戻り値
Promise<void>
実行するキューに登録された作業を表す Promise。
setMemory(DialogContext, object)
メモリ スコープのバッキング オブジェクトを変更します。
function setMemory(dc: DialogContext, _memory: object)パラメーター
現在のダイアログ コンテキスト
- _memory
-
object
記憶