DelegatingTurnContext 类

  • java.lang.Object
    • com.microsoft.bot.builder.DelegatingTurnContext

实现

public class DelegatingTurnContext
implements TurnContext

包装非类型化内部 TurnContext 的 TurnContext。

构造函数摘要

构造函数 说明
DelegatingTurnContext(TurnContext withTurnContext)

初始化委托TurnContext 类的新实例。

方法摘要

修饰符和类型 方法和描述
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

删除现有活动。

java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

删除现有活动。

Activity getActivity()

获取内部上下文的活动。

BotAdapter getAdapter()

获取内部上下文的活动。

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 activity)

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

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 activity)

替换现有活动。

方法继承自 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

构造函数详细信息

DelegatingTurnContext

public DelegatingTurnContext(TurnContext withTurnContext)

初始化 DelegatingTurnContext 类的新实例。

参数:

withTurnContext - 要包装的 TurnContext。

方法详细信息

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

删除现有活动。

参数:

conversationReference

deleteActivity

public CompletableFuture deleteActivity(String activityId)

删除现有活动。

参数:

activityId

getActivity

public Activity getActivity()

获取内部上下文的活动。

返回:

内部 getActivity()

getAdapter

public BotAdapter getAdapter()

获取内部上下文的活动。

返回:

内部 getAdapter()

getLocale

public String getLocale()

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

返回:

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

getResponded

public boolean getResponded()

获取内部上下文的响应值。

返回:

内部 getResponded()

getTurnState

public TurnContextStateCollection getTurnState()

获取内部上下文的活动。

返回:

内部 getTurnState()

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

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

参数:

handler

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

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

参数:

handler

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

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

参数:

handler

sendActivities

public CompletableFuture sendActivities(List activities)

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

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

参数:

activities

sendActivity

public CompletableFuture sendActivity(Activity activity)

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

参数:

activity

sendActivity

public CompletableFuture sendActivity(String textReplyToSend)

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

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

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

参数:

textReplyToSend

sendActivity

public CompletableFuture sendActivity(String textReplyToSend, String speak)

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

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

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

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

参数:

textReplyToSend
speak

sendActivity

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

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

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

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

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

参数:

textReplyToSend
speak
inputHint

setLocale

public void setLocale(String withLocale)

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

参数:

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

updateActivity

public CompletableFuture updateActivity(Activity activity)

替换现有活动。

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

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

参数:

activity

适用于