BotStateMemoryScope class
以 BotState 為基礎的記憶體範圍基類。
- Extends
建構函式
| Bot |
初始化 BotStateMemoryScope 類別的新實例。 |
繼承的屬性
| include |
取得值，指出這個記憶體是否應該包含在快照中。 |
| name | 取得或設定範圍的名稱 |
方法
| delete(Dialog |
刪除記憶體中的任何狀態，以及這個 BotState的快取。 |
| get |
取得此範圍的備份記憶體。 |
| load(Dialog |
從儲存層填入此 BotState 的狀態快取。 |
| save |
|
| set |
變更記憶體範圍的支援物件。 |
建構函式詳細資料
BotStateMemoryScope(string)
繼承的屬性詳細資料
includeInSnapshot
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)
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
記憶