com.mparticle.kits

Interface KitIntegration.EventListener

Enclosing class:

KitIntegration

public static interface KitIntegration.EventListener

Kits should implement this listener to ensure they receive events as they are sent into the mParticle SDK. The methods in this listener generally have a 1-1 mapping with the mParticle SDKs public API - it is the reasonability of Kit-writers to faithfully map the appropriate mParticle APIs onto the proper APIs in their service.

Method Summary

Modifier and Type	Method and Description
java.util.List<ReportingMessage>	leaveBreadcrumb(java.lang.String breadcrumb) The mParticle SDK exposes a breadcrumb API, allowing developers to track transactions as they occur.
java.util.List<ReportingMessage>	logError(java.lang.String message, java.util.Map<java.lang.String,java.lang.String> errorAttributes) The mParticle SDK exposes an error API, allowing developers to keep track of handled errors.
java.util.List<ReportingMessage>	logEvent(MPEvent event) The mParticle SDK exposes a general event API, allowing developers to keep track of any activity with their app.
java.util.List<ReportingMessage>	logException(java.lang.Exception exception, java.util.Map<java.lang.String,java.lang.String> exceptionAttributes, java.lang.String message) The mParticle SDK exposes an exception API, allowing developers to keep track of handled exceptions.
java.util.List<ReportingMessage>	logScreen(java.lang.String screenName, java.util.Map<java.lang.String,java.lang.String> screenAttributes) The mParticle SDK exposes a screen-view API, allowing developers to keep track of screens that are viewed by the user.

Method Detail

leaveBreadcrumb

java.util.List<ReportingMessage> leaveBreadcrumb(java.lang.String breadcrumb)

The mParticle SDK exposes a breadcrumb API, allowing developers to track transactions as they occur. Implementing Kits may optionally forward breadcrumbs to their SDK as regular events if there is no direct API analogue.

Parameters:

breadcrumb - a human-readable, typically short label of a step in a transaction, funnel, etc

Returns:

Kits should return a List of ReportingMessages indicating that the breadcrumb was processed one or more times, or null if it was not processed

logError

java.util.List<ReportingMessage> logError(java.lang.String message,
                                          java.util.Map<java.lang.String,java.lang.String> errorAttributes)

The mParticle SDK exposes an error API, allowing developers to keep track of handled errors.

Parameters:

message - a description of the error

errorAttributes - optional attributes to associate with the error

Returns:

Kits should return a List of ReportingMessages indicating that the error was processed one or more times, or null if it was not processed

logException

java.util.List<ReportingMessage> logException(java.lang.Exception exception,
                                              java.util.Map<java.lang.String,java.lang.String> exceptionAttributes,
                                              java.lang.String message)

The mParticle SDK exposes an exception API, allowing developers to keep track of handled exceptions.

Parameters:

exception - the exception that was caught

message - a description of the error

exceptionAttributes - optional attributes to associate with the error

Returns:

Kits should return a List of ReportingMessages indicating that the exception was processed one or more times, or null if it was not processed

logEvent

java.util.List<ReportingMessage> logEvent(MPEvent event)

The mParticle SDK exposes a general event API, allowing developers to keep track of any activity with their app.

Parameters:

event - the MPEvent that was logged.

Returns:

Kits should return a List of ReportingMessages indicating that the MPEvent was processed one or more times, or null if it was not processed

logScreen

java.util.List<ReportingMessage> logScreen(java.lang.String screenName,
                                           java.util.Map<java.lang.String,java.lang.String> screenAttributes)

The mParticle SDK exposes a screen-view API, allowing developers to keep track of screens that are viewed by the user. Some mParticle integrations use screen views for funnel analysis. Implementing Kits may optionally forward screen views to their SDK as regular events if there is no direct API analogue

Parameters:

screenName - the name of the screen

screenAttributes - optional Map of attributes associated with this event

Returns:

Kits should return a List of ReportingMessages indicating that the screen-view was processed one or more times, or null if it was not processed