UserMemoryScope class

パッケージ:

botbuilder-dialogs

現在のユーザーにスコープが設定されているメモリ。

Extends

BotStateMemoryScope

コンストラクター

UserMemoryScope()

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

継承されたプロパティ

includeInSnapshot	このメモリをスナップショットに含める必要があるかどうかを示す値を取得します。
name	スコープの名前を取得または設定します。

継承されたメソッド

delete(DialogContext)	この BotStateのストレージとキャッシュ内の状態を削除します。
getMemory(DialogContext)	このスコープのバッキング メモリを取得します。
load(DialogContext, boolean)	ストレージ レイヤーからこの BotState の状態キャッシュを設定します。
saveChanges(DialogContext, boolean)	この BotState の状態キャッシュをストレージ レイヤーに書き込みます。
setMemory(DialogContext, object)	メモリ スコープのバッキング オブジェクトを変更します。

コンストラクターの詳細

UserMemoryScope()

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

new UserMemoryScope()

継承されたプロパティの詳細

includeInSnapshot

このメモリをスナップショットに含める必要があるかどうかを示す値を取得します。

includeInSnapshot: boolean

プロパティ値

boolean

MemoryScope.includeInSnapshot から継承された

name

スコープの名前を取得または設定します。

name: string

プロパティ値

string

MemoryScope.name から継承された

継承済みメソッドの詳細

delete(DialogContext)

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

function delete(_dc: DialogContext): Promise<void>

パラメーター

_dc

DialogContext

このターンの DialogContext オブジェクト。

戻り値

Promise<void>

実行するキューに登録された作業を表す Promise。

BotStateMemoryScope.deleteから継承された

getMemory(DialogContext)

このスコープのバッキング メモリを取得します。

function getMemory(dc: DialogContext): object

パラメーター

dc

DialogContext

現在のダイアログ コンテキスト。

戻り値

object

スコープのメモリ。

botStateMemoryScope.getMemory から継承

load(DialogContext, boolean)

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

function load(dc: DialogContext, force?: boolean): Promise<void>

パラメーター

dc

DialogContext

このターンの DialogContext オブジェクト。

force

boolean

省略可能。既存の状態キャッシュを上書きする true。キャッシュがまだ存在しない場合にのみ、ストレージから状態を読み込む false。

戻り値

Promise<void>

実行するキューに登録された作業を表す Promise。

botStateMemoryScope.load から継承

saveChanges(DialogContext, boolean)

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

function saveChanges(dc: DialogContext, force?: boolean): Promise<void>

パラメーター

dc

DialogContext

このターンの DialogContext オブジェクト。

force

boolean

オプション。状態キャッシュをストレージに保存する true。キャッシュ内のプロパティが変更された場合にのみ、状態をストレージに保存する false。

戻り値

Promise<void>

実行するキューに登録された作業を表す Promise。

botStateMemoryScope.saveChangesから継承された

setMemory(DialogContext, object)

メモリ スコープのバッキング オブジェクトを変更します。

function setMemory(dc: DialogContext, _memory: object)

パラメーター

dc

DialogContext

現在のダイアログ コンテキスト

_memory

object

記憶

botStateMemoryScope.setMemoryから継承された