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)

Заполняет свойства события длясообщения ботаполучено.
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()

Возвращает настроенный в данный момент боттелеметрииклиент, который регистрирует событие.
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 - Дополнительные свойства для добавления в событие.

Возвращаемое значение:

Словарь, который отправляется как "Свойства" в метод BotTelemetryClient#trackEvent для события BotMessageDelete.

fillReceiveEventProperties

protected CompletableFuture> fillReceiveEventProperties(Activity activity, Map additionalProperties)

Заполняет свойства события для BotMessageReceived. Соответствует флагу LogPersonalInformation для фильтрации свойств Name, Text и Speak.

Параметры:

activity - Последнее действие, отправленное пользователем.
additionalProperties - Дополнительные свойства для добавления в событие.

Возвращаемое значение:

Словарь, который отправляется как "Свойства" в метод BotTelemetryClient#trackEvent для события BotMessageReceived.

fillSendEventProperties

protected CompletableFuture> fillSendEventProperties(Activity activity, Map additionalProperties)

Заполняет свойства события для BotMessageSend. Эти свойства регистрируются при отправке ботом пользователю сообщения о действиях.

Параметры:

activity - Последнее действие, отправленное пользователем.
additionalProperties - Дополнительные свойства для добавления в событие.

Возвращаемое значение:

Словарь, который отправляется как "Свойства" в метод BotTelemetryClient#trackEvent для события BotMessageSend.

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

Заполняет свойства события для BotMessageUpdate. Эти свойства регистрируются при отправке ботом пользователю сообщения о действиях.

Параметры:

activity - Последнее действие, отправленное пользователем.
additionalProperties - Дополнительные свойства для добавления в событие.

Возвращаемое значение:

Словарь, который отправляется как "Свойства" в метод BotTelemetryClient#trackEvent для события BotMessageUpdate.

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 - Текущее действие, отправленное пользователем.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

Применяется к