TelemetryLoggerMiddleware Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.builder
Artefatto Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.TelemetryLoggerMiddleware

Implementazioni

middleware

public class TelemetryLoggerMiddleware
implements Middleware

Middleware per la registrazione dei messaggi attività in ingresso, in uscita, aggiornati o eliminati. Usa l'interfaccia BotTelemetryClient.

Riepilogo dei costruttori

Costruttore Descrizione
TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Inizializza una nuova istanza della classe .

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillDeleteEventProperties(Activity activity, Map<String,String> additionalProperties)

Riempie le proprietà dell'evento per BotMessageDelete.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillReceiveEventProperties(Activity activity, Map<String,String> additionalProperties)

Riempie le proprietà dell'evento per BotMessageReceived.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillSendEventProperties(Activity activity, Map<String,String> additionalProperties)

Compila le proprietà dell'evento per BotMessageSend.
protected java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> fillUpdateEventProperties(Activity activity, Map<String,String> additionalProperties)

Riempie le proprietà dell'evento per BotMessageUpdate.
BotTelemetryClient getTelemetryClient()

Ottiene il bot attualmente configuratoTelemetryClient che registra l'evento.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(Activity activity)

Richiamato quando il bot elimina un messaggio.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onReceiveActivity(Activity activity)

Richiamato quando un messaggio viene ricevuto dall'utente.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onSendActivity(Activity activity)

Richiamato quando il bot invia un messaggio all'utente.
java.util.concurrent.CompletableFuture<java.lang.Void> onTurn(TurnContext context, NextDelegate next)

Registra gli eventi in base alle attività in ingresso e in uscita usando l'interfaccia BotTelemetryClient.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onUpdateActivity(Activity activity)

Richiamato quando il bot aggiorna un messaggio.

Metodi ereditati da 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

Dettagli costruttore

TelemetryLoggerMiddleware

public TelemetryLoggerMiddleware(BotTelemetryClient withTelemetryClient, boolean withLogPersonalInformation)

Inizializza una nuova istanza della classe .

Parametri:

withTelemetryClient - Implementazione IBotTelemetryClient usata per registrare gli eventi di telemetria.
withLogPersonalInformation - TRUE per includere informazioni personali.

Dettagli metodo

fillDeleteEventProperties

protected CompletableFuture> fillDeleteEventProperties(Activity activity, Map additionalProperties)

Riempie le proprietà dell'evento per BotMessageDelete. Queste proprietà vengono registrate quando un messaggio di attività viene inviato dal bot all'utente.

Parametri:

activity - Ultima attività inviata dall'utente.
additionalProperties - Proprietà aggiuntive da aggiungere all'evento.

Restituisce:

Dizionario inviato come "Proprietà" al metodo BotTelemetryClient#trackEvent per l'evento BotMessageDelete.

fillReceiveEventProperties

protected CompletableFuture> fillReceiveEventProperties(Activity activity, Map additionalProperties)

Riempie le proprietà dell'evento per BotMessageReceived. Rispetta il flag LogPersonalInformation per filtrare le proprietà Name, Text e Speak.

Parametri:

activity - Ultima attività inviata dall'utente.
additionalProperties - Proprietà aggiuntive da aggiungere all'evento.

Restituisce:

Dizionario inviato come "Proprietà" al metodo BotTelemetryClient#trackEvent per l'evento BotMessageReceived.

fillSendEventProperties

protected CompletableFuture> fillSendEventProperties(Activity activity, Map additionalProperties)

Riempie le proprietà dell'evento per BotMessageSend. Queste proprietà vengono registrate quando un messaggio di attività viene inviato dal bot all'utente.

Parametri:

activity - Ultima attività inviata dall'utente.
additionalProperties - Proprietà aggiuntive da aggiungere all'evento.

Restituisce:

Dizionario inviato come "Proprietà" al metodo BotTelemetryClient#trackEvent per l'evento BotMessageSend.

fillUpdateEventProperties

protected CompletableFuture> fillUpdateEventProperties(Activity activity, Map additionalProperties)

Riempie le proprietà dell'evento per BotMessageUpdate. Queste proprietà vengono registrate quando un messaggio di attività viene inviato dal bot all'utente.

Parametri:

activity - Ultima attività inviata dall'utente.
additionalProperties - Proprietà aggiuntive da aggiungere all'evento.

Restituisce:

Dizionario inviato come "Proprietà" al metodo BotTelemetryClient#trackEvent per l'evento BotMessageUpdate.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Ottiene l'oggetto BotTelemetryClient attualmente configurato che registra l'evento.

Restituisce:

Il BotTelemetryClient utilizzato per registrare gli eventi.

onDeleteActivity

protected CompletableFuture onDeleteActivity(Activity activity)

Richiamato quando il bot elimina un messaggio. Esegue la registrazione dei dati di telemetria usando il metodo BotTelemetryClient#trackEvent. Questo nome di evento usato è "BotMessageDelete".

Parametri:

activity - Attività corrente inviata dall'utente.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

onReceiveActivity

protected CompletableFuture onReceiveActivity(Activity activity)

Richiamato quando un messaggio viene ricevuto dall'utente. Esegue la registrazione dei dati di telemetria usando il metodo BotTelemetryClient#trackEvent. Questo nome di evento usato è "BotMessageReceived".

Parametri:

activity - Attività corrente inviata dall'utente.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

onSendActivity

protected CompletableFuture onSendActivity(Activity activity)

Richiamato quando il bot invia un messaggio all'utente. Esegue la registrazione dei dati di telemetria usando il metodo BotTelemetryClient#trackEvent. Questo nome di evento usato è "BotMessageSend".

Parametri:

activity - Attività corrente inviata dall'utente.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

onTurn

public CompletableFuture onTurn(TurnContext context, NextDelegate next)

Registra gli eventi in base alle attività in ingresso e in uscita usando l'interfaccia BotTelemetryClient.

Parametri:

context - Oggetto di contesto per questo turno.
next - Delegato da chiamare per continuare la pipeline del middleware del bot.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

onUpdateActivity

protected CompletableFuture onUpdateActivity(Activity activity)

Richiamato quando il bot aggiorna un messaggio. Esegue la registrazione dei dati di telemetria usando il metodo BotTelemetryClient#trackEvent. Questo nome di evento usato è "BotMessageUpdate".

Parametri:

activity - Attività corrente inviata dall'utente.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

Si applica a