C G H I J K L O R S W

C

checkForDeepLink() - Method in class com.mparticle.kits.KitIntegration

clearIntegrationAttributes() - Method in class com.mparticle.kits.KitIntegration

Remove all integration attributes set for this integration.

com.mparticle.kits - package com.mparticle.kits

G

getConfiguration() - Method in class com.mparticle.kits.KitIntegration

Get the configuration of the Kit.

getContext() - Method in class com.mparticle.kits.KitIntegration

Get an application Context object.

getCurrentActivity() - Method in class com.mparticle.kits.KitIntegration

Get a WeakReference to an Activity.

getInstance() - Method in class com.mparticle.kits.KitIntegration

Kits should override this method in order to provide implementing developers direct access to their APIs.

getIntegrationAttributes() - Method in class com.mparticle.kits.KitIntegration

Get integration attributes.

getKitManager() - Method in class com.mparticle.kits.KitIntegration

getName() - Method in class com.mparticle.kits.KitIntegration

Kits must override this an provide a human-readable name of their service.

getSettings() - Method in class com.mparticle.kits.KitIntegration

Retrieve the settings that are configured for this Kit, such as API key, etc

H

hashFnv1a(byte[]) - Static method in class com.mparticle.kits.KitUtils

Hash using the Fnv1a algorithm.

I

isBackgrounded() - Method in class com.mparticle.kits.KitIntegration

Determine if the application is currently in the background.

isDisabled() - Method in class com.mparticle.kits.KitIntegration

isServiceAvailable(Context, Class<?>) - Static method in class com.mparticle.kits.KitUtils

Check if the given Service class is present in the hosting app's AndroidManifest.

J

join(List<String>) - Static method in class com.mparticle.kits.KitUtils

Combine the given list into a single string separated by a comma.

join(List<String>, String) - Static method in class com.mparticle.kits.KitUtils

Combine the given list into a single string separated by the given delimiter.

K

KitIntegration - Class in com.mparticle.kits

Base Kit implementation - all Kits must subclass this.

KitIntegration() - Constructor for class com.mparticle.kits.KitIntegration

KitIntegration.ActivityListener - Interface in com.mparticle.kits

Kits should implement this interface when they require Activity callbacks for any reason.

KitIntegration.AttributeListener - Interface in com.mparticle.kits

Kits should implement this interface when their underlying service has the notion of a user with attributes.

KitIntegration.CommerceListener - Interface in com.mparticle.kits

Kits should implement this interface in order to listen for eCommerce events

KitIntegration.EventListener - Interface in com.mparticle.kits

Kits should implement this listener to ensure they receive events as they are sent into the mParticle SDK.

KitIntegration.PushListener - Interface in com.mparticle.kits

Kits should implement this interface when they have Google Cloud Messaging/push features.

KitUtils - Class in com.mparticle.kits

Mixin/Utility class for use in Kit implementations.

KitUtils() - Constructor for class com.mparticle.kits.KitUtils

L

leaveBreadcrumb(String) - Method in interface com.mparticle.kits.KitIntegration.EventListener

The mParticle SDK exposes a breadcrumb API, allowing developers to track transactions as they occur.

logError(String, Map<String, String>) - Method in interface com.mparticle.kits.KitIntegration.EventListener

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

logEvent(CommerceEvent) - Method in interface com.mparticle.kits.KitIntegration.CommerceListener

The mParticle SDK exposes a rich eCommerce API, allowing developers to keep track of purchases and many other product-related interactions.

logEvent(MPEvent) - Method in interface com.mparticle.kits.KitIntegration.EventListener

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

logException(Exception, Map<String, String>, String) - Method in interface com.mparticle.kits.KitIntegration.EventListener

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

logLtvIncrease(BigDecimal, BigDecimal, String, Map<String, String>) - Method in interface com.mparticle.kits.KitIntegration.CommerceListener

The mParticle SDK exposes a basic lifetime-value-increase API.

logout() - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

The mParticle SDK exposes a logout API, allowing developers to track an event when a user logs out of their app/platform.

logScreen(String, Map<String, String>) - Method in interface com.mparticle.kits.KitIntegration.EventListener

The mParticle SDK exposes a screen-view API, allowing developers to keep track of screens that are viewed by the user.

O

onActivityCreated(Activity, Bundle) - Method in interface com.mparticle.kits.KitIntegration.ActivityListener

onActivityDestroyed(Activity) - Method in interface com.mparticle.kits.KitIntegration.ActivityListener

onActivityPaused(Activity) - Method in interface com.mparticle.kits.KitIntegration.ActivityListener

onActivityResumed(Activity) - Method in interface com.mparticle.kits.KitIntegration.ActivityListener

onActivitySaveInstanceState(Activity, Bundle) - Method in interface com.mparticle.kits.KitIntegration.ActivityListener

onActivityStarted(Activity) - Method in interface com.mparticle.kits.KitIntegration.ActivityListener

onActivityStopped(Activity) - Method in interface com.mparticle.kits.KitIntegration.ActivityListener

onKitCreate(Map<String, String>, Context) - Method in class com.mparticle.kits.KitIntegration

Kits must override this method and should use it for initialization.

onKitDestroy() - Method in class com.mparticle.kits.KitIntegration

This method will be called when an integration has been disabled.

onPushMessageReceived(Context, Intent) - Method in interface com.mparticle.kits.KitIntegration.PushListener

If a Kit returns true from KitIntegration.PushListener.willHandlePushMessage(Intent), this method will be called immediately after.

onPushRegistration(String, String) - Method in interface com.mparticle.kits.KitIntegration.PushListener

This method will be called when the mParticle SDK successfully registers to receive push messages.

R

removeUserAttribute(String) - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

removeUserIdentity(MParticle.IdentityType) - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

S

sanitizeAttributeKey(String) - Static method in class com.mparticle.kits.KitUtils

mParticle attribute keys defined by the `MParticle.UserAttributes` interface are preceded by a dollar-sign ie `"$FirstName"`.

setAllUserAttributes(Map<String, String>, Map<String, List<String>>) - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

setConfiguration(KitConfiguration) - Method in class com.mparticle.kits.KitIntegration

setInstallReferrer(Intent) - Method in class com.mparticle.kits.KitIntegration

Implement this method to receive com.android.vending.INSTALL_REFERRER Intents that have been captured by the mParticle SDK.

setIntegrationAttributes(Map<String, String>) - Method in class com.mparticle.kits.KitIntegration

Set integration attributes.

setKitManager(KitManagerImpl) - Method in class com.mparticle.kits.KitIntegration

setLocation(Location) - Method in class com.mparticle.kits.KitIntegration

The mParticle SDK is able to track a user's location based on provider and accuracy settings, and additionally allows developers to manually set a location.

setOptOut(boolean) - Method in class com.mparticle.kits.KitIntegration

setUserAttribute(String, String) - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

setUserAttributeList(String, List<String>) - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

setUserIdentity(MParticle.IdentityType, String) - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

supportsAttributeLists() - Method in interface com.mparticle.kits.KitIntegration.AttributeListener

Indicate to the mParticle Kit framework if this AttributeListener supports attribute-values as lists.

W

willHandlePushMessage(Intent) - Method in interface com.mparticle.kits.KitIntegration.PushListener

Kits must implement this method to inspect a push message to determine if it's intended for their SDK.

C G H I J K L O R S W