UserState 類別
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
定義使用者狀態的狀態管理物件。
public class UserState : Microsoft.Bot.Builder.BotState
type UserState = class
inherit BotState
Public Class UserState
Inherits BotState
- 繼承
備註
不論交談為何,Bot 都會在該頻道上與該使用者交談的任何回合中取得使用者狀態。
建構函式
UserState(IStorage) |
初始化 UserState 類別的新執行個體。 |
方法
ClearStateAsync(ITurnContext, CancellationToken) |
清除這個 BotState 的狀態快取。 (繼承來源 BotState) |
CreateProperty<T>(String) |
在 範圍內 BotState 建立具名狀態屬性,並傳回 屬性的存取子。 (繼承來源 BotState) |
DeleteAsync(ITurnContext, CancellationToken) |
刪除儲存體中的任何狀態,以及這個 BotState 的快取。 (繼承來源 BotState) |
DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
從這個 BotState 的狀態快取中刪除屬性。 (繼承來源 BotState) |
Get(ITurnContext) |
從回合內容取得這個 BotState 的原始快取資料複本。 (繼承來源 BotState) |
GetCachedState(ITurnContext) |
取得快取的 Bot 狀態實例,這個實例會從回合內容包裝這個 BotState 的原始快取資料。 (繼承來源 BotState) |
GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
從這個 BotState 的狀態快取取得 屬性值。 (繼承來源 BotState) |
GetStorageKey(ITurnContext) |
取得在儲存體讀取和寫入狀態時要使用的金鑰。 |
LoadAsync(ITurnContext, Boolean, CancellationToken) |
從儲存層填入這個 BotState 的狀態快取。 (繼承來源 BotState) |
SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
將這個 BotState 的狀態快取寫入至儲存層。 (繼承來源 BotState) |
SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
設定這個 BotState 狀態快取中屬性的值。 (繼承來源 BotState) |