BotState 類別
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
定義狀態管理物件,並將相關聯狀態屬性的讀取和寫入自動化至儲存層。
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager
type BotState = class
interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
- 繼承
-
BotState
- 衍生
- 實作
備註
每個狀態管理物件都會定義儲存層的範圍。
狀態屬性是在狀態管理範圍內建立,而 Bot Framework 會定義下列範圍: ConversationState 、 UserState 和 PrivateConversationState 。
您可以定義 Bot 的其他範圍。
建構函式
BotState(IStorage, String) |
初始化 BotState 類別的新執行個體。 |
方法
ClearStateAsync(ITurnContext, CancellationToken) |
清除這個 BotState 的狀態快取。 |
CreateProperty<T>(String) |
在 範圍內 BotState 建立具名狀態屬性,並傳回 屬性的存取子。 |
DeleteAsync(ITurnContext, CancellationToken) |
刪除儲存體中的任何狀態,以及這個 BotState 的快取。 |
DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
從這個 BotState 的狀態快取中刪除屬性。 |
Get(ITurnContext) |
從回合內容取得這個 BotState 的原始快取資料複本。 |
GetCachedState(ITurnContext) |
取得快取的 Bot 狀態實例,這個實例會從回合內容包裝這個 BotState 的原始快取資料。 |
GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
從這個 BotState 的狀態快取取得 屬性值。 |
GetStorageKey(ITurnContext) |
在衍生類別中覆寫時,取得在儲存體讀取和寫入狀態時要使用的金鑰。 |
LoadAsync(ITurnContext, Boolean, CancellationToken) |
從儲存層填入這個 BotState 的狀態快取。 |
SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
將這個 BotState 的狀態快取寫入至儲存層。 |
SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
設定這個 BotState 狀態快取中屬性的值。 |