TurnContextImpl 类

  • 参考
包:
com.microsoft.bot.builder
Maven 项目:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.TurnContextImpl

实现

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

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

构造函数摘要

构造函数 说明
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

创建上下文对象。

方法摘要

修饰符和类型 方法和描述
void close()

自动Closable#close。
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

删除现有活动。
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

删除现有活动。
void finalize()

自动调用 #close。
Activity getActivity()

获取与此轮次关联的活动;或处理主动消息时 null。
BotAdapter getAdapter()

获取创建此上下文对象的机器人适配器。
java.util.List<Activity> getBufferedReplyActivities()

获取在“context”时要发送的活动的列表。活动。传递模式 == “expect答复”。
java.lang.String getLocale()

获取此上下文对象的区域设置。
boolean getResponded()

指示是否为当前轮次发送了至少一个响应。
TurnContextStateCollection getTurnState()

获取在此上下文对象上注册的服务。
TurnContext onDeleteActivity(DeleteActivityHandler handler)

添加用于删除活动操作的响应处理程序。
TurnContext onSendActivities(SendActivitiesHandler handler)

添加用于发送活动操作的响应处理程序。
TurnContext onUpdateActivity(UpdateActivityHandler handler)

为更新活动操作添加响应处理程序。
java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(List<Activity> activities)

将一组活动发送到传入活动的发送方。
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activityToSend)

将活动发送到传入活动的发送方。
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend)

向传入活动的发送方发送消息活动。
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak)

向传入活动的发送方发送消息活动。
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak, InputHints inputHint)

向传入活动的发送方发送消息活动。
void setLocale(String withLocale)

在此上下文对象上设置区域设置。
java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

替换现有活动。

方法继承自 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

构造函数详细信息

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

创建上下文对象。

参数:

withAdapter - 创建上下文的适配器。
withActivity - 轮次的传入活动;或为主动消息轮次 null。

方法详细信息

close

public void close()

AutoClosable#close。

引发:

java.lang.Exception - 如果 TurnContextStateCollection。

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

删除现有活动。 会话引用的 ConversationReference#getActivityId 指示要删除的对话中的活动。

参数:

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

返回:

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

deleteActivity

public CompletableFuture deleteActivity(String activityId)

删除现有活动。

参数:

activityId - 要删除的活动的 ID。

返回:

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

finalize

public void finalize()

自动调用 #close。

替代:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

获取与此轮次关联的活动;或处理主动消息时 null。

getAdapter

public BotAdapter getAdapter()

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

返回:

轮次的 BotAdaptor。

getBufferedReplyActivities

public List getBufferedReplyActivities()

获取在“context”时要发送的活动的列表。Activity.DeliveryMode == 'expectReplies'。

返回:

活动列表。

getLocale

public String getLocale()

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

返回:

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

getResponded

public boolean getResponded()

指示是否为当前轮次发送了至少一个响应。

返回:

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

getTurnState

public TurnContextStateCollection getTurnState()

获取在此上下文对象上注册的服务。

返回:

此轮次的 TurnContextStateCollection。

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

参数:

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

返回:

更新的上下文对象。

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

参数:

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

返回:

更新的上下文对象。

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

参数:

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

返回:

更新的上下文对象。

sendActivities

public CompletableFuture sendActivities(List activities)

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

参数:

activities - 要发送的活动。

返回:

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

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

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

参数:

activityToSend - 要发送的活动。

返回:

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend)

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

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

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

参数:

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

返回:

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend, String speak)

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

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

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

参数:

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

返回:

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

sendActivity

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

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

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

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

参数:

textReplyToSend - 要发送的消息的文本。
speak - 若要控制机器人语音的各种特征，例如语音速率、音量、发音和音调，请指定语音合成标记语言（SSML）格式。
inputHint - （可选）输入提示。

返回:

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

setLocale

public void setLocale(String withLocale)

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

参数:

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

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

替换现有活动。

参数:

withActivity - 新的替换活动。

返回:

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

适用于