InspectionState class
警告
此 API 現已淘汰。
This class will be removed in a future version of the framework.
InspectionState 供檢查Middleware 用於執行時間活動和 BotState 的模擬器檢查。
- Extends
-
BotState
備註
InspectionState 供檢查Middleware 用於執行時間活動和 BotState 的模擬器檢查。
建構函式
| Inspection |
建立 檢查State 類別的新實例。 |
繼承的方法
| clear(Turn |
清除回合的目前狀態物件。 |
| create |
建立新的屬性存取子，以便讀取和寫入 Bot 狀態儲存體物件中的個別屬性。 |
| delete(Turn |
刪除目前回合的備份狀態物件。 |
| get(Turn |
傳回快取的狀態物件，如果未快取，則傳回未定義。 |
| load(Turn |
讀取 並快取回合的備份狀態物件。 |
| save |
如果已變更，則會儲存快取的狀態物件。 |
建構函式詳細資料
InspectionState(Storage)
建立 檢查State 類別的新實例。
new InspectionState(storage: Storage)參數
- storage
-
Storage
此狀態管理物件的 儲存 層會用來儲存和擷取狀態。
繼承的方法的詳細資料
clear(TurnContext)
清除回合的目前狀態物件。
function clear(context: TurnContext): Promise<void>參數
- context
-
TurnContext
與使用者目前交談回合的內容。
傳回
Promise<void>
代表非同步作業的承諾。
備註
在呼叫 saveChanges () 之前，將不會保存清除的狀態物件。
await botState.clear(context);
await botState.saveChanges(context);
繼承自 BotState.clear
createProperty<T>(string)
建立新的屬性存取子，以便讀取和寫入 Bot 狀態儲存體物件中的個別屬性。
function createProperty<T>(name: string): StatePropertyAccessor<T>參數
- name
-
string
要加入的屬性名稱。
傳回
StatePropertyAccessor<T>
屬性的存取子。
繼承自 BotState.createProperty
delete(TurnContext)
刪除目前回合的備份狀態物件。
function delete(context: TurnContext): Promise<void>參數
- context
-
TurnContext
與使用者目前交談回合的內容。
傳回
Promise<void>
代表非同步作業的承諾。
備註
如果狀態物件存在，狀態物件將會從儲存體中移除。 如果狀態物件已讀取並快取，則會清除快取。
await botState.delete(context);
繼承自 BotState.delete
get(TurnContext)
傳回快取的狀態物件，如果未快取，則傳回未定義。
function get(context: TurnContext): any | undefined參數
- context
-
TurnContext
與使用者目前交談回合的內容。
傳回
any | undefined
快取狀態物件，如果未快取，則為未定義。
備註
此範例示範如何同步取得已載入和快取的狀態物件：
const state = botState.get(context);
繼承自 BotState.get
load(TurnContext, boolean)
讀取 並快取回合的備份狀態物件。
function load(context: TurnContext, force?: boolean): Promise<any>參數
- context
-
TurnContext
與使用者目前交談回合的內容。
- force
-
boolean
(選擇性) 如果 true 略過快取，且狀態一律會直接從儲存體讀取。 預設值為 false。
傳回
Promise<any>
快取狀態。
備註
除非傳入 旗標， force 否則後續讀取會傳回快取的物件，以強制重新讀取狀態物件。
這個方法會在第一次存取任何已建立的屬性存取子時呼叫。
const state = await botState.load(context);
繼承自 BotState.load
saveChanges(TurnContext, boolean)
如果已變更，則會儲存快取的狀態物件。
function saveChanges(context: TurnContext, force?: boolean): Promise<void>參數
- context
-
TurnContext
與使用者目前交談回合的內容。
- force
-
boolean
(選擇性) 狀態 true 是否一律會寫出狀態，而不論其變更狀態為何。 預設值為 false。
傳回
Promise<void>
代表非同步作業的承諾。
備註
force如果旗標在快取狀態物件中傳遞，不論其是否已變更，以及尚未快取物件，都會建立空白物件，然後儲存。
await botState.saveChanges(context);
繼承自 BotState.saveChanges