TurnContext 接口

包:

com.microsoft.bot.builder

Maven 项目:

com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

提供机器人轮次的上下文。

上下文提供处理传入活动所需的信息。 上下文对象由 BotAdapter 创建，并保留轮次长度。

Bot Middleware

字段摘要

修饰符和类型	字段和描述
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 BotAdapter	getAdapter() 获取创建此上下文对象的机器人适配器。
abstract java.lang.String	getLocale() 获取此上下文对象的区域设置。
abstract boolean	getResponded() 获取一个值，该值指示是否为当前轮次发送了至少一个响应。
abstract TurnContextStateCollection	getTurnState() 获取使用轮次生存期的上下文对象缓存的值的集合。
abstract TurnContext	onDeleteActivity(DeleteActivityHandler handler) 添加用于删除活动操作的响应处理程序。
abstract TurnContext	onSendActivities(SendActivitiesHandler handler) 添加用于发送活动操作的响应处理程序。
abstract TurnContext	onUpdateActivity(UpdateActivityHandler handler) 为更新活动操作添加响应处理程序。
default java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(Activity[] activities) 用于发送活动数组的帮助程序方法。
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) 将活动列表发送到传入活动的发送方。
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activity) 将活动发送到传入活动的发送方。
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) 向传入活动的发送方发送消息活动。
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) 向传入活动的发送方发送消息活动。
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	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<ResourceResponse>	traceActivity(TurnContext turnContext, String name)
static java.util.concurrent.CompletableFuture<ResourceResponse>	traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label) 将跟踪活动发送到 BotAdapter 以进行日志记录。
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) 替换现有活动。

字段详细信息

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

方法详细信息

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

删除现有活动。

参数:

conversationReference - 包含要删除的活动的会话。

返回:

表示要执行的工作的任务。 会话引用的 ConversationReference#getActivityId 指示要删除的对话中的活动。

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

删除现有活动。

参数:

activityId - 要删除的活动的 ID。

返回:

表示要执行的工作的任务。

getActivity

public abstract Activity getActivity()

获取机器人轮次的活动。

返回:

机器人轮次的活动。

getAdapter

public abstract BotAdapter getAdapter()

获取创建此上下文对象的机器人适配器。

返回:

创建此上下文对象的机器人适配器。

getLocale

public abstract String getLocale()

获取此上下文对象的区域设置。

返回:

此上下文对象的区域设置字符串。

getResponded

public abstract boolean getResponded()

获取一个值，该值指示是否为当前轮次发送了至少一个响应。

返回:

如果为当前轮次发送了至少一个响应，true;否则，false。

getTurnState

public abstract TurnContextStateCollection getTurnState()

获取使用轮次生存期的上下文对象缓存的值的集合。

返回:

在此上下文对象上注册的服务集合。

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

添加用于删除活动操作的响应处理程序。

调用上下文的 deleteActivity(String activityId) 时，适配器会按照将注册的处理程序添加到上下文对象的顺序调用这些处理程序。

参数:

handler - 要添加到上下文对象的处理程序。

返回:

更新的上下文对象。

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

添加用于发送活动操作的响应处理程序。

当调用上下文的 sendActivity(Activity activity) 或 sendActivities(List<Activity> activities) 方法时，适配器会按照添加到上下文对象的顺序调用已注册的处理程序。

参数:

handler - 要添加到上下文对象的处理程序。

返回:

更新的上下文对象。

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

为更新活动操作添加响应处理程序。

调用上下文的 updateActivity(Activity withActivity) 时，适配器会按照将注册的处理程序添加到上下文对象的顺序调用这些处理程序。

参数:

handler - 要添加到上下文对象的处理程序。

返回:

更新的上下文对象。

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

用于发送活动数组的帮助程序方法。 这将调用 sendActivities(List<Activity> activities)。

参数:

activities - 活动数组。

返回:

表示要执行的工作的任务。

sendActivities

public abstract CompletableFuture sendActivities(List activities)

将活动列表发送到传入活动的发送方。

如果成功发送活动，则任务结果包含一组 ResourceResponse 对象，其中包含接收通道分配给活动的 ID。

参数:

activities - 要发送的活动。

返回:

表示要执行的工作的任务。

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

将活动发送到传入活动的发送方。

参数:

activity - 要发送的活动。

返回:

表示要执行的工作的任务。 如果成功发送活动，则任务结果包含一个 ResourceResponse 对象，该对象包含接收通道分配给活动的 ID。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

向传入活动的发送方发送消息活动。

如果成功发送活动，则任务结果包含一个 ResourceResponse 对象，该对象包含接收通道分配给活动的 ID。

有关对 textReplyToSend内容施加的限制，请参阅频道的文档。

参数:

textReplyToSend - 要发送的消息的文本。

返回:

表示要执行的工作的任务。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

向传入活动的发送方发送消息活动。

如果成功发送活动，则任务结果包含一个 ResourceResponse 对象，该对象包含接收通道分配给活动的 ID。

有关对 textReplyToSend内容施加的限制，请参阅频道的文档。

若要控制机器人语音的各种特征，例如语音、速率、音量、发音和音调，请在语音合成标记语言（SSML）格式中指定 speak。

参数:

textReplyToSend - 要发送的消息的文本。

speak - （可选）在启用了语音的通道上由机器人朗读的文本。

返回:

表示要执行的工作的任务。

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak, InputHints inputHint)

向传入活动的发送方发送消息活动。

如果成功发送活动，则任务结果包含一个 ResourceResponse 对象，该对象包含接收通道分配给活动的 ID。

有关对 textReplyToSend内容施加的限制，请参阅频道的文档。

若要控制机器人语音的各种特征，例如语音、速率、音量、发音和音调，请在语音合成标记语言（SSML）格式中指定 speak。

参数:

textReplyToSend - 要发送的消息的文本。

speak - （可选）在启用了语音的通道上由机器人朗读的文本。

inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 其中一个：“acceptingInput”、“ignoringInput”或“expectingInput”。 默认值为“acceptingInput”。

返回:

表示要执行的工作的任务。

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

将活动发送到传入活动的发送方，而无需返回 ResourceResponse。

参数:

activity - 要发送的活动。

返回:

表示要执行的工作的任务。

setLocale

public abstract void setLocale(String withLocale)

在此上下文对象上设置区域设置。

参数:

withLocale - 此上下文对象的区域设置字符串。

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

参数:

turnContext - turnContext。

name - 活动的名称。

返回:

ResourceReponse 的未来。

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

将跟踪活动发送到 BotAdapter 以进行日志记录。

参数:

turnContext - 当前轮次的上下文。

name - 要分配给活动的 Activity#getName 属性的值。

value - 要分配给活动的 Activity#getValue 属性的值。

valueType - 要分配给活动的 Activity#getValueType 属性的值。

label - 要分配给活动的 Activity#getLabel 属性的值。

返回:

表示要执行的工作的任务。 如果适配器托管在模拟器中，则任务结果包含具有原始跟踪活动的 ID 的 ResourceResponse 对象;否则，它包含一个 ResourceResponse 对象，该对象包含分配给活动的接收通道的 ID。

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

替换现有活动。

如果成功发送活动，则任务结果包含一个 ResourceResponse 对象，该对象包含接收通道分配给活动的 ID。

在调用此 ID 之前，请将替换活动的 ID 设置为要替换的活动的 ID。

参数:

withActivity - 新的替换活动。

返回:

表示要执行的工作的任务。