MPConfig (mixpanel-android 5.9.1 API)

java.lang.Object
- com.mixpanel.android.mpmetrics.MPConfig

```
public class MPConfig
extends java.lang.Object
```
Stores global configuration options for the Mixpanel library. You can enable and disable configuration options using <meta-data> tags inside of the <application> tag in your AndroidManifest.xml. All settings are optional, and default to reasonable recommended values. Most users will not have to set any options. Mixpanel understands the following options:

com.mixpanel.android.MPConfig.EnableDebugLogging

A boolean value. If true, emit more detailed log messages. Defaults to false

com.mixpanel.android.MPConfig.BulkUploadLimit

An integer count of messages, the maximum number of messages to queue before an upload attempt. This value should be less than 50.

com.mixpanel.android.MPConfig.FlushInterval

An integer number of milliseconds, the maximum time to wait before an upload if the bulk upload limit isn't reached.

com.mixpanel.android.MPConfig.FlushOnBackground

A boolean value. If false, the library will not flush the event and people queues when the app goes into the background. Defaults to true.

com.mixpanel.android.MPConfig.DebugFlushInterval

An integer number of milliseconds, the maximum time to wait before an upload if the bulk upload limit isn't reached in debug mode.

com.mixpanel.android.MPConfig.DataExpiration

An integer number of milliseconds, the maximum age of records to send to Mixpanel. Corresponds to Mixpanel's server-side limit on record age.

com.mixpanel.android.MPConfig.MinimumDatabaseLimit

An integer number of bytes. Mixpanel attempts to limit the size of its persistent data queue based on the storage capacity of the device, but will always allow queing below this limit. Higher values will take up more storage even when user storage is very full.

com.mixpanel.android.MPConfig.ResourcePackageName

A string java package name. Defaults to the package name of the Application. Users should set if the package name of their R class is different from the application package name due to application id settings.

com.mixpanel.android.MPConfig.DisableGestureBindingUI

A boolean value. If true, do not allow connecting to the codeless event binding or A/B testing editor using an accelerometer gesture. Defaults to false.

com.mixpanel.android.MPConfig.DisableEmulatorBindingUI

A boolean value. If true, do not attempt to connect to the codeless event binding or A/B testing editor when running in the Android emulator. Defaults to false.

com.mixpanel.android.MPConfig.DisableAppOpenEvent

A boolean value. If true, do not send an "$app_open" event when the MixpanelAPI object is created for the first time. Defaults to true - the $app_open event will not be sent by default.

com.mixpanel.android.MPConfig.DisableExceptionHandler

A boolean value. If true, do not automatically capture app crashes. "App Crashed" events won't show up on Mixpanel. Defaults to false.

com.mixpanel.android.MPConfig.AutoShowMixpanelUpdates

A boolean value. If true, automatically show notifications and A/B test variants. Defaults to true.

com.mixpanel.android.MPConfig.EventsEndpoint

A string URL. If present, the library will attempt to send events to this endpoint rather than to the default Mixpanel endpoint.

com.mixpanel.android.MPConfig.PeopleEndpoint

A string URL. If present, the library will attempt to send people updates to this endpoint rather than to the default Mixpanel endpoint.

com.mixpanel.android.MPConfig.GroupsEndpoint

A string URL. If present, the library will attempt to send group updates to this endpoint rather than to the default Mixpanel endpoint.

com.mixpanel.android.MPConfig.DecideEndpoint

A string URL. If present, the library will attempt to get notification, codeless event tracking, and A/B test variant information from this url rather than the default Mixpanel endpoint.

com.mixpanel.android.MPConfig.EditorUrl

A string URL. If present, the library will attempt to connect to this endpoint when in interactive editing mode, rather than to the default Mixpanel editor url.

com.mixpanel.android.MPConfig.IgnoreInvisibleViewsVisualEditor

A boolean value. If true, invisible views won't be shown on Mixpanel Visual Editor (AB Test and codeless events) . Defaults to false.

com.mixpanel.android.MPConfig.DisableViewCrawler

A boolean value. If true, AB tests, tweaks and codeless events will be disabled. Defaults to false.

com.mixpanel.android.MPConfig.DisableDecideChecker

A boolean value. If true, the library will not query our decide endpoint and won't retrieve in-app notifications, codeless events, Ab Tests or tweaks. Defaults to false.

com.mixpanel.android.MPConfig.NotificationDefaults

An integer number. This value is used to create a notification before API 26 (https://developer.android.com/reference/android/app/Notification.Builder.html#setDefaults(int)). Defaults to 0.

com.mixpanel.android.MPConfig.MinimumSessionDuration

An integer number. The minimum session duration (ms) that is tracked in automatic events. Defaults to 10000 (10 seconds).

com.mixpanel.android.MPConfig.SessionTimeoutDuration

An integer number. The maximum session duration (ms) that is tracked in automatic events. Defaults to Integer.MAX_VALUE (no maximum session duration).

com.mixpanel.android.MPConfig.TestMode

A boolean value. If true, in-app notifications won't be marked as seen. Defaults to false.

com.mixpanel.android.MPConfig.ImageCacheMaxMemoryFactor

An integer value. The LRU cache size that Mixpanel uses to store images is calculated by the available memory divided by this factor. Defaults to 10.

com.mixpanel.android.MPConfig.DisableViewCrawlerForProjects

A resource array list (e.g. @array/my_project_list). AB tests, tweaks and codeless events will be disabled for the projects from that list. Defaults to null.

com.mixpanel.android.MPConfig.UseIpAddressForGeolocation

A boolean value. If true, Mixpanel will automatically determine city, region and country data using the IP address of the client.Defaults to true.

com.mixpanel.android.MPConfig.NotificationChannelId

An string value. If present, the library will use this id when creating a notification channel. Applicable only for Android 26 and above.

com.mixpanel.android.MPConfig.NotificationChannelName

An string value. If present, the library will use this user-visible name for our notification channel. Applicable only for Android 26 and above. Defaults to the application name.

com.mixpanel.android.MPConfig.NotificationChannelImportance

An integer number. Importance of the notification channel (see https://developer.android.com/reference/android/app/NotificationManager.html). Defaults to 3 (IMPORTANCE_DEFAULT). Applicable only for Android 26 and above.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEBUG`
`static int`	`UI_FEATURES_MIN_API` Minimum API level for support of rich UI features, like In-App notifications and dynamic event binding.
`static java.lang.String`	`VERSION`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAutoShowMixpanelUpdates()`
`int`	`getBulkUploadLimit()`
`long`	`getDataExpiration()`
`java.lang.String`	`getDecideEndpoint()`
`boolean`	`getDisableAppOpenEvent()`
`boolean`	`getDisableDecideChecker()`
`boolean`	`getDisableEmulatorBindingUI()`
`boolean`	`getDisableExceptionHandler()`
`boolean`	`getDisableGestureBindingUI()`
`boolean`	`getDisableViewCrawler()`
`java.lang.String[]`	`getDisableViewCrawlerForProjects()`
`java.lang.String`	`getEditorUrl()`
`java.lang.String`	`getEventsEndpoint()`
`int`	`getFlushInterval()`
`boolean`	`getFlushOnBackground()`
`java.lang.String`	`getGroupsEndpoint()`
`boolean`	`getIgnoreInvisibleViewsEditor()`
`int`	`getImageCacheMaxMemoryFactor()`
`static MPConfig`	`getInstance(android.content.Context context)`
`int`	`getMinimumDatabaseLimit()`
`int`	`getMinimumSessionDuration()`
`java.lang.String`	`getNotificationChannelId()`
`int`	`getNotificationChannelImportance()`
`java.lang.String`	`getNotificationChannelName()`
`int`	`getNotificationDefaults()`
`OfflineMode`	`getOfflineMode()`
`java.lang.String`	`getPeopleEndpoint()`
`java.lang.String`	`getResourcePackageName()`
`int`	`getSessionTimeoutDuration()`
`javax.net.ssl.SSLSocketFactory`	`getSSLSocketFactory()`
`boolean`	`getTestMode()`
`void`	`setEnableLogging(boolean enableLogging)`
`void`	`setOfflineMode(OfflineMode offlineMode)` `OfflineMode` allows Mixpanel to be in-sync with client offline internal logic.
`void`	`setServerURL(java.lang.String serverURL)`
`void`	`setSSLSocketFactory(javax.net.ssl.SSLSocketFactory factory)` The MixpanelAPI will use the system default SSL socket settings under ordinary circumstances.
`void`	`setUseIpAddressForGeolocation(boolean useIpAddressForGeolocation)`
`java.lang.String`	`toString()`

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

- Field Detail
  - VERSION
```
public static final java.lang.String VERSION
```
    See Also:
    
    Constant Field Values
  - DEBUG
```
public static boolean DEBUG
```
  - UI_FEATURES_MIN_API
```
public static final int UI_FEATURES_MIN_API
```
    Minimum API level for support of rich UI features, like In-App notifications and dynamic event binding. Devices running OS versions below this level will still support tracking and push notification features.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static MPConfig getInstance(android.content.Context context)
```
  - setSSLSocketFactory
```
public void setSSLSocketFactory(javax.net.ssl.SSLSocketFactory factory)
```
    The MixpanelAPI will use the system default SSL socket settings under ordinary circumstances. That means it will ignore settings you associated with the default SSLSocketFactory in the schema registry or in underlying HTTP libraries. If you'd prefer for Mixpanel to use your own SSL settings, you'll need to call setSSLSocketFactory early in your code, like this <pre> MPConfig.getInstance(context).setSSLSocketFactory(someCustomizedSocketFactory); </pre> Your settings will be globally available to all Mixpanel instances, and will be used for all SSL connections in the library. The call is thread safe, but should be done before your first call to MixpanelAPI.getInstance to insure that the library never uses it's default. The given socket factory may be used from multiple threads, which is safe for the system SSLSocketFactory class, but if you pass a subclass you should ensure that it is thread-safe before passing it to Mixpanel.
    
    Parameters:
    
    factory - an SSLSocketFactory that
  - setOfflineMode
```
public void setOfflineMode(OfflineMode offlineMode)
```
    OfflineMode allows Mixpanel to be in-sync with client offline internal logic. If you want to integrate your own logic with Mixpanel you'll need to call setOfflineMode(OfflineMode) early in your code, like this <pre> MPConfig.getInstance(context).setOfflineMode(OfflineModeImplementation); </pre> Your settings will be globally available to all Mixpanel instances, and will be used across all the library. The call is thread safe, but should be done before your first call to MixpanelAPI.getInstance to insure that the library never uses it's default. The given OfflineMode may be used from multiple threads, you should ensure that your implementation is thread-safe before passing it to Mixpanel.
    
    Parameters:
    
    offlineMode - client offline implementation to use on Mixpanel
  - getBulkUploadLimit
```
public int getBulkUploadLimit()
```
  - getFlushInterval
```
public int getFlushInterval()
```
  - getFlushOnBackground
```
public boolean getFlushOnBackground()
```
  - getDataExpiration
```
public long getDataExpiration()
```
  - getMinimumDatabaseLimit
```
public int getMinimumDatabaseLimit()
```
  - getDisableGestureBindingUI
```
public boolean getDisableGestureBindingUI()
```
  - getDisableEmulatorBindingUI
```
public boolean getDisableEmulatorBindingUI()
```
  - getDisableAppOpenEvent
```
public boolean getDisableAppOpenEvent()
```
  - getDisableViewCrawler
```
public boolean getDisableViewCrawler()
```
  - getDisableViewCrawlerForProjects
```
public java.lang.String[] getDisableViewCrawlerForProjects()
```
  - getTestMode
```
public boolean getTestMode()
```
  - getEventsEndpoint
```
public java.lang.String getEventsEndpoint()
```
  - setServerURL
```
public void setServerURL(java.lang.String serverURL)
```
  - getPeopleEndpoint
```
public java.lang.String getPeopleEndpoint()
```
  - getGroupsEndpoint
```
public java.lang.String getGroupsEndpoint()
```
  - getDecideEndpoint
```
public java.lang.String getDecideEndpoint()
```
  - getAutoShowMixpanelUpdates
```
public boolean getAutoShowMixpanelUpdates()
```
  - getEditorUrl
```
public java.lang.String getEditorUrl()
```
  - getDisableDecideChecker
```
public boolean getDisableDecideChecker()
```
  - getIgnoreInvisibleViewsEditor
```
public boolean getIgnoreInvisibleViewsEditor()
```
  - getNotificationDefaults
```
public int getNotificationDefaults()
```
  - getMinimumSessionDuration
```
public int getMinimumSessionDuration()
```
  - getSessionTimeoutDuration
```
public int getSessionTimeoutDuration()
```
  - getDisableExceptionHandler
```
public boolean getDisableExceptionHandler()
```
  - getNotificationChannelId
```
public java.lang.String getNotificationChannelId()
```
  - getNotificationChannelName
```
public java.lang.String getNotificationChannelName()
```
  - getNotificationChannelImportance
```
public int getNotificationChannelImportance()
```
  - setUseIpAddressForGeolocation
```
public void setUseIpAddressForGeolocation(boolean useIpAddressForGeolocation)
```
  - setEnableLogging
```
public void setEnableLogging(boolean enableLogging)
```
  - getResourcePackageName
```
public java.lang.String getResourcePackageName()
```
  - getSSLSocketFactory
```
public javax.net.ssl.SSLSocketFactory getSSLSocketFactory()
```
  - getOfflineMode
```
public OfflineMode getOfflineMode()
```
  - getImageCacheMaxMemoryFactor
```
public int getImageCacheMaxMemoryFactor()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MPConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

DEBUG

UI_FEATURES_MIN_API

Method Detail

getInstance

setSSLSocketFactory

setOfflineMode

getBulkUploadLimit

getFlushInterval

getFlushOnBackground

getDataExpiration

getMinimumDatabaseLimit

getDisableGestureBindingUI

getDisableEmulatorBindingUI

getDisableAppOpenEvent

getDisableViewCrawler

getDisableViewCrawlerForProjects

getTestMode

getEventsEndpoint

setServerURL

getPeopleEndpoint

getGroupsEndpoint

getDecideEndpoint

getAutoShowMixpanelUpdates

getEditorUrl

getDisableDecideChecker

getIgnoreInvisibleViewsEditor

getNotificationDefaults

getMinimumSessionDuration

getSessionTimeoutDuration

getDisableExceptionHandler

getNotificationChannelId

getNotificationChannelName

getNotificationChannelImportance

setUseIpAddressForGeolocation

setEnableLogging

getResourcePackageName

getSSLSocketFactory

getOfflineMode

getImageCacheMaxMemoryFactor

toString