Package com.mparticle

Class MParticleOptions

java.lang.Object

com.mparticle.MParticleOptions

public class MParticleOptions
extends java.lang.Object

class used for passing optional settings to the SDK when it is started.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MParticleOptions.Builder
static class	MParticleOptions.DataplanOptions

Constructor Summary

Constructors

Constructor	Description
MParticleOptions(MParticleOptions.Builder builder)

Method Summary

Modifier and Type	Method	Description
static MParticleOptions.Builder	builder(android.content.Context context)
java.lang.String	getApiKey()	Query the API Key.
java.lang.String	getApiSecret()	Query the API Secret.
AttributionListener	getAttributionListener()
java.lang.Integer	getConfigMaxAge()
<T extends Configuration> T	getConfiguration(java.lang.Class<T> clazz)
java.util.List<Configuration>	getConfigurations()
<T> java.util.List<Configuration<T>>	getConfigurationsForTarget(java.lang.Class<T> clazz)
int	getConnectionTimeout()
android.content.Context	getContext()
java.lang.String	getDataplanId()
MParticleOptions.DataplanOptions	getDataplanOptions()
java.lang.Integer	getDataplanVersion()
MParticle.Environment	getEnvironment()	Query the Environment.
IdentityApiRequest	getIdentifyRequest()	Query the Identify Request.
BaseIdentityTask	getIdentityTask()
MParticle.InstallType	getInstallType()	Query the InstallType.
com.mparticle.MParticleOptions.LocationTracking	getLocationTracking()
MParticle.LogLevel	getLogLevel()
NetworkOptions	getNetworkOptions()
MParticle.OperatingSystem	getOperatingSystem()
com.mparticle.internal.PushRegistrationHelper.PushRegistration	getPushRegistration()
java.lang.Integer	getSessionTimeout()
java.lang.Integer	getUploadInterval()	Query the uploadInterval.
boolean	hasLocationTracking()
java.lang.Boolean	isAndroidIdDisabled()	Deprecated. This method has been replaced as the behavior has been inverted - Android ID collection is now disabled by default.
java.lang.Boolean	isAndroidIdEnabled()	Query whether Android Id collection is enabled or disabled.
java.lang.Boolean	isDevicePerformanceMetricsDisabled()	Query whether device performance metrics are enabled or disabled.
java.lang.Boolean	isUncaughtExceptionLoggingEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MParticleOptions

public MParticleOptions(@NonNull
                        MParticleOptions.Builder builder)

Method Detail

builder

@NonNull
public static MParticleOptions.Builder builder(@NonNull
                                               android.content.Context context)

Parameters:

context -

Returns:

getContext

@NonNull
public android.content.Context getContext()

getInstallType

@NonNull
public MParticle.InstallType getInstallType()

Query the InstallType.

getEnvironment

@NonNull
public MParticle.Environment getEnvironment()

Query the Environment.

Returns:

getApiKey

@NonNull
public java.lang.String getApiKey()

Query the API Key.

Returns:

getApiSecret

@NonNull
public java.lang.String getApiSecret()

Query the API Secret.

Returns:

getIdentifyRequest

@Nullable
public IdentityApiRequest getIdentifyRequest()

Query the Identify Request.

Returns:

isDevicePerformanceMetricsDisabled

@NonNull
public java.lang.Boolean isDevicePerformanceMetricsDisabled()

Query whether device performance metrics are enabled or disabled.

Returns:

true if the are disabled, false if they are enabled

isAndroidIdDisabled

@NonNull
@Deprecated
public java.lang.Boolean isAndroidIdDisabled()

Deprecated.

This method has been replaced as the behavior has been inverted - Android ID collection is now disabled by default.

Use isAndroidIdEnabled(boolean) instead. Query whether Android Id collection is enabled or disabled.

Returns:

true if collection is disabled, false if it is enabled

isAndroidIdEnabled

@NonNull
public java.lang.Boolean isAndroidIdEnabled()

Query whether Android Id collection is enabled or disabled.

Returns:

true if collection is enabled, false if it is disabled

getUploadInterval

@NonNull
public java.lang.Integer getUploadInterval()

Query the uploadInterval.

Returns:

the upload interval, in seconds

getSessionTimeout

@NonNull
public java.lang.Integer getSessionTimeout()

getConfigMaxAge

@NonNull
public java.lang.Integer getConfigMaxAge()

isUncaughtExceptionLoggingEnabled

@NonNull
public java.lang.Boolean isUncaughtExceptionLoggingEnabled()

getLogLevel

@NonNull
public MParticle.LogLevel getLogLevel()

getIdentityTask

@Nullable
public BaseIdentityTask getIdentityTask()

getAttributionListener

@Nullable
public AttributionListener getAttributionListener()

hasLocationTracking

public boolean hasLocationTracking()

getLocationTracking

@Nullable
public com.mparticle.MParticleOptions.LocationTracking getLocationTracking()

getPushRegistration

@Nullable
public com.mparticle.internal.PushRegistrationHelper.PushRegistration getPushRegistration()

getConnectionTimeout

public int getConnectionTimeout()

getNetworkOptions

@NonNull
public NetworkOptions getNetworkOptions()

getDataplanId

@Nullable
public java.lang.String getDataplanId()

getDataplanVersion

@Nullable
public java.lang.Integer getDataplanVersion()

getOperatingSystem

@NonNull
public MParticle.OperatingSystem getOperatingSystem()

getDataplanOptions

@Nullable
public MParticleOptions.DataplanOptions getDataplanOptions()

getConfigurations

@NonNull
public java.util.List<Configuration> getConfigurations()

getConfiguration

@Nullable
public <T extends Configuration> T getConfiguration(java.lang.Class<T> clazz)

getConfigurationsForTarget

@NonNull
public <T> java.util.List<Configuration<T>> getConfigurationsForTarget(java.lang.Class<T> clazz)