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)

BotMessageReceived のイベント プロパティを入力します。
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillSendEventProperties(Activity activity, Map<String,String> additionalProperties)

BotMessageSend のイベント プロパティを入力します。
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillUpdateEventProperties(Activity activity, Map<String,String> additionalProperties)

BotMessageUpdate のイベント プロパティを入力します。
BotTelemetryClient getTelemetryClient()

イベントをログに記録する現在構成されている BotTelemetryClient を取得します。
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 メソッドに "Properties" として送信されるディクショナリ。

fillReceiveEventProperties

protected CompletableFuture> fillReceiveEventProperties(Activity activity, Map additionalProperties)

BotMessageReceived のイベント プロパティを入力します。 LogPersonalInformation フラグに従って、Name、Text、Speak プロパティをフィルター処理します。

パラメーター:

activity - ユーザーから送信された最後のアクティビティ。
additionalProperties - イベントに追加する追加のプロパティ。

戻り値:

BotMessageReceived イベントのメソッド BotTelemetryClient#trackEvent に "Properties" として送信されるディクショナリ。

fillSendEventProperties

protected CompletableFuture> fillSendEventProperties(Activity activity, Map additionalProperties)

BotMessageSend のイベント プロパティを入力します。 これらのプロパティは、ボットによってユーザーにアクティビティ メッセージが送信されるときにログに記録されます。

パラメーター:

activity - ユーザーから送信された最後のアクティビティ。
additionalProperties - イベントに追加する追加のプロパティ。

戻り値:

BotMessageSend イベントのメソッド BotTelemetryClient#trackEvent に "Properties" として送信されるディクショナリ。

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

BotMessageUpdate のイベント プロパティを入力します。 これらのプロパティは、ボットによってユーザーにアクティビティ メッセージが送信されるときにログに記録されます。

パラメーター:

activity - ユーザーから送信された最後のアクティビティ。
additionalProperties - イベントに追加する追加のプロパティ。

戻り値:

BotMessageUpdate イベントのメソッド BotTelemetryClient#trackEvent に "Properties" として送信されるディクショナリ。

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 - ユーザーから送信された現在のアクティビティ。

戻り値:

実行するキューに登録された作業を表すタスク。

適用対象