KitIntegration (mParticle Android Kit API Reference)

java.lang.Object
- com.mparticle.kits.KitIntegration

public abstract class KitIntegration
extends java.lang.Object

Base Kit implementation - all Kits must subclass this.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`KitIntegration.ActivityListener` Kits should implement this interface when they require Activity callbacks for any reason.
`static interface`	`KitIntegration.AttributeListener` Kits should implement this interface when their underlying service has the notion of a user with attributes.
`static interface`	`KitIntegration.CommerceListener` Kits should implement this interface in order to listen for eCommerce events
`static interface`	`KitIntegration.EventListener` Kits should implement this listener to ensure they receive events as they are sent into the mParticle SDK.
`static interface`	`KitIntegration.PushListener` Kits should implement this interface when they have Google Cloud Messaging/push features.

Constructor Summary

Constructors
Constructor and Description

KitIntegration()

Constructors
Constructor and Description
`KitIntegration()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkForDeepLink()`
`protected void`	`clearIntegrationAttributes()` Remove all integration attributes set for this integration.
`KitConfiguration`	`getConfiguration()` Get the configuration of the Kit.
`android.content.Context`	`getContext()` Get an application Context object.
`java.lang.ref.WeakReference<android.app.Activity>`	`getCurrentActivity()` Get a WeakReference to an Activity.
`java.lang.Object`	`getInstance()` Kits should override this method in order to provide implementing developers direct access to their APIs.
`protected java.util.Map<java.lang.String,java.lang.String>`	`getIntegrationAttributes()` Get integration attributes.
`protected KitManagerImpl`	`getKitManager()`
`abstract java.lang.String`	`getName()` Kits must override this an provide a human-readable name of their service.
`java.util.Map<java.lang.String,java.lang.String>`	`getSettings()` Retrieve the settings that are configured for this Kit, such as API key, etc
`protected boolean`	`isBackgrounded()` Determine if the application is currently in the background.
`boolean`	`isDisabled()`
`protected abstract java.util.List<ReportingMessage>`	`onKitCreate(java.util.Map<java.lang.String,java.lang.String> settings, android.content.Context context)` Kits must override this method and should use it for initialization.
`protected void`	`onKitDestroy()` This method will be called when an integration has been disabled.
`KitIntegration`	`setConfiguration(KitConfiguration configuration)`
`void`	`setInstallReferrer(android.content.Intent intent)` Implement this method to receive com.android.vending.INSTALL_REFERRER Intents that have been captured by the mParticle SDK.
`protected void`	`setIntegrationAttributes(java.util.Map<java.lang.String,java.lang.String> integrationAttributes)` Set integration attributes.
`KitIntegration`	`setKitManager(KitManagerImpl kitManager)`
`void`	`setLocation(android.location.Location location)` 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.
`abstract java.util.List<ReportingMessage>`	`setOptOut(boolean optedOut)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KitIntegration
```
public KitIntegration()
```
- Method Detail
  - isBackgrounded
```
protected final boolean isBackgrounded()
```
    Determine if the application is currently in the background. This is derived by the mParticle SDK based on whether there is currently an Activity visible.
    
    Returns:
    
    true if the application is background
  - getContext
```
public final android.content.Context getContext()
```
    Get an application Context object.
    
    Returns:
    
    an application Context, this will never be null.
  - getCurrentActivity
```
public final java.lang.ref.WeakReference<android.app.Activity> getCurrentActivity()
```
    Get a WeakReference to an Activity. The mParticle SDK maintains a WeakReference to the currently visible Activity. This will sometimes return null (if the app is in the background), and will sometimes return a WeakReference with no attached Activity - so be sure to code safely.
    
    Returns:
    
    a WeakReference to an Activity, or null.
  - getConfiguration
```
public KitConfiguration getConfiguration()
```
    Get the configuration of the Kit. The KitConfiguration object contains all of the settings and filters of a Kit. Generally there's no need to use this API, and you can instead just call getSettings().
    
    Returns:
  - setConfiguration
```
public final KitIntegration setConfiguration(KitConfiguration configuration)
```
  - getInstance
```
public java.lang.Object getInstance()
```
    Kits should override this method in order to provide implementing developers direct access to their APIs. Though generally we don't want developers to need direct access - it can be unavoidable if there are APIs in the underlying Kit SDK for which the mParticle SDK has no analogue or abstraction.
    
    Returns:
  - isDisabled
```
public boolean isDisabled()
```
  - getName
```
public abstract java.lang.String getName()
```
    Kits must override this an provide a human-readable name of their service. This name will show up in ADB logs.
    
    Returns:
    
    the name of your company/sdk
  - onKitCreate
```
protected abstract java.util.List<ReportingMessage> onKitCreate(java.util.Map<java.lang.String,java.lang.String> settings,
                                                                android.content.Context context)
```
    Kits must override this method and should use it for initialization. This method will only be called once. The first time that a given user installs and opens an app, this may occur anywhere from milliseconds after launch to minutes, depending on the user's data connection.
    
    Parameters:
    
    settings - the settings that have been configured in mParticle UI. Use this to extract your API key, etc
    
    context - an Application Context object
  - onKitDestroy
```
protected void onKitDestroy()
```
    This method will be called when an integration has been disabled. Ideally, any unncessesary memory should be cleaned up when this method is called. After this method is called, mParticle will no longer delegate events to the kit, and on subsquent application startups, the Kit will not be initialized at all.
  - setLocation
```
public void setLocation(android.location.Location location)
```
    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. In either case, this method will be called on a Kit whenever a new location object is received.
    
    Parameters:
    
    location -
  - getSettings
```
public final java.util.Map<java.lang.String,java.lang.String> getSettings()
```
    Retrieve the settings that are configured for this Kit, such as API key, etc
    
    Returns:
    
    a Map of settings
  - setOptOut
```
public abstract java.util.List<ReportingMessage> setOptOut(boolean optedOut)
```
    Parameters:
    
    optedOut -
    
    Returns:
  - getKitManager
```
protected final KitManagerImpl getKitManager()
```
  - setKitManager
```
public final KitIntegration setKitManager(KitManagerImpl kitManager)
```
  - checkForDeepLink
```
public void checkForDeepLink()
```
  - setIntegrationAttributes
```
protected final void setIntegrationAttributes(java.util.Map<java.lang.String,java.lang.String> integrationAttributes)
```
    Set integration attributes. Integration attributes are designed to facilitate communication between a kit and its respective server integration. They will be persisted across application exits and launches.
    
    Parameters:
    
    integrationAttributes -
  - getIntegrationAttributes
```
protected final java.util.Map<java.lang.String,java.lang.String> getIntegrationAttributes()
```
    Get integration attributes. Integration attributes are designed to facilitate communication between a kit and its respective server integration. They will be persisted across application exits and launches.
    
    Returns:
  - clearIntegrationAttributes
```
protected final void clearIntegrationAttributes()
```
    Remove all integration attributes set for this integration.
  - setInstallReferrer
```
public void setInstallReferrer(android.content.Intent intent)
```
    Implement this method to receive com.android.vending.INSTALL_REFERRER Intents that have been captured by the mParticle SDK. Developers/users of the SDK may also call setInstallReferrer at any time after an install has occurred.
    
    Parameters:
    
    intent - an intent with the INSTALL_REFERRER action

Class KitIntegration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KitIntegration

Method Detail

isBackgrounded

getContext

getCurrentActivity

getConfiguration

setConfiguration

getInstance

isDisabled

getName

onKitCreate

onKitDestroy

setLocation

getSettings

setOptOut

getKitManager

setKitManager

checkForDeepLink

setIntegrationAttributes

getIntegrationAttributes

clearIntegrationAttributes

setInstallReferrer