TelemetryLoggerMiddleware Classe

  • Referência
Pacote:
com.microsoft.bot.builder
Artefato Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.TelemetryLoggerMiddleware

Implementações

do Middleware

public class TelemetryLoggerMiddleware
implements Middleware

Middleware para registrar mensagens de atividade de entrada, saída, atualizadas ou excluídas. Usa a interface BotTelemetryClient.

Resumo do Construtor

Construtor Description
TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Inicializa uma nova instância da classe.

Resumo do método

Modificador e tipo Método e descrição
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillDeleteEventProperties(Activity activity, Map<String,String> additionalProperties)

Preenche as propriedades do evento para BotMessageDelete.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillReceiveEventProperties(Activity activity, Map<String,String> additionalProperties)

Preenche as propriedades do evento para o BotMessageReceived.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillSendEventProperties(Activity activity, Map<String,String> additionalProperties)

Preenche as propriedades do evento para Enviarde Mensagem do Bot.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillUpdateEventProperties(Activity activity, Map<String,String> additionalProperties)

Preenche as propriedades do evento para o BotMessageUpdate.
BotTelemetryClient getTelemetryClient()

Obtém o Cliente dede Telemetria do Botconfigurado no momento que registra o evento em log.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(Activity activity)

Invocado quando o bot exclui uma mensagem.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onReceiveActivity(Activity activity)

Invocado quando uma mensagem é recebida do usuário.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onSendActivity(Activity activity)

Invocado quando o bot envia uma mensagem para o usuário.
java.util.concurrent.CompletableFuture<java.lang.Void> onTurn(TurnContext context, NextDelegate next)

Registra eventos com base em atividades de entrada e saída usando a interface BotTelemetryClient.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onUpdateActivity(Activity activity)

Invocado quando o bot atualiza uma mensagem.

Métodos herdados de 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

Detalhes do construtor

TelemetryLoggerMiddleware

public TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Inicializa uma nova instância da classe.

Parâmetros:

withTelemetryClient - A implementação IBotTelemetryClient usada para registrar eventos de telemetria.
withLogPersonalInformation - TRUE para incluir informações de identificação pessoal.

Detalhes do método

fillDeleteEventProperties

protected CompletableFuture> fillDeleteEventProperties(Activity activity, Map additionalProperties)

Preenche as propriedades do evento para BotMessageDelete. Essas propriedades são registradas quando uma mensagem de atividade é enviada pelo Bot para o usuário.

Parâmetros:

activity - Última atividade enviada do usuário.
additionalProperties - Propriedades adicionais a serem adicionadas ao evento.

Retornos:

Um dicionário enviado como "Propriedades" para BotTelemetryClient#trackEvent método para o evento BotMessageDelete.

fillReceiveEventProperties

protected CompletableFuture> fillReceiveEventProperties(Activity activity, Map additionalProperties)

Preenche as propriedades do evento para o BotMessageReceived. Adere ao sinalizador LogPersonalInformation para filtrar as propriedades Nome, Texto e Fala.

Parâmetros:

activity - Última atividade enviada do usuário.
additionalProperties - Propriedades adicionais a serem adicionadas ao evento.

Retornos:

Um dicionário que é enviado como "Propriedades" para BotTelemetryClient#trackEvent método para o evento BotMessageReceived.

fillSendEventProperties

protected CompletableFuture> fillSendEventProperties(Activity activity, Map additionalProperties)

Preenche as propriedades do evento para BotMessageSend. Essas propriedades são registradas quando uma mensagem de atividade é enviada pelo Bot para o usuário.

Parâmetros:

activity - Última atividade enviada do usuário.
additionalProperties - Propriedades adicionais a serem adicionadas ao evento.

Retornos:

Um dicionário que é enviado como "Propriedades" para BotTelemetryClient#trackEvent método para o evento BotMessageSend.

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

Preenche as propriedades do evento para BotMessageUpdate. Essas propriedades são registradas quando uma mensagem de atividade é enviada pelo Bot para o usuário.

Parâmetros:

activity - Última atividade enviada do usuário.
additionalProperties - Propriedades adicionais a serem adicionadas ao evento.

Retornos:

Um dicionário que é enviado como "Propriedades" para BotTelemetryClient#trackEvent método para o evento BotMessageUpdate.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Obtém o BotTelemetryClient configurado no momento que registra o evento em log.

Retornos:

O BotTelemetryClient sendo usado para registrar eventos em log.

onDeleteActivity

protected CompletableFuture onDeleteActivity(Activity activity)

Invocado quando o bot exclui uma mensagem. Executa o registro em log de dados de telemetria usando o método BotTelemetryClient#trackEvent. Esse nome de evento usado é "BotMessageDelete".

Parâmetros:

activity - Atividade atual enviada do usuário.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

onReceiveActivity

protected CompletableFuture onReceiveActivity(Activity activity)

Invocado quando uma mensagem é recebida do usuário. Executa o registro em log de dados de telemetria usando o método BotTelemetryClient#trackEvent. Esse nome de evento usado é "BotMessageReceived".

Parâmetros:

activity - Atividade atual enviada do usuário.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

onSendActivity

protected CompletableFuture onSendActivity(Activity activity)

Invocado quando o bot envia uma mensagem para o usuário. Executa o registro em log de dados de telemetria usando o método BotTelemetryClient#trackEvent. Esse nome de evento usado é "BotMessageSend".

Parâmetros:

activity - Atividade atual enviada do usuário.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

onTurn

public CompletableFuture onTurn(TurnContext context, NextDelegate next)

Registra eventos com base em atividades de entrada e saída usando a interface BotTelemetryClient.

Parâmetros:

context - O objeto de contexto para este turno.
next - O delegado a ser chamado para continuar o pipeline de middleware de bot.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

onUpdateActivity

protected CompletableFuture onUpdateActivity(Activity activity)

Invocado quando o bot atualiza uma mensagem. Executa o registro em log de dados de telemetria usando o método BotTelemetryClient#trackEvent. Esse nome de evento usado é "BotMessageUpdate".

Parâmetros:

activity - Atividade atual enviada do usuário.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

Aplica-se a