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 介面。

建構函式摘要

建構函式 Description
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()

取得目前設定的 Bot遙測客戶端記錄事件。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(Activity activity)

Bot 刪除訊息時叫用。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onReceiveActivity(Activity activity)

從使用者收到訊息時叫用。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onSendActivity(Activity activity)

Bot 傳送訊息給使用者時叫用。
java.util.concurrent.CompletableFuture<java.lang.Void> onTurn(TurnContext context, NextDelegate next)

使用 BotTelemetryClient 介面，根據傳入和傳出活動記錄事件。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onUpdateActivity(Activity activity)

Bot 更新訊息時叫用。

方法繼承來源 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 的事件屬性。 當 Bot 將活動訊息傳送給使用者時，會記錄這些屬性。

參數:

activity - 上次從用戶傳送的活動。
additionalProperties - 要新增至事件的其他屬性。

傳回:

以 「Properties」 傳送至 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 的事件屬性。 當 Bot 將活動訊息傳送給使用者時，會記錄這些屬性。

參數:

activity - 上次從用戶傳送的活動。
additionalProperties - 要新增至事件的其他屬性。

傳回:

以 「Properties」 傳送至 BotMessageSend 事件的 BotTelemetryClient#trackEvent 方法的字典。

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

填入 BotMessageUpdate 的事件屬性。 當 Bot 將活動訊息傳送給使用者時，會記錄這些屬性。

參數:

activity - 上次從用戶傳送的活動。
additionalProperties - 要新增至事件的其他屬性。

傳回:

以 「Properties」 傳送至 BotMessageUpdate 事件的 BotTelemetryClient#trackEvent 方法的字典。

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

取得記錄事件的目前設定 BotTelemetryClient。

傳回:

用來記錄事件的 BotTelemetryClient。

onDeleteActivity

protected CompletableFuture onDeleteActivity(Activity activity)

Bot 刪除訊息時叫用。 使用 BotTelemetryClient#trackEvent 方法來執行遙測數據的記錄。 使用此事件名稱是 「BotMessageDelete」。

參數:

activity - 從用戶傳送的目前活動。

傳回:

工作，表示要執行的工作佇列。

onReceiveActivity

protected CompletableFuture onReceiveActivity(Activity activity)

從使用者收到訊息時叫用。 使用 BotTelemetryClient#trackEvent 方法來執行遙測數據的記錄。 使用此事件名稱是 「BotMessageReceived」。

參數:

activity - 從用戶傳送的目前活動。

傳回:

工作，表示要執行的工作佇列。

onSendActivity

protected CompletableFuture onSendActivity(Activity activity)

Bot 傳送訊息給使用者時叫用。 使用 BotTelemetryClient#trackEvent 方法來執行遙測數據的記錄。 使用此事件名稱是 「BotMessageSend」。

參數:

activity - 從用戶傳送的目前活動。

傳回:

工作，表示要執行的工作佇列。

onTurn

public CompletableFuture onTurn(TurnContext context, NextDelegate next)

使用 BotTelemetryClient 介面，根據傳入和傳出活動記錄事件。

參數:

context - 這個回合的內容物件。
next - 要呼叫以繼續 Bot 中間件管線的委派。

傳回:

工作，表示要執行的工作佇列。

onUpdateActivity

protected CompletableFuture onUpdateActivity(Activity activity)

Bot 更新訊息時叫用。 使用 BotTelemetryClient#trackEvent 方法來執行遙測數據的記錄。 使用此事件名稱是 「BotMessageUpdate」。

參數:

activity - 從用戶傳送的目前活動。

傳回:

工作，表示要執行的工作佇列。

適用於