BotState 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
定义状态管理对象,并自动读取和写入存储层的关联状态属性。
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。
可以为机器人定义其他范围。
构造函数
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的状态缓存中的属性的值。 |