TelemetryLoggerMiddleware Classe

  • Référence
Paquet:
com.microsoft.bot.builder
Artefact Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.TelemetryLoggerMiddleware

Implémente

middleware

public class TelemetryLoggerMiddleware
implements Middleware

Middleware pour la journalisation des messages d’activité entrants, sortants, mis à jour ou supprimés. Utilise l’interface BotTelemetryClient.

Récapitulatif du constructeur

Constructeur Description
TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Initialise une nouvelle instance de la classe.

Résumé de la méthode

Modificateur et type Méthode et description
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillDeleteEventProperties(Activity activity, Map<String,String> additionalProperties)

Remplit les propriétés d’événement de BotMessageDelete.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillReceiveEventProperties(Activity activity, Map<String,String> additionalProperties)

Remplit les propriétés d’événement du message botreçu.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillSendEventProperties(Activity activity, Map<String,String> additionalProperties)

Remplit les propriétés d’événement de BotMessageEnvoyer.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillUpdateEventProperties(Activity activity, Map<String,String> additionalProperties)

Remplit les propriétés d’événement de BotMessageUpdate.
BotTelemetryClient getTelemetryClient()

Obtient le BotTelemetry actuellement configuréClient qui journalise l’événement.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(Activity activity)

Appelé lorsque le bot supprime un message.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onReceiveActivity(Activity activity)

Appelé lorsqu’un message est reçu de l’utilisateur.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onSendActivity(Activity activity)

Appelé lorsque le bot envoie un message à l’utilisateur.
java.util.concurrent.CompletableFuture<java.lang.Void> onTurn(TurnContext context, NextDelegate next)

Enregistre les événements basés sur les activités entrantes et sortantes à l’aide de l’interface BotTelemetryClient.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onUpdateActivity(Activity activity)

Appelé lorsque le bot met à jour un message.

Méthodes héritées 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

Détails du constructeur

TelemetryLoggerMiddleware

public TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Initialise une nouvelle instance de la classe.

Paramètres:

withTelemetryClient - Implémentation IBotTelemetryClient utilisée pour inscrire des événements de télémétrie.
withLogPersonalInformation - TRUE pour inclure des informations d’identification personnelle.

Détails de la méthode

fillDeleteEventProperties

protected CompletableFuture> fillDeleteEventProperties(Activity activity, Map additionalProperties)

Remplit les propriétés d’événement pour BotMessageDelete. Ces propriétés sont enregistrées lorsqu’un message d’activité est envoyé par le bot à l’utilisateur.

Paramètres:

activity - Dernière activité envoyée par l’utilisateur.
additionalProperties - Propriétés supplémentaires à ajouter à l’événement.

Retours:

Dictionnaire envoyé en tant que « Properties » pour BotTelemetryClient#trackEvent méthode pour l’événement BotMessageDelete.

fillReceiveEventProperties

protected CompletableFuture> fillReceiveEventProperties(Activity activity, Map additionalProperties)

Remplit les propriétés d’événement pour BotMessageReceived. Respecte l’indicateur LogPersonalInformation pour filtrer les propriétés Name, Text and Speak.

Paramètres:

activity - Dernière activité envoyée par l’utilisateur.
additionalProperties - Propriétés supplémentaires à ajouter à l’événement.

Retours:

Dictionnaire envoyé en tant que « Properties » pour BotTelemetryClient#trackEvent méthode pour l’événement BotMessageReceived.

fillSendEventProperties

protected CompletableFuture> fillSendEventProperties(Activity activity, Map additionalProperties)

Remplit les propriétés d’événement pour BotMessageSend. Ces propriétés sont enregistrées lorsqu’un message d’activité est envoyé par le bot à l’utilisateur.

Paramètres:

activity - Dernière activité envoyée par l’utilisateur.
additionalProperties - Propriétés supplémentaires à ajouter à l’événement.

Retours:

Dictionnaire envoyé en tant que « Properties » pour BotTelemetryClient#trackEvent méthode pour l’événement BotMessageSend.

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

Remplit les propriétés d’événement pour BotMessageUpdate. Ces propriétés sont enregistrées lorsqu’un message d’activité est envoyé par le bot à l’utilisateur.

Paramètres:

activity - Dernière activité envoyée par l’utilisateur.
additionalProperties - Propriétés supplémentaires à ajouter à l’événement.

Retours:

Dictionnaire envoyé en tant que « Properties » pour BotTelemetryClient#trackEvent méthode pour l’événement BotMessageUpdate.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Obtient le BotTelemetryClient actuellement configuré qui journalise l’événement.

Retours:

Le BotTelemetryClient utilisé pour journaliser les événements.

onDeleteActivity

protected CompletableFuture onDeleteActivity(Activity activity)

Appelé lorsque le bot supprime un message. Effectue la journalisation des données de télémétrie à l’aide de la méthode BotTelemetryClient#trackEvent. Ce nom d’événement utilisé est « BotMessageDelete ».

Paramètres:

activity - Activité actuelle envoyée par l’utilisateur.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

onReceiveActivity

protected CompletableFuture onReceiveActivity(Activity activity)

Appelé lorsqu’un message est reçu de l’utilisateur. Effectue la journalisation des données de télémétrie à l’aide de la méthode BotTelemetryClient#trackEvent. Ce nom d’événement utilisé est « BotMessageReceived ».

Paramètres:

activity - Activité actuelle envoyée par l’utilisateur.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

onSendActivity

protected CompletableFuture onSendActivity(Activity activity)

Appelé lorsque le bot envoie un message à l’utilisateur. Effectue la journalisation des données de télémétrie à l’aide de la méthode BotTelemetryClient#trackEvent. Ce nom d’événement utilisé est « BotMessageSend ».

Paramètres:

activity - Activité actuelle envoyée par l’utilisateur.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

onTurn

public CompletableFuture onTurn(TurnContext context, NextDelegate next)

Enregistre les événements basés sur les activités entrantes et sortantes à l’aide de l’interface BotTelemetryClient.

Paramètres:

context - Objet de contexte pour ce tour.
next - Délégué à appeler pour continuer le pipeline d’intergiciel de bot.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

onUpdateActivity

protected CompletableFuture onUpdateActivity(Activity activity)

Appelé lorsque le bot met à jour un message. Effectue la journalisation des données de télémétrie à l’aide de la méthode BotTelemetryClient#trackEvent. Ce nom d’événement utilisé est « BotMessageUpdate ».

Paramètres:

activity - Activité actuelle envoyée par l’utilisateur.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

S’applique à