com.my.tracker

Class MyTrackerConfig

java.lang.Object

com.my.tracker.MyTrackerConfig

public final class MyTrackerConfig
extends java.lang.Object

Class for configuring myTracker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MyTrackerConfig.InstalledPackagesProvider Interface of provider that produces information about installed packages.
static interface	MyTrackerConfig.OkHttpClientProvider Interface of OkHTTP provider
static interface	MyTrackerConfig.Region Possible values of the region.

Method Summary

Modifier and Type	Method and Description
AntiFraudConfig	getAntiFraudConfig() Return current anti-fraud configuration.
int	getBufferingPeriod() Return buffering period.
int	getForcingPeriod() Return forcing period in seconds.
java.lang.String	getId() Return identifier that was provided in MyTracker.initTracker(String, Application).
int	getLaunchTimeout() Return launch timeout in in seconds.
java.lang.String	getVendorAppPackage() Deprecated.
boolean	isAutotrackingPurchaseEnabled() Return whether auto tracking purchases is enabled or not.
boolean	isTrackingEnvironmentEnabled() Return tracking environment state.
boolean	isTrackingLaunchEnabled() Return whether tracking application launches is enabled or not.
boolean	isTrackingLocationEnabled() Return whether collecting current location is enabled or not.
boolean	isTrackingPreinstallEnabled() Return whether tracking preinstall of current application is enabled or not.
boolean	isTrackingPreinstallThirdPartyEnabled() Return whether tracking preinstall of current application with third party sources is enabled or not.
void	setAntiFraudConfig(AntiFraudConfig antiFraudConfig) Set anti-fraud configuration.
MyTrackerConfig	setAutotrackingPurchaseEnabled(boolean autotrackingPurchaseEnabled) Enable or disable autotracking purchases.
MyTrackerConfig	setBufferingPeriod(int bufferingPeriodSec) Set the buffering period.
MyTrackerConfig	setDefaultVendorAppPackage() Deprecated.
MyTrackerConfig	setForcingPeriod(int forcingPeriodSec) Set the forcing period.
MyTrackerConfig	setInstalledPackagesProvider(MyTrackerConfig.InstalledPackagesProvider provider) Set installed packages provider.
MyTrackerConfig	setLaunchTimeout(int seconds) Set the launch timeout.
MyTrackerConfig	setOkHttpClientProvider(MyTrackerConfig.OkHttpClientProvider provider) Set installed okHttpClient provider.
MyTrackerConfig	setProxyHost(java.lang.String proxyHost) Set the host to which all requests will be sent.
MyTrackerConfig	setRegion(int region) Set the region.
MyTrackerConfig	setTrackingEnvironmentEnabled(boolean trackingEnvironmentEnabled) Enable or disable collecting environment information.
MyTrackerConfig	setTrackingLaunchEnabled(boolean trackingLaunchEnabled) Enable or disable tracking application launches.
MyTrackerConfig	setTrackingLocationEnabled(boolean trackingLocationEnabled) Enable or disable collecting information about current location.
MyTrackerConfig	setTrackingPreinstallEnabled(boolean trackingPreinstallEnabled) Enable or disable tracking preinstall.
MyTrackerConfig	setTrackingPreinstallThirdPartyEnabled(boolean trackingPreinstallThirdPartyEnabled) Enable or disable tracking preinstall with third party sources.
MyTrackerConfig	setVendorAppPackage(java.lang.String vendorAppPackage) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

getId

@AnyThread
 @NonNull
public java.lang.String getId()

Return identifier that was provided in MyTracker.initTracker(String, Application).

Returns:

Your identifier.

getBufferingPeriod

@AnyThread
public int getBufferingPeriod()

Return buffering period. During this period every tracked event is stored in local storage.

The value is in range [1 - 86400]. Default value is 900 seconds.

Returns:

Buffering period.

getAntiFraudConfig

@AnyThread
 @NonNull
public AntiFraudConfig getAntiFraudConfig()

Return current anti-fraud configuration.

Returns:

The current instance of AntiFraudConfig.

setAntiFraudConfig

@AnyThread
public void setAntiFraudConfig(@NonNull
                                          AntiFraudConfig antiFraudConfig)

Set anti-fraud configuration.

Parameters:

antiFraudConfig - Implementation of MyTrackerConfig.OkHttpClientProvider

setBufferingPeriod

@AnyThread
 @NonNull
public MyTrackerConfig setBufferingPeriod(int bufferingPeriodSec)

Set the buffering period.

NOTE: it's recommended to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

bufferingPeriodSec - Buffering period in seconds. The value should be in range [1 - 86400]. Otherwise it will be rejected.

Returns:

The current instance of MyTrackerConfig.

getForcingPeriod

@AnyThread
public int getForcingPeriod()

Return forcing period in seconds. During this period every tracked event leads to flushing tracker. The start of the period is install or update of application.

The value is in range [0 - 432000]. Default value is 0. It means, that forcing period is disabled by default.

Returns:

Forcing period.

setForcingPeriod

@AnyThread
 @NonNull
public MyTrackerConfig setForcingPeriod(int forcingPeriodSec)

Set the forcing period.

NOTE: it's recommended to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

forcingPeriodSec - Forcing period in seconds. The value should be in range [0 - 432000]. Otherwise it will be rejected.

Returns:

The current instance of MyTrackerConfig.

getLaunchTimeout

@AnyThread
public int getLaunchTimeout()

Return launch timeout in in seconds. During this period start of the application after it close wont't be considered as new launch.

The value is in range [30 - 7200]. Default value is 30.

Returns:

Launch timeout.

setLaunchTimeout

@AnyThread
 @NonNull
public MyTrackerConfig setLaunchTimeout(int seconds)

Set the launch timeout.

NOTE: it's recommended to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

seconds - Launch timeout in seconds.

Returns:

The current instance of MyTrackerConfig.

setProxyHost

@AnyThread
 @NonNull
public MyTrackerConfig setProxyHost(@Nullable
                                                         java.lang.String proxyHost)

Set the host to which all requests will be sent.

The value provided in parameter will be additionally processed: - HTTPS scheme could be added if necessary - Query and Fragment parts will be deleted - the protocol version will be added

To reset proxy host to default call the method with null parameter.

NOTE: it's mandatory to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

proxyHost - Proxy host.

Returns:

The current instance of MyTrackerConfig.

setRegion

@AnyThread
 @NonNull
public MyTrackerConfig setRegion(int region)

Set the region. The value switch the proxy host to predefined values or reset it to default value.

Possible values are defined in MyTrackerConfig.Region

NOTE: it's mandatory to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

region - The region.

Returns:

The current instance of MyTrackerConfig.

getVendorAppPackage

@AnyThread
 @Deprecated
 @Nullable
public java.lang.String getVendorAppPackage()

Deprecated.

setDefaultVendorAppPackage

@AnyThread
 @Deprecated
 @NonNull
public MyTrackerConfig setDefaultVendorAppPackage()

Deprecated.

setVendorAppPackage

@AnyThread
 @Deprecated
 @NonNull
public MyTrackerConfig setVendorAppPackage(@Nullable
                                                                             java.lang.String vendorAppPackage)

Deprecated.

setInstalledPackagesProvider

@AnyThread
 @NonNull
public MyTrackerConfig setInstalledPackagesProvider(@Nullable
                                                                         MyTrackerConfig.InstalledPackagesProvider provider)

Set installed packages provider.

Parameters:

provider - Implementation of MyTrackerConfig.InstalledPackagesProvider

Returns:

The current instance of MyTrackerConfig.

isTrackingEnvironmentEnabled

@AnyThread
public boolean isTrackingEnvironmentEnabled()

Return tracking environment state. Enabled state means that information about Wi-Fi and mobile networks will be collected.

NOTE: this information are collected while sending request to the server. The impact to the battery is minimal.

Returns:

Tracking environment state.

setTrackingEnvironmentEnabled

@AnyThread
 @NonNull
public MyTrackerConfig setTrackingEnvironmentEnabled(boolean trackingEnvironmentEnabled)

Enable or disable collecting environment information.

NOTE: it's recommended to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

trackingEnvironmentEnabled - The enable or disable state.

Returns:

The current instance of MyTrackerConfig.

isTrackingLaunchEnabled

@AnyThread
public boolean isTrackingLaunchEnabled()

Return whether tracking application launches is enabled or not.

Returns:

The state of tracking launches feature.

setTrackingLaunchEnabled

@AnyThread
 @NonNull
public MyTrackerConfig setTrackingLaunchEnabled(boolean trackingLaunchEnabled)

Enable or disable tracking application launches.

NOTE: it's mandatory to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

trackingLaunchEnabled - The enable or disable state.

Returns:

The current instance of MyTrackerConfig.

isTrackingLocationEnabled

@AnyThread
public boolean isTrackingLocationEnabled()

Return whether collecting current location is enabled or not.

NOTE: this information are collected while sending request to the server. The impact to the battery is minimal.

Returns:

The state of tracking location feature.

setTrackingLocationEnabled

@AnyThread
 @NonNull
public MyTrackerConfig setTrackingLocationEnabled(boolean trackingLocationEnabled)

Enable or disable collecting information about current location.

NOTE: it's recommended to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

trackingLocationEnabled - The enable or disable state.

Returns:

The current instance of MyTrackerConfig.

isAutotrackingPurchaseEnabled

@AnyThread
public boolean isAutotrackingPurchaseEnabled()

Return whether auto tracking purchases is enabled or not.

If it's enabled: - The methods MyTracker.onActivityResult(int, Intent) and MyTracker.onPurchasesUpdated(int, List) are available for tracking. - The methods MyTracker.trackPurchaseEvent(JSONObject, JSONObject, String) and MyTracker.trackPurchaseEvent(JSONObject, JSONObject, String, Map) are disabled.

If it's disabled: - The methods MyTracker.onActivityResult(int, Intent) and MyTracker.onPurchasesUpdated(int, List) are unavailable. for tracking. - The methods MyTracker.trackPurchaseEvent(JSONObject, JSONObject, String) and MyTracker.trackPurchaseEvent(JSONObject, JSONObject, String, Map) are enabled for tracking.

Returns:

The state of autotracking feature.

setAutotrackingPurchaseEnabled

@AnyThread
 @NonNull
public MyTrackerConfig setAutotrackingPurchaseEnabled(boolean autotrackingPurchaseEnabled)

Enable or disable autotracking purchases.

NOTE: it's recommended to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

autotrackingPurchaseEnabled - The enable or disable state.

Returns:

The current instance of MyTrackerConfig.

isTrackingPreinstallEnabled

@AnyThread
public boolean isTrackingPreinstallEnabled()

Return whether tracking preinstall of current application is enabled or not.

Returns:

The state of tracking preinstall feature.

setTrackingPreinstallEnabled

@AnyThread
 @NonNull
public MyTrackerConfig setTrackingPreinstallEnabled(boolean trackingPreinstallEnabled)

Enable or disable tracking preinstall.

NOTE: it's mandatory to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

trackingPreinstallEnabled - The enable or disable state.

Returns:

The current instance of MyTrackerConfig.

isTrackingPreinstallThirdPartyEnabled

@AnyThread
public boolean isTrackingPreinstallThirdPartyEnabled()

Return whether tracking preinstall of current application with third party sources is enabled or not.

Returns:

The state of tracking preinstall feature.

setTrackingPreinstallThirdPartyEnabled

@AnyThread
 @NonNull
public MyTrackerConfig setTrackingPreinstallThirdPartyEnabled(boolean trackingPreinstallThirdPartyEnabled)

Enable or disable tracking preinstall with third party sources.

NOTE: it's mandatory to call this method before MyTracker.initTracker(String, Application) call.

Parameters:

trackingPreinstallThirdPartyEnabled - The enable or disable state.

Returns:

The current instance of MyTrackerConfig.

setOkHttpClientProvider

@AnyThread
 @NonNull
public MyTrackerConfig setOkHttpClientProvider(@Nullable
                                                                    MyTrackerConfig.OkHttpClientProvider provider)

Set installed okHttpClient provider.

Parameters:

provider - Implementation of MyTrackerConfig.OkHttpClientProvider

Returns:

The current instance of MyTrackerConfig.