BotState 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
定义状态管理对象，并将关联的状态属性的读取和写入自动化到存储层。
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManagertype BotState = class
interface IPropertyManagerPublic MustInherit Class BotState
Implements IPropertyManager- 继承
-
BotState
- 派生
- 实现
注解
每个状态管理对象定义存储层的范围。
状态属性是在状态管理范围内创建的，Bot Framework 定义了以下范围：ConversationState、UserState和 PrivateConversationState。
可以为机器人定义其他范围。
构造函数
| 名称 | 说明 |
|---|---|
| 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) |
获取缓存的机器人状态实例，从回合上下文中包裹原始缓存数据 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中设置属性的值。 |