BotState 类
- java.
lang. Object - com.
microsoft. bot. builder. BotState
- com.
实现
public abstract class BotState
implements PropertyManager
定义状态管理对象,并自动读取和写入存储层的关联状态属性。
每个状态管理对象定义存储层的范围。 状态属性是在状态管理范围内创建的,Bot Framework 定义了以下范围: ConversationState、 UserState和 PrivateConversationState。 可以为机器人定义其他范围。
构造函数摘要
构造函数 | 说明 |
---|---|
BotState(Storage withStorage, String withContextServiceKey) |
初始化 Bot |
方法摘要
修饰符和类型 | 方法和描述 |
---|---|
State |
<T>createProperty(String name)
在机器人 |
protected java.util.concurrent.CompletableFuture<T> |
<T>getPropertyValue(TurnContext turnContext, String propertyName)
从此机器人 |
java.util.concurrent.CompletableFuture<java.lang.Void> |
clearState(TurnContext turnContext)
清除此机器人 |
java.util.concurrent.CompletableFuture<java.lang.Void> |
delete(TurnContext turnContext)
删除当前存储在此状态范围中的任何状态。 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
deletePropertyValue(TurnContext turnContext, String propertyName)
从此机器人 |
com.fasterxml.jackson.databind.JsonNode |
get(TurnContext turnContext)
从轮次上下文中获取此机器人 |
Cached |
getCachedState(TurnContext turnContext)
获取缓存的机器人状态实例,该实例包装轮次上下文中此机器人 |
abstract java.lang.String |
getStorageKey(TurnContext turnContext)
在派生类中重写时,获取在存储中读取和写入状态时要使用的密钥。 |
java.util.concurrent.CompletableFuture<java.lang.Void> |
load(TurnContext turnContext)
从存储层填充此机器人 |
java.util.concurrent.CompletableFuture<java.lang.Void> |
load(TurnContext turnContext, boolean force)
读取当前状态对象,并将其缓存在此轮次的上下文对象中。 |
java.util.concurrent.CompletableFuture<java.lang.Void> |
saveChanges(TurnContext turnContext)
将此机器人 |
java.util.concurrent.CompletableFuture<java.lang.Void> |
saveChanges(TurnContext turnContext, boolean force)
将此机器人 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
setPropertyValue(TurnContext turnContext, String propertyName, Object value)
设置此机器人 |
方法继承自 java.lang.Object
构造函数详细信息
BotState
public BotState(Storage withStorage, String withContextServiceKey)
初始化 BotState 类的新实例。
参数:
引发:
方法详细信息
<T>createProperty
public StatePropertyAccessor
在 BotState 的范围内创建命名状态属性,并返回该属性的访问器。
参数:
返回:
引发:
<T>getPropertyValue
protected CompletableFuture
从此 BotState 的状态缓存中获取属性的值。
参数:
返回:
clearState
public CompletableFuture
清除此 BotState 的状态缓存。
此方法清除轮次上下文中的状态缓存。 调用 saveChanges(TurnContext turnContext, boolean force) 以将此更改保留在存储层中。
参数:
返回:
delete
public CompletableFuture
删除当前存储在此状态范围中的任何状态。
参数:
返回:
deletePropertyValue
protected CompletableFuture
从此 BotState 的状态缓存中删除属性。
参数:
返回:
get
public JsonNode get(TurnContext turnContext)
从轮次上下文中获取此 BotState 的原始缓存数据的副本。
参数:
返回:
getCachedState
public BotState.CachedBotState getCachedState(TurnContext turnContext)
获取缓存的机器人状态实例,该实例从轮次上下文包装此 BotState 的原始缓存数据。
参数:
返回:
getStorageKey
public abstract String getStorageKey(TurnContext turnContext)
在派生类中重写时,获取在存储中读取和写入状态时要使用的密钥。
参数:
返回:
引发:
load
public CompletableFuture
从存储层填充此 BotState 的状态缓存。
参数:
返回:
load
public CompletableFuture
读取当前状态对象,并将其缓存在此轮次的上下文对象中。
参数:
返回:
saveChanges
public CompletableFuture
将此 BotState 的状态缓存写入存储层。
参数:
返回:
saveChanges
public CompletableFuture
将此 BotState 的状态缓存写入存储层。
参数:
返回:
setPropertyValue
protected CompletableFuture
设置此 BotState 的状态缓存中属性的值。
参数:
返回: