BotStateSet class
BotState
外掛程式的集合,應該以單一單位平行方式載入或儲存。
如需此類別的實作,請參閱 AutoSaveStateMiddleware
。
建構函式
Bot |
建立新的 BotStateSet 實例。 |
屬性
bot |
集合的數位 |
方法
add(Bot |
向集合註冊一或多個 |
load |
在集合中的所有 BotState 外掛程式上呼叫 |
save |
在集合中的所有 BotState 外掛程式上呼叫 |
建構函式詳細資料
BotStateSet(BotState[])
建立新的 BotStateSet 實例。
new BotStateSet(botStates: BotState[])
參數
- botStates
-
BotState[]
要註冊的一或多個 BotState 外掛程式。
屬性詳細資料
botStates
方法詳細資料
add(BotState[])
向集合註冊一或多個 BotState
外掛程式。
function add(botStates: BotState[]): this
參數
- botStates
-
BotState[]
要註冊的一或多個 BotState 外掛程式。
傳回
this
更新的 BotStateSet。
loadAll(TurnContext, boolean)
在集合中的所有 BotState 外掛程式上呼叫 BotState.load()
。
function loadAll(context: TurnContext, force?: boolean): Promise<void>
參數
- context
- TurnContext
目前與使用者交談回合的內容。
- force
-
boolean
(選擇性)如果 true
會略過快取,而且狀態一律會直接從記憶體讀取。 預設為 false
。
傳回
Promise<void>
備註
這會觸發所有外掛程式以平行方式讀取其狀態。
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
在集合中的所有 BotState 外掛程式上呼叫 BotState.saveChanges()
。
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>
參數
- context
- TurnContext
目前與使用者交談回合的內容。
- force
-
boolean
(選擇性)如果 true
狀態一律會寫出,而不論其變更狀態為何。 預設為 false
。
傳回
Promise<void>
備註
這會觸發所有外掛程式以平行方式寫出其狀態。
await stateSet.saveAllChanges(context);