MemoryScope クラス

  • リファレンス
パッケージ:
com.microsoft.bot.dialogs.memory.scopes
Maven 成果物:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.memory.scopes.MemoryScope

public abstract class MemoryScope

MemoryScope は、名前付きメモリ スコープ抽象クラスを表します。

コンストラクターの概要

コンストラクター 説明
MemoryScope(String name, Boolean includeInSnapshot)

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

メソッドの概要

修飾子と型 メソッドと説明
java.util.concurrent.CompletableFuture<java.lang.Void> delete(DialogContext dialogContext)

ストレージ内の状態と、これに対するキャッシュを削除します。
java.lang.Boolean getIncludeInSnapshot()
abstract java.lang.Object getMemory(DialogContext dialogContext)

このスコープのバッキング メモリを取得します。
java.lang.String getName()
java.util.concurrent.CompletableFuture<java.lang.Void> load(DialogContext dialogContext, Boolean force)

ストレージ レイヤーからこの状態キャッシュを設定します。
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(DialogContext dialogContext, Boolean force)

このための状態キャッシュをストレージ レイヤーに書き込みます。
void setIncludeInSnapshot(Boolean withIncludeInSnapshot)
abstract void setMemory(DialogContext dialogContext, Object memory)

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

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

コンストラクターの詳細

MemoryScope

public MemoryScope(String name, Boolean includeInSnapshot)

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

パラメーター:

name - スコープの名前。
includeInSnapshot - このメモリをスナップショットに含める必要があるかどうかを示す値。

メソッドの詳細

delete

public CompletableFuture delete(DialogContext dialogContext)

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

パラメーター:

dialogContext - このターンのダイアログ コンテキスト オブジェクト。

戻り値:

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

getIncludeInSnapshot

public Boolean getIncludeInSnapshot()

戻り値:

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

getMemory

public abstract Object getMemory(DialogContext dialogContext)

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

パラメーター:

dialogContext - メモリ ストアから取得する DialogContext。

戻り値:

オブジェクト このスコープのメモリ。

getName

public String getName()

戻り値:

String スコープの名前を取得します。

load

public CompletableFuture load(DialogContext dialogContext, Boolean force)

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

パラメーター:

dialogContext - このターンのダイアログ コンテキスト オブジェクト。
force - 既存の状態キャッシュを上書きする場合は true、キャッシュがまだ存在しない場合にのみストレージから状態を読み込む場合は false。

戻り値:

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

saveChanges

public CompletableFuture saveChanges(DialogContext dialogContext, Boolean force)

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

パラメーター:

dialogContext - このターンのダイアログ コンテキスト オブジェクト。
force - 状態キャッシュをストレージに保存する場合は True。 キャッシュ内のプロパティが変更された場合にのみ、状態をストレージに保存する場合は false。

戻り値:

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

setIncludeInSnapshot

public void setIncludeInSnapshot(Boolean withIncludeInSnapshot)

パラメーター:

withIncludeInSnapshot - このメモリをスナップショットに含めるかどうかを示す値を設定します。

setMemory

public abstract void setMemory(DialogContext dialogContext, Object memory)

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

パラメーター:

dialogContext - メモリ ストアに設定する DialogContext。
memory - DialogContext を設定するメモリ。

setName

public void setName(String withName)

パラメーター:

withName - スコープの名前を設定します。

適用対象