TelemetryLoggerMiddleware 类

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

实现

中间件

public class TelemetryLoggerMiddleware
implements Middleware

用于记录传入、传出、更新或删除活动消息的中间件。 使用 BotTelemetryClient 接口。

构造函数摘要

构造函数 说明
TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

初始化类的新实例。

方法摘要

修饰符和类型 方法和描述
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillDeleteEventProperties(Activity activity, Map<String,String> additionalProperties)

填充 BotMessageDelete 的事件属性。
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillReceiveEventProperties(Activity activity, Map<String,String> additionalProperties)

填充 Bot消息接收的事件属性。
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillSendEventProperties(Activity activity, Map<String,String> additionalProperties)

填充机器人消息发送的事件属性。
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillUpdateEventProperties(Activity activity, Map<String,String> additionalProperties)

填充 Bot消息更新的事件属性。
BotTelemetryClient getTelemetryClient()

获取记录事件的当前配置的机器人遥测客户端。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(Activity activity)

机器人删除消息时调用。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onReceiveActivity(Activity activity)

从用户收到消息时调用。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onSendActivity(Activity activity)

机器人向用户发送消息时调用。
java.util.concurrent.CompletableFuture<java.lang.Void> onTurn(TurnContext context, NextDelegate next)

使用 BotTelemetryClient 接口基于传入和传出活动记录事件。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onUpdateActivity(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

构造函数详细信息

TelemetryLoggerMiddleware

public TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

初始化类的新实例。

参数:

withTelemetryClient - 用于注册遥测事件的 IBotTelemetryClient 实现。
withLogPersonalInformation - TRUE 以包含个人身份信息。

方法详细信息

fillDeleteEventProperties

protected CompletableFuture> fillDeleteEventProperties(Activity activity, Map additionalProperties)

填充 BotMessageDelete 的事件属性。 机器人向用户发送活动消息时记录这些属性。

参数:

activity - 从用户发送的最后一个活动。
additionalProperties - 要添加到事件的其他属性。

返回:

作为“属性”发送到 BotMessageDelete 事件的 BotTelemetryClient#trackEvent 方法的字典。

fillReceiveEventProperties

protected CompletableFuture> fillReceiveEventProperties(Activity activity, Map additionalProperties)

填充 BotMessageReceived 的事件属性。 遵循 LogPersonalInformation 标志来筛选名称、文本和朗诵属性。

参数:

activity - 从用户发送的最后一个活动。
additionalProperties - 要添加到事件的其他属性。

返回:

作为“属性”发送到 BotMessageReceived 事件的 BotTelemetryClient#trackEvent 方法的字典。

fillSendEventProperties

protected CompletableFuture> fillSendEventProperties(Activity activity, Map additionalProperties)

填充 BotMessageSend 的事件属性。 机器人向用户发送活动消息时记录这些属性。

参数:

activity - 从用户发送的最后一个活动。
additionalProperties - 要添加到事件的其他属性。

返回:

作为“属性”发送到 BotMessageSend 事件的 BotTelemetryClient#trackEvent 方法的字典。

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

填充 BotMessageUpdate 的事件属性。 机器人向用户发送活动消息时记录这些属性。

参数:

activity - 从用户发送的最后一个活动。
additionalProperties - 要添加到事件的其他属性。

返回:

作为“属性”发送到 BotMessageUpdate 事件的 BotTelemetryClient#trackEvent 方法的字典。

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

获取记录事件的当前配置的 BotTelemetryClient。

返回:

用于记录事件的 BotTelemetryClient。

onDeleteActivity

protected CompletableFuture onDeleteActivity(Activity activity)

机器人删除消息时调用。 使用 BotTelemetryClient#trackEvent 方法执行遥测数据的日志记录。 使用此事件名称是“BotMessageDelete”。

参数:

activity - 从用户发送的当前活动。

返回:

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

onReceiveActivity

protected CompletableFuture onReceiveActivity(Activity activity)

从用户收到消息时调用。 使用 BotTelemetryClient#trackEvent 方法执行遥测数据的日志记录。 使用此事件名称是“BotMessageReceived”。

参数:

activity - 从用户发送的当前活动。

返回:

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

onSendActivity

protected CompletableFuture onSendActivity(Activity activity)

机器人向用户发送消息时调用。 使用 BotTelemetryClient#trackEvent 方法执行遥测数据的日志记录。 使用的此事件名称为“BotMessageSend”。

参数:

activity - 从用户发送的当前活动。

返回:

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

onTurn

public CompletableFuture onTurn(TurnContext context, NextDelegate next)

使用 BotTelemetryClient 接口基于传入和传出活动记录事件。

参数:

context - 此轮次的上下文对象。
next - 要调用以继续机器人中间件管道的委托。

返回:

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

onUpdateActivity

protected CompletableFuture onUpdateActivity(Activity activity)

机器人更新消息时调用。 使用 BotTelemetryClient#trackEvent 方法执行遥测数据的日志记录。 使用的此事件名称为“BotMessageUpdate”。

参数:

activity - 从用户发送的当前活动。

返回:

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

适用于