MemoryScope class

套件:

botbuilder-dialogs

所有記憶體範圍的抽象基類。

建構函式

MemoryScope(string, boolean)

初始化 MemoryScope 類別的新實例。

屬性

includeInSnapshot	取得值，指出這個記憶體是否應該包含在快照中。
name	取得或設定範圍的名稱

方法

delete(DialogContext)	刪除範圍的備份記憶體。
getMemory(DialogContext)	取得此範圍的備份記憶體
load(DialogContext)	在回合開始時載入備份記憶體的範圍。
saveChanges(DialogContext)	將範圍儲存在回合結束時備份記憶體的範圍。
setMemory(DialogContext, object)	變更記憶體範圍的支援物件。

建構函式詳細資料

MemoryScope(string, boolean)

初始化 MemoryScope 類別的新實例。

new MemoryScope(name: string, includeInSnapshot?: boolean)

參數

name

string

範圍的名稱。

includeInSnapshot

boolean

布爾值，指出此記憶體是否應該包含在快照中。 默認值為 true。

屬性詳細資料

includeInSnapshot

取得值，指出這個記憶體是否應該包含在快照中。

includeInSnapshot: boolean

屬性值

boolean

name

取得或設定範圍的名稱

name: string

屬性值

string

方法詳細資料

delete(DialogContext)

刪除範圍的備份記憶體。

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

參數

_dc

DialogContext

目前的對話框內容。

傳回

Promise<void>

getMemory(DialogContext)

取得此範圍的備份記憶體

function getMemory(dc: DialogContext): object

參數

dc

DialogContext

目前的對話框內容。

傳回

object

範圍的記憶體

load(DialogContext)

在回合開始時載入備份記憶體的範圍。

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

參數

_dc

DialogContext

目前的對話框內容。

傳回

Promise<void>

saveChanges(DialogContext)

將範圍儲存在回合結束時備份記憶體的範圍。

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

參數

_dc

DialogContext

目前的對話框內容。

傳回

Promise<void>

setMemory(DialogContext, object)

變更記憶體範圍的支援物件。

function setMemory(_dc: DialogContext, _memory: object)

參數

_dc

DialogContext

目前的對話框內容

_memory

object

要指派的記憶體