UserState 类

定义

定义用户状态的状态管理对象。

public class UserState : Microsoft.Bot.Builder.BotState
type UserState = class
    inherit BotState
Public Class UserState
Inherits BotState
继承
UserState

注解

无论聊天如何,机器人在该通道上与该用户对话的任何轮次中,用户状态都可用。

构造函数

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)

获取缓存的机器人状态实例,该实例从轮次上下文中包装此 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)

适用于