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)

适用于