TurnContext 接口
public interface TurnContext
字段摘要
修饰符和类型 | 字段和描述 |
---|---|
static final java.lang.String | STATE_TURN_LOCALE |
方法摘要
修饰符和类型 | 方法和描述 |
---|---|
abstract java.util.concurrent.CompletableFuture<java.lang.Void> |
deleteActivity(ConversationReference conversationReference)
删除现有活动。 |
abstract java.util.concurrent.CompletableFuture<java.lang.Void> |
deleteActivity(String activityId)
删除现有活动。 |
abstract Activity |
getActivity()
获取此轮次机器人的活动。 |
abstract
Bot |
getAdapter()
获取创建此上下文对象的机器人适配器。 |
abstract java.lang.String |
getLocale()
获取此上下文对象的区域设置。 |
abstract boolean |
getResponded()
获取一个值,该值指示是否为当前轮次至少发送了一个响应。 |
abstract
Turn |
getTurnState()
获取在轮次生存期内使用上下文对象缓存的值的集合。 |
abstract
Turn |
onDeleteActivity(DeleteActivityHandler handler)
为删除活动操作添加响应处理程序。 |
abstract
Turn |
onSendActivities(SendActivitiesHandler handler)
为发送活动操作添加响应处理程序。 |
abstract
Turn |
onUpdateActivity(UpdateActivityHandler handler)
为更新活动操作添加响应处理程序。 |
default
java.util.concurrent.CompletableFuture<Resource |
sendActivities(Activity[] activities)
用于发送活动数组的帮助程序方法。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivities(List<Activity> activities)
将活动列表发送到传入活动的发送方。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(Activity activity)
将活动发送到传入活动的发送方。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend)
将消息活动发送到传入活动的发件人。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend, String speak)
将消息活动发送到传入活动的发件人。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend, String speak, InputHints inputHint)
将消息活动发送到传入活动的发件人。 |
default java.util.concurrent.CompletableFuture<java.lang.Void> |
sendActivityBlind(Activity activity)
在不返回资源 |
abstract void |
setLocale(String withLocale)
在此上下文对象上设置区域设置。 |
static
java.util.concurrent.CompletableFuture<Resource |
traceActivity(TurnContext turnContext, String name) |
static
java.util.concurrent.CompletableFuture<Resource |
traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)
出于日志记录目的, BotAdapter 将跟踪活动发送到 。 |
abstract
java.util.concurrent.CompletableFuture<Resource |
updateActivity(Activity withActivity)
替换现有活动。 |
字段详细信息
STATE_TURN_LOCALE
public static final String STATE_TURN_LOCALE
方法详细信息
deleteActivity
public abstract CompletableFuture
删除现有活动。
Parameters:
Returns:
deleteActivity
public abstract CompletableFuture
删除现有活动。
Parameters:
Returns:
getActivity
public abstract Activity getActivity()
获取此轮次机器人的活动。
Returns:
getAdapter
public abstract BotAdapter getAdapter()
获取创建此上下文对象的机器人适配器。
Returns:
getLocale
public abstract String getLocale()
获取此上下文对象的区域设置。
Returns:
getResponded
public abstract boolean getResponded()
获取一个值,该值指示是否为当前轮次至少发送了一个响应。
Returns:
true
如果为当前轮次发送了至少一个响应,则为 ;否则为 false
。getTurnState
public abstract TurnContextStateCollection getTurnState()
获取在轮次生存期内使用上下文对象缓存的值的集合。
Returns:
onDeleteActivity
public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)
为删除活动操作添加响应处理程序。
调用上下文时 deleteActivity(String activityId) ,适配器会按照将处理程序添加到上下文对象的顺序调用已注册的处理程序。
Parameters:
Returns:
onSendActivities
public abstract TurnContext onSendActivities(SendActivitiesHandler handler)
为发送活动操作添加响应处理程序。
当调用上下文的 sendActivity(Activity activity) 或 sendActivities(List<Activity> activities) 方法时,适配器会按照将其添加到上下文对象的顺序调用已注册的处理程序。
Parameters:
Returns:
onUpdateActivity
public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)
为更新活动操作添加响应处理程序。
调用上下文时 updateActivity(Activity withActivity) ,适配器会按照将处理程序添加到上下文对象的顺序调用已注册的处理程序。
Parameters:
Returns:
sendActivities
public default CompletableFuture
用于发送活动数组的帮助程序方法。 这将调用 sendActivities(List<Activity> activities)。
Parameters:
Returns:
sendActivities
public abstract CompletableFuture
将活动列表发送到传入活动的发送方。
如果活动成功发送,则任务结果包含一个对象数组 ResourceResponse ,其中包含接收通道分配给活动的 ID。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
将活动发送到传入活动的发送方。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
将消息活动发送到传入活动的发件人。
如果活动成功发送,则任务结果包含一个 ResourceResponse 对象,该对象包含接收通道分配给活动的 ID。
有关对 的内容 textReplyToSend
施加的限制,请参阅通道的文档。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
将消息活动发送到传入活动的发件人。
如果活动成功发送,则任务结果包含一个 ResourceResponse 对象,该对象包含接收通道分配给活动的 ID。
有关对 的内容 textReplyToSend
施加的限制,请参阅通道的文档。
若要控制机器人语音的各种特征(如语音、速率、音量、发音和音调),请在语音合成标记语言 (SSML) 格式中指定 speak
。
Parameters:
Returns:
sendActivity
public abstract CompletableFuture
将消息活动发送到传入活动的发件人。
如果活动成功发送,则任务结果包含一个 ResourceResponse 对象,该对象包含接收通道分配给活动的 ID。
有关对 的内容 textReplyToSend
施加的限制,请参阅通道的文档。
若要控制机器人语音的各种特征(如语音、速率、音量、发音和音调),请在语音合成标记语言 (SSML) 格式中指定 speak
。
Parameters:
Returns:
sendActivityBlind
public default CompletableFuture
在不返回 ResourceResponse 的情况下,将活动发送到传入活动的发送方。
Parameters:
Returns:
setLocale
public abstract void setLocale(String withLocale)
在此上下文对象上设置区域设置。
Parameters:
traceActivity
public static CompletableFuture
Parameters:
Returns:
traceActivity
public static CompletableFuture
出于日志记录目的, BotAdapter 将跟踪活动发送到 。
Parameters:
Returns:
updateActivity
public abstract CompletableFuture
替换现有活动。
如果活动成功发送,则任务结果包含一个 ResourceResponse 对象,该对象包含接收通道分配给活动的 ID。
在调用此项之前,请将替换活动的 ID 设置为要替换的活动的 ID。
Parameters:
Returns: