語言

BotState 類別

定義

定義狀態管理物件,並將相關聯狀態屬性的讀取和寫入自動化至儲存層。

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 的其他範圍。

建構函式

名稱 Description
BotState(IStorage, String)

初始化 BotState 類別的新執行個體。

方法

名稱 Description
ClearStateAsync(ITurnContext, CancellationToken)

清除狀態 BotState快取。

CreateProperty<T>(String)

在 的 BotState 範圍內建立一個命名的狀態屬性,並回傳該屬性的存取器。

DeleteAsync(ITurnContext, CancellationToken)

刪除儲存中的任何狀態和快 BotState取。

DeletePropertyValueAsync(ITurnContext, String, CancellationToken)

刪除狀態快取中的屬性。BotState

Get(ITurnContext)

從回合上下文中取得原始快取資料 BotState 的副本。

GetCachedState(ITurnContext)

會取得快取的機器人狀態實例,將此事的原始快取資料 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狀態快取中屬性的值。

適用於

另請參閱