Tune (Tune Android SDK 4.12.0)

java.lang.Object
- com.tune.Tune

```
public class Tune
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`collectLocation`
`protected TuneEventQueue`	`eventQueue`
`protected boolean`	`initialized`
`protected boolean`	`isFirstInstall`
`protected boolean`	`isRegistered`
`protected TuneLocationListener`	`locationListener`
`protected android.content.Context`	`mContext`
`protected android.content.BroadcastReceiver`	`networkStateReceiver`
`protected TuneParameters`	`params`
`protected ExecutorService`	`pubQueue`
`protected long`	`timeLastMeasuredSession`
`protected TuneTestRequest`	`tuneRequest`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Tune()

Constructors
Modifier	Constructor and Description
`protected`	`Tune()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addEventToQueue(String link, String data, org.json.JSONObject postBody, boolean firstSession)`
`void`	`checkForDeferredDeeplink(TuneDeeplinkListener listener)` Deprecated. Instead, register your `TuneDeeplinkListener` via `registerDeeplinkListener(TuneDeeplinkListener)`. As of Tune Android SDK v4.8.0 this method delegates to `registerDeeplinkListener(TuneDeeplinkListener)` so that there is only ever one listener at a time. This method is planned for removal in Tune Android SDK v5.0.0.
`void`	`clearAllCustomProfileVariables()` Clear out all previously specified profile information. Use this method to clear out all custom profile variables.
`void`	`clearCustomProfileVariable(String variableName)` Unset the value for a user profile variable. Use this method to clear out the value for any custom user profile variable.
`void`	`configureSmartwhere(TuneSmartwhereConfiguration config)` Configure Smartwhere using a configuration.
`boolean`	`didSessionStartFromTunePush()` Returns if the current session is because the user opened a push notification.
`boolean`	`didUserManuallyDisablePush()` Returns if the user manually disabled push on the Application Setting page.
`void`	`disableSmartwhere()` Disable Smartwhere Integration.
`protected void`	`dumpQueue()`
`void`	`enableSmartwhere()` Opt-In Smartwhere Integration with the Tune Marketing Console.
`void`	`executeDeepAction(android.app.Activity activity, String actionId, Map<String,String> data)` Executes a previously registered Deep Action code-block.
`String`	`getAction()` Gets the action of the event
`String`	`getAdvertiserId()` Gets the TUNE advertiser ID.
`int`	`getAge()` Gets the user age.
`double`	`getAltitude()` Gets the device altitude.
`String`	`getAndroidId()` Gets the ANDROID_ID of the device that was set with `setAndroidId(String)`
`boolean`	`getAppAdTrackingEnabled()` Get whether the user has app-level ad tracking enabled or not.
`String`	`getAppId()` Returns In-App Marketing's generated app ID value
`String`	`getAppName()` Gets the app name
`int`	`getAppVersion()` Gets the app version
`String`	`getConnectionType()` Gets the connection type (mobile or WIFI);.
`String`	`getCountryCode()` Gets the ISO 639-1 country code
`String`	`getCurrencyCode()` Gets the ISO 4217 currency code.
`Date`	`getCustomProfileDate(String variableName)` Get the value associated with a custom date profile variable.
`TuneLocation`	`getCustomProfileGeolocation(String variableName)` Get the value associated with a custom location profile variable.
`Number`	`getCustomProfileNumber(String variableName)` Get the value associated with a custom number profile variable.
`String`	`getCustomProfileString(String variableName)` Get the value associated with a custom string profile variable.
`String`	`getDeviceBrand()` Gets the device brand/manufacturer (HTC, Apple, etc)
`String`	`getDeviceBuild()` Gets the device build
`String`	`getDeviceCarrier()` Gets the device carrier if any
`String`	`getDeviceId()` Gets the Device ID, also known as IMEI/MEID, if any
`String`	`getDeviceModel()` Gets the device model name
`String`	`getDeviceToken()` Returns the currently registered device token for push.
`boolean`	`getExistingUser()` Gets value previously set of existing user or not.
`String`	`getFacebookUserId()` Gets the Facebook user ID previously set.
`boolean`	`getFireAdTrackingLimited()` Gets whether use of the Fire Advertising ID is limited by user request.
`String`	`getFireAdvertisingId()` Gets the Fire Advertising ID.
`TuneGender`	`getGender()` Gets the user gender set with `setGender(TuneGender)`.
`boolean`	`getGoogleAdTrackingLimited()` Gets whether use of the Google Play Services Advertising ID is limited by user request.
`String`	`getGoogleAdvertisingId()` Gets the Google Play Services Advertising ID.
`String`	`getGoogleUserId()` Gets the Google user ID previously set.
`Map<String,TuneInAppMessageExperimentDetails>`	`getInAppMessageExperimentDetails()` Get details for all currently running In App Message experiments.
`Map<String,TuneInAppMessage>`	`getInAppMessagesByIds()` Get all in-app messages that can be shown for this device, sorted by message variation id.
`Map<String,List<TuneInAppMessage>>`	`getInAppMessagesByTriggerEvents()` Get all in-app messages that can be shown for this device, sorted by trigger event.
`List<TuneInAppMessage>`	`getInAppMessagesForCustomEvent(String eventName)` Get in-app messages for this device that are triggered by custom event.
`List<TuneInAppMessage>`	`getInAppMessagesForPushEnabled(boolean pushEnabled)` Get in-app messages for this device that are triggered by a Push Enabled/Disabled event.
`List<TuneInAppMessage>`	`getInAppMessagesForPushOpened(String pushId)` Get in-app messages for this device that are triggered by a push opened event for a specific TUNE push message.
`List<TuneInAppMessage>`	`getInAppMessagesForScreenViewed(String activityName)` Get in-app messages for this device that are triggered by a Screen Viewed event.
`List<TuneInAppMessage>`	`getInAppMessagesForStartsApp()` Get in-app messages for this device that are triggered by a "Starts App" event.
`long`	`getInstallDate()` Gets the date of app install
`String`	`getInstallReferrer()` Gets the Google Play INSTALL_REFERRER
`static Tune`	`getInstance()` Get existing TUNE singleton object
`boolean`	`getIsPayingUser()` Gets whether the user is revenue-generating or not
`String`	`getLanguage()` Gets the language of the device
`String`	`getLastOpenLogId()` Gets the last TUNE open log ID
`double`	`getLatitude()` Gets the device latitude.
`String`	`getLocale()` Gets the device locale.
`double`	`getLongitude()` Gets the device longitude.
`String`	`getMacAddress()` Gets the MAC address of device
`String`	`getMatId()` Gets the MAT ID generated on install
`String`	`getMCC()` Gets the mobile country code.
`String`	`getMNC()` Gets the mobile network code.
`String`	`getOpenLogId()` Gets the first TUNE open log ID
`String`	`getOsVersion()` Gets the Android OS version
`String`	`getPackageName()` Gets the app package name
`String`	`getPluginName()` Get SDK plugin name used
`Map<String,TunePowerHookExperimentDetails>`	`getPowerHookExperimentDetails()` Get details for all currently running Power Hook Variable experiments.
`String`	`getReferralSource()` Gets the package name of the app that started this Activity, if any
`String`	`getReferralUrl()` Gets the url scheme that started this Activity, if any
`String`	`getScreenDensity()` Gets the screen density of the device
`String`	`getScreenHeight()` Gets the screen height of the device in pixels
`String`	`getScreenWidth()` Gets the screen width of the device in pixels
`static String`	`getSDKVersion()` Gets the TUNE Android SDK version
`long`	`getTimeLastMeasuredSession()` Get the time the Tune SDK last measured a new session.
`String`	`getTRUSTeId()` Gets the TRUSTe ID set
`TuneParameters`	`getTuneParams()`
`TunePushInfo`	`getTunePushInfoForSession()` Returns a POJO containing information about the push message that started the current session.
`String`	`getTwitterUserId()` Gets the Twitter user ID previously set.
`String`	`getUserAgent()` Gets the device browser user agent
`String`	`getUserEmail()` Gets the custom user email.
`String`	`getUserId()` Gets the custom user ID.
`String`	`getUserName()` Gets the custom user name.
`String`	`getValueForHookById(String hookId)` Gets the value of a Power Hook.
`static Tune`	`init(android.content.Context context, String advertiserId, String conversionKey)` Initializes the TUNE SDK with TMA off by default.
`static Tune`	`init(android.content.Context context, String advertiserId, String conversionKey, boolean turnOnIAM)` Initializes the TUNE SDK.
`static Tune`	`init(android.content.Context context, String advertiserId, String conversionKey, boolean turnOnIAM, TuneConfiguration configuration)` Initializes the TUNE SDK.
`protected void`	`initAll(String advertiserId, String conversionKey)` Private initialization function for TUNE SDK.
`protected TuneOptional<String>`	`invokeUrlFromReferralUrl(String referralUrl)`
`boolean`	`isInDebugMode()` Checks the current status of debug mode.
`static boolean`	`isOnline(android.content.Context context)` Returns true if an Internet connection is detected.
`boolean`	`isTuneLink(String appLinkUrl)` Test if your custom Tune Link domain is registered with Tune.
`boolean`	`isUserInAnySegmentIds(List<String> segmentIds)` Returns whether the user belongs to any of the given segments.
`boolean`	`isUserInSegmentId(String segmentId)` Returns whether the user belongs to the given segment.
`protected boolean`	`makeRequest(String link, String data, org.json.JSONObject postBody)` Helper function for making single request and displaying response
`void`	`measureEvent(int eventId)` Deprecated. TUNE does not support measuring events using event IDs. Please use `measureEvent(String)` or `measureEvent(TuneEvent)` methods. This method will be removed in Tune Android SDK v5.0.0
`void`	`measureEvent(String eventName)` Event measurement function that measures an event for the given eventName.
`void`	`measureEvent(TuneEvent eventData)` Event measurement function that measures an event based on TuneEvent values.
`void`	`measureSession()` Deprecated. As of Tune Android SDK v4.8.0 you do not need to explicitly call this method for native Tune Android SDK integrations. The session will be measured as part of the call to TuneActivity's onResume, which may be called automatically with the activity lifecycle callbacks registered via your Application class as part of the normal Tune SDK integration. Tune Android SDK plugins should call `measureSessionInternal()` instead. This method will be removed in Tune Android SDK v5.0.0
`void`	`measureSessionInternal()` Measure new session.
`void`	`onFirstPlaylistDownloaded(TuneCallback callback)` Register callback when the first playlist is downloaded for App's lifetime.
`void`	`onFirstPlaylistDownloaded(TuneCallback callback, long timeout)` Register callback when the first playlist is downloaded for the App's lifetime.
`void`	`onPowerHooksChanged(TuneCallback callback)` Register a callback when any Power Hooks have changed due to a new value from the Server.
`void`	`preloadMessages(android.app.Activity activity)` Preload all messages in a given Activity, so they're ready to be shown quickly
`void`	`preloadMessagesForCustomEvent(android.app.Activity activity, String eventName)` Preload all messages that are triggered by given custom event
`void`	`preloadMessageWithId(android.app.Activity activity, String messageId)` Preload a single message with given message ID
`void`	`registerCustomProfileDate(String variableName)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileDate(String, Date)`.
`void`	`registerCustomProfileDate(String variableName, Date defaultValue)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileDate(String, Date)`.
`void`	`registerCustomProfileGeolocation(String variableName)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileGeolocation(String, TuneLocation)`.
`void`	`registerCustomProfileGeolocation(String variableName, TuneLocation defaultValue)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileGeolocation(String, TuneLocation)`.
`void`	`registerCustomProfileNumber(String variableName)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileNumber(String, double)`, `setCustomProfileNumber(String, float)`, or `setCustomProfileNumber(String, int)`.
`void`	`registerCustomProfileNumber(String variableName, double defaultValue)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileNumber(String, double)`, `setCustomProfileNumber(String, float)`, or `setCustomProfileNumber(String, int)`.
`void`	`registerCustomProfileNumber(String variableName, float defaultValue)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileNumber(String, double)`, `setCustomProfileNumber(String, float)`, or `setCustomProfileNumber(String, int)`.
`void`	`registerCustomProfileNumber(String variableName, int defaultValue)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileNumber(String, double)`, `setCustomProfileNumber(String, float)`, or `setCustomProfileNumber(String, int)`.
`void`	`registerCustomProfileString(String variableName)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileStringValue(String, String)`.
`void`	`registerCustomProfileString(String variableName, String defaultValue)` Register a custom profile variable for this user. This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes. Once registered, the value for this variable can be set using `setCustomProfileStringValue(String, String)`.
`void`	`registerCustomTuneLinkDomain(String domainSuffix)` If you have set up a custom domain for use with Tune Links (cname to a *.tlnk.io domain), then register it with this method.
`void`	`registerDeepAction(String actionId, String friendlyName, Map<String,String> defaultData, TuneDeepActionCallback action)` Registers a code-block Deep Action for use with TUNE.
`void`	`registerDeeplinkListener(TuneDeeplinkListener listener)` Set the deeplink listener that will be called when either a deferred deeplink is found for a fresh install or for handling an opened Tune Link.
`void`	`registerPowerHook(String hookId, String friendlyName, String defaultValue)` Registers a Power Hook for use with TUNE.
`void`	`setAdvertiserId(String advertiserId)` Sets the TUNE advertiser ID.
`void`	`setAge(int age)` Sets the user's age.
`void`	`setAltitude(double altitude)` Sets the device altitude.
`void`	`setAndroidId(String androidId)` Sets the ANDROID ID.
`void`	`setAndroidIdMd5(String androidIdMd5)` Sets the ANDROID ID MD5 hash.
`void`	`setAndroidIdSha1(String androidIdSha1)` Sets the ANDROID ID SHA-1 hash.
`void`	`setAndroidIdSha256(String androidIdSha256)` Sets the ANDROID ID SHA-256 hash.
`void`	`setAppAdTrackingEnabled(boolean adTrackingEnabled)` Sets whether app-level ad tracking is enabled.
`void`	`setConversionKey(String conversionKey)` Sets the conversion key for the SDK.
`void`	`setCurrencyCode(String currencyCode)` Sets the ISO 4217 currency code.
`void`	`setCustomProfileDate(String variableName, Date value)` Set or update the value associated with a custom date profile variable. This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes. This can be called from anywhere in your app after the appropriate register call in `Application.onCreate()`.
`void`	`setCustomProfileGeolocation(String variableName, TuneLocation value)` Set or update the value associated with a custom location profile variable. This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes. This can be called from anywhere in your app after the appropriate register call in `Application.onCreate()`.
`void`	`setCustomProfileNumber(String variableName, double value)` Set or update the value associated with a custom number profile variable. This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes. This can be called from anywhere in your app after the appropriate register call in `Application.onCreate()`.
`void`	`setCustomProfileNumber(String variableName, float value)` Set or update the value associated with a custom number profile variable. This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes. This can be called from anywhere in your app after the appropriate register call in `Application.onCreate()`.
`void`	`setCustomProfileNumber(String variableName, int value)` Set or update the value associated with a custom number profile variable. This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes. This can be called from anywhere in your app after the appropriate register call in `Application.onCreate()`.
`void`	`setCustomProfileStringValue(String variableName, String value)` Set or update the value associated with a custom string profile variable. This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes. This can be called from anywhere in your app after the appropriate register call in `Application.onCreate()`.
`void`	`setDebugMode(boolean debug)` Turns debug mode on or off, under tag "TUNE".
`void`	`setDeeplinkListener(TuneDeeplinkListener listener)` Deprecated. as of Tune Android SDK v4.8.0 use `registerDeeplinkListener(TuneDeeplinkListener)` instead. This method will be removed in Tune Android SDK v5.0.0
`void`	`setDeviceBrand(String deviceBrand)` Sets the device brand, or manufacturer.
`void`	`setDeviceBuild(String deviceBuild)` Sets the device build.
`void`	`setDeviceId(String deviceId)` Sets the device IMEI/MEID.
`void`	`setDeviceModel(String deviceModel)` Sets the device model.
`void`	`setEmailCollection(boolean collectEmail)` Enables or disables primary Gmail address collection Requires GET_ACCOUNTS permission
`void`	`setExistingUser(boolean existing)` Sets whether app was previously installed prior to version with TUNE SDK.
`void`	`setFacebookEventLogging(boolean logging, android.content.Context context, boolean limitEventAndDataUsage)` Whether to log TUNE events in the FB SDK as well
`void`	`setFacebookUserId(String userId)` Sets the user ID to associate with Facebook.
`void`	`setFireAdvertisingId(String adId, boolean isLATEnabled)` Sets the Amazon Fire Advertising ID.
`void`	`setFullScreenLoadingScreen(int layoutId)` Sets a layout to use as the loading screen before a full screen in-app message is shown, in place of the system default ProgressDialog.
`void`	`setGender(TuneGender gender)` Sets the user gender.
`void`	`setGoogleAdvertisingId(String adId, boolean isLATEnabled)` Sets the Google Play Services Advertising ID.
`void`	`setGoogleUserId(String userId)` Sets the user ID to associate with Google.
`void`	`setInstallReferrer(String referrer)` Overrides the Google Play INSTALL_REFERRER received
`void`	`setIsPayingUser(boolean isPayingUser)` Sets whether the user is revenue-generating or not.
`void`	`setLatitude(double latitude)` Sets the device latitude.
`void`	`setListener(TuneListener listener)` Register a TuneListener interface to receive server response callback
`void`	`setLocale(String locale)` Sets the device locale
`void`	`setLocation(android.location.Location location)` Sets the device location
`void`	`setLocation(TuneLocation location)` Sets the device location.
`void`	`setLongitude(double longitude)` Sets the device longitude.
`void`	`setMacAddress(String macAddress)` Sets the device MAC address.
`void`	`setOptedOutOfPush(boolean optedOutOfPush)` Specify whether the current user has opted out of push messaging. This information is added to the personalization profile of the current user for segmentation, targeting, and reporting purposes.
`void`	`setOsVersion(String osVersion)` Sets the device OS version
`void`	`setPackageName(String packageName)` Sets the app package name
`void`	`setPhoneNumber(String phoneNumber)` Sets the device phone number
`void`	`setPluginName(String pluginName)` Set the name of plugin used, if any.
`void`	`setPreloadedApp(TunePreloadData preloadData)` Sets publisher information for device preloaded apps
`void`	`setPushListener(TunePushListener listener)` Provide Tune with a push listener to access extraPushPayload and decide if a notification should be displayed.
`void`	`setPushNotificationBuilder(TuneNotificationBuilder builder)` Provide Tune with a notification builder to provide defaults for your app's notifications. If you do not use `setPushNotificationSenderId(String)` this doesn't do anything.
`void`	`setPushNotificationRegistrationId(String registrationId)` Provide Tune with your GCM registration id for this device. By using this method you are implicitly enabling Tune Push Messaging.
`void`	`setPushNotificationSenderId(String pushSenderId)` Provide Tune with your Push Sender ID.
`void`	`setReferralCallingPackage(String referralCallingPackage)` Set the package that invoked the activity.
`void`	`setReferralSources(android.app.Activity act)` Deprecated. as of Tune Android SDK v4.8.0 you do not need to call this method directly. This method will be removed in Tune Android SDK v5.0.0
`void`	`setReferralUrl(String url)` Set referral url (deeplink).
`void`	`setShouldAutoCollectDeviceLocation(boolean autoCollect)` Whether to autocollect device location if location is enabled
`void`	`setTRUSTeId(String tpid)` Sets the TRUSTe ID, should generate via their SDK
`void`	`setTwitterUserId(String userId)` Sets the user ID to associate with Twitter
`protected void`	`setUrlRequester(UrlRequester urlRequester)` Set the Url Requester.
`void`	`setUserEmail(String userEmail)` Sets the custom user email.
`void`	`setUserId(String userId)` Sets the custom user ID.
`void`	`setUserName(String userName)` Sets the custom user name.
`void`	`setValueForHookById(String hookId, String value)` Sets the value of a Power Hook.
`void`	`unregisterDeeplinkListener()` Remove the deeplink listener previously set with `registerDeeplinkListener(TuneDeeplinkListener)`.
`protected void`	`updateLocation()` If location autocollect is enabled, tries to get latest location from TuneLocationListener, triggering update if needed

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

- Field Detail
  - networkStateReceiver
```
protected android.content.BroadcastReceiver networkStateReceiver
```
  - mContext
```
protected android.content.Context mContext
```
  - pubQueue
```
protected ExecutorService pubQueue
```
  - eventQueue
```
protected TuneEventQueue eventQueue
```
  - locationListener
```
protected TuneLocationListener locationListener
```
  - params
```
protected TuneParameters params
```
  - tuneRequest
```
protected TuneTestRequest tuneRequest
```
  - initialized
```
protected boolean initialized
```
  - isRegistered
```
protected boolean isRegistered
```
  - collectLocation
```
protected boolean collectLocation
```
  - isFirstInstall
```
protected boolean isFirstInstall
```
  - timeLastMeasuredSession
```
protected long timeLastMeasuredSession
```
- Constructor Detail
  - Tune
```
protected Tune()
```
- Method Detail
  - getInstance
```
public static Tune getInstance()
```
    Get existing TUNE singleton object
    
    Returns:
    
    Tune instance
  - init
```
public static Tune init(android.content.Context context,
                        String advertiserId,
                        String conversionKey)
```
    Initializes the TUNE SDK with TMA off by default.
    
    Parameters:
    
    context - Application context
    
    advertiserId - TUNE advertiser ID
    
    conversionKey - TUNE conversion key
    
    Returns:
    
    Tune instance with initialized values
  - init
```
public static Tune init(android.content.Context context,
                        String advertiserId,
                        String conversionKey,
                        boolean turnOnIAM)
```
    Initializes the TUNE SDK.
    
    Parameters:
    
    context - Application context
    
    advertiserId - TUNE advertiser ID
    
    conversionKey - TUNE conversion key
    
    turnOnIAM - Whether to enable Tune In-App Marketing or not
    
    Returns:
    
    Tune instance with initialized values
  - init
```
public static Tune init(android.content.Context context,
                        String advertiserId,
                        String conversionKey,
                        boolean turnOnIAM,
                        TuneConfiguration configuration)
```
    Initializes the TUNE SDK.
    
    Parameters:
    
    context - Application context
    
    advertiserId - TUNE advertiser ID
    
    conversionKey - TUNE conversion key
    
    turnOnIAM - Whether to enable Tune In-App Marketing or not
    
    configuration - custom SDK configuration
    
    Returns:
    
    Tune instance with initialized values
  - initAll
```
protected void initAll(String advertiserId,
                       String conversionKey)
```
    Private initialization function for TUNE SDK.
    
    Parameters:
    
    advertiserId - the TUNE advertiser ID for the app
    
    conversionKey - the TUNE conversion key for the app
  - isOnline
```
public static boolean isOnline(android.content.Context context)
```
    Returns true if an Internet connection is detected.
    
    Parameters:
    
    context - the app context to check connectivity from
    
    Returns:
    
    whether Internet connection exists
  - addEventToQueue
```
protected void addEventToQueue(String link,
                               String data,
                               org.json.JSONObject postBody,
                               boolean firstSession)
```
  - dumpQueue
```
protected void dumpQueue()
```
  - measureSession
```
@Deprecated
public void measureSession()
```
    Deprecated. As of Tune Android SDK v4.8.0 you do not need to explicitly call this method for native Tune Android SDK integrations. The session will be measured as part of the call to TuneActivity's onResume, which may be called automatically with the activity lifecycle callbacks registered via your Application class as part of the normal Tune SDK integration. Tune Android SDK plugins should call measureSessionInternal() instead. This method will be removed in Tune Android SDK v5.0.0
    
    Main session measurement function.
  - measureSessionInternal
```
public void measureSessionInternal()
```
    Measure new session. Tune Android SDK plugins may use this method to trigger session measurement events. This should be called in the equivalent of onResume().
  - getTimeLastMeasuredSession
```
public long getTimeLastMeasuredSession()
```
    Get the time the Tune SDK last measured a new session. This value may not update each time the app is foregrounded.
    
    Returns:
    
    time of last session measurement in milliseconds (System time).
  - measureEvent
```
public void measureEvent(String eventName)
```
    Event measurement function that measures an event for the given eventName.
    
    Parameters:
    
    eventName - event name in TUNE system
  - measureEvent
```
@Deprecated
public void measureEvent(int eventId)
```
    Deprecated. TUNE does not support measuring events using event IDs. Please use measureEvent(String) or measureEvent(TuneEvent) methods. This method will be removed in Tune Android SDK v5.0.0
    
    Event measurement function that measures an event for the given eventId.
    
    Parameters:
    
    eventId - event ID in TUNE system
  - measureEvent
```
public void measureEvent(TuneEvent eventData)
```
    Event measurement function that measures an event based on TuneEvent values. Create a TuneEvent to pass in with:
```
new TuneEvent(eventName)
```
    Parameters:
    
    eventData - custom data to associate with the event
  - makeRequest
```
protected boolean makeRequest(String link,
                              String data,
                              org.json.JSONObject postBody)
```
    Helper function for making single request and displaying response
    
    Parameters:
    
    link - Url address
    
    data - Url link data
    
    postBody - Url post body
    
    Returns:
    
    true if request was sent successfully and should be removed from queue
  - invokeUrlFromReferralUrl
```
protected TuneOptional<String> invokeUrlFromReferralUrl(String referralUrl)
```
  - updateLocation
```
protected void updateLocation()
```
    If location autocollect is enabled, tries to get latest location from TuneLocationListener, triggering update if needed
  - getAction
```
public String getAction()
```
    Gets the action of the event
    
    Returns:
    
    install/update/conversion
  - getAdvertiserId
```
public String getAdvertiserId()
```
    Gets the TUNE advertiser ID.
    
    Returns:
    
    TUNE advertiser ID
  - getAge
```
public int getAge()
```
    Gets the user age. NOTE: this value must be set with setAge(int) otherwise this method will return 0.
    
    Returns:
    
    age, if set. If no value is set this method returns 0.
  - getAltitude
```
public double getAltitude()
```
    Gets the device altitude. NOTE: this value must be set with setAltitude(double) otherwise this method will return 0.
    
    Returns:
    
    device altitude, if set. If no value is set returns 0.0
  - getAndroidId
```
public String getAndroidId()
```
    Gets the ANDROID_ID of the device that was set with setAndroidId(String)
    
    Returns:
    
    ANDROID_ID
  - getAppAdTrackingEnabled
```
public boolean getAppAdTrackingEnabled()
```
    Get whether the user has app-level ad tracking enabled or not.
    
    Returns:
    
    app-level ad tracking enabled or not
  - getAppName
```
public String getAppName()
```
    Gets the app name
    
    Returns:
    
    app name
  - getAppVersion
```
public int getAppVersion()
```
    Gets the app version
    
    Returns:
    
    app version
  - getConnectionType
```
public String getConnectionType()
```
    Gets the connection type (mobile or WIFI);.
    
    Returns:
    
    whether device is connected by WIFI or mobile data connection
  - getCountryCode
```
public String getCountryCode()
```
    Gets the ISO 639-1 country code
    
    Returns:
    
    ISO 639-1 country code
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Gets the ISO 4217 currency code.
    
    Returns:
    
    ISO 4217 currency code
  - getDeviceBrand
```
public String getDeviceBrand()
```
    Gets the device brand/manufacturer (HTC, Apple, etc)
    
    Returns:
    
    device brand/manufacturer name
  - getDeviceBuild
```
public String getDeviceBuild()
```
    Gets the device build
    
    Returns:
    
    device build name
  - getDeviceCarrier
```
public String getDeviceCarrier()
```
    Gets the device carrier if any
    
    Returns:
    
    mobile device carrier/service provider name
  - getDeviceId
```
public String getDeviceId()
```
    Gets the Device ID, also known as IMEI/MEID, if any
    
    Returns:
    
    device IMEI/MEID
  - getDeviceModel
```
public String getDeviceModel()
```
    Gets the device model name
    
    Returns:
    
    device model name
  - getExistingUser
```
public boolean getExistingUser()
```
    Gets value previously set of existing user or not.
    
    Returns:
    
    whether user existed prior to install
  - getFacebookUserId
```
public String getFacebookUserId()
```
    Gets the Facebook user ID previously set.
    
    Returns:
    
    Facebook user ID
  - getFireAdvertisingId
```
public String getFireAdvertisingId()
```
    Gets the Fire Advertising ID.
    
    Returns:
    
    Fire advertising ID
  - getFireAdTrackingLimited
```
public boolean getFireAdTrackingLimited()
```
    Gets whether use of the Fire Advertising ID is limited by user request.
    
    Returns:
    
    whether tracking is limited
  - getGender
```
public TuneGender getGender()
```
    Gets the user gender set with setGender(TuneGender).
    
    Returns:
    
    gender
  - getGoogleAdvertisingId
```
public String getGoogleAdvertisingId()
```
    Gets the Google Play Services Advertising ID.
    
    Returns:
    
    Google advertising ID
  - getGoogleAdTrackingLimited
```
public boolean getGoogleAdTrackingLimited()
```
    Gets whether use of the Google Play Services Advertising ID is limited by user request.
    
    Returns:
    
    whether tracking is limited
  - getGoogleUserId
```
public String getGoogleUserId()
```
    Gets the Google user ID previously set.
    
    Returns:
    
    Google user ID
  - getInstallDate
```
public long getInstallDate()
```
    Gets the date of app install
    
    Returns:
    
    date that app was installed, epoch seconds
  - getInstallReferrer
```
public String getInstallReferrer()
```
    Gets the Google Play INSTALL_REFERRER
    
    Returns:
    
    Play INSTALL_REFERRER
  - getIsPayingUser
```
public boolean getIsPayingUser()
```
    Gets whether the user is revenue-generating or not
    
    Returns:
    
    true if the user has produced revenue, false if not
  - getLanguage
```
public String getLanguage()
```
    Gets the language of the device
    
    Returns:
    
    device language
  - getLastOpenLogId
```
public String getLastOpenLogId()
```
    Gets the last TUNE open log ID
    
    Returns:
    
    most recent TUNE open log ID
  - getLatitude
```
public double getLatitude()
```
    Gets the device latitude. NOTE: Must be set by setLatitude(double). This value is not automatically retrieved.
    
    Returns:
    
    device latitude
  - getLocale
```
public String getLocale()
```
    Gets the device locale.
    
    Returns:
    
    device locale
  - getLongitude
```
public double getLongitude()
```
    Gets the device longitude. NOTE: This value must be set by setLongitude(double). This value is not automatically retrieved.
    
    Returns:
    
    device longitude
  - getMacAddress
```
public String getMacAddress()
```
    Gets the MAC address of device
    
    Returns:
    
    device MAC address
  - getMatId
```
public String getMatId()
```
    Gets the MAT ID generated on install
    
    Returns:
    
    MAT ID
  - getMCC
```
public String getMCC()
```
    Gets the mobile country code.
    
    Returns:
    
    mobile country code associated with the carrier
  - getMNC
```
public String getMNC()
```
    Gets the mobile network code.
    
    Returns:
    
    mobile network code associated with the carrier
  - getOpenLogId
```
public String getOpenLogId()
```
    Gets the first TUNE open log ID
    
    Returns:
    
    first TUNE open log ID
  - getOsVersion
```
public String getOsVersion()
```
    Gets the Android OS version
    
    Returns:
    
    Android OS version
  - getPackageName
```
public String getPackageName()
```
    Gets the app package name
    
    Returns:
    
    package name of app
  - getPluginName
```
public String getPluginName()
```
    Get SDK plugin name used
    
    Returns:
    
    name of TUNE plugin
  - getReferralSource
```
public String getReferralSource()
```
    Gets the package name of the app that started this Activity, if any
    
    Returns:
    
    source package name that caused open via StartActivityForResult
  - getReferralUrl
```
public String getReferralUrl()
```
    Gets the url scheme that started this Activity, if any
    
    Returns:
    
    full url of app scheme that caused open
  - getScreenDensity
```
public String getScreenDensity()
```
    Gets the screen density of the device
    
    Returns:
    
    0.75/1.0/1.5/2.0/3.0/4.0 for ldpi/mdpi/hdpi/xhdpi/xxhdpi/xxxhdpi
  - getScreenHeight
```
public String getScreenHeight()
```
    Gets the screen height of the device in pixels
    
    Returns:
    
    height
  - getScreenWidth
```
public String getScreenWidth()
```
    Gets the screen width of the device in pixels
    
    Returns:
    
    width
  - getSDKVersion
```
public static String getSDKVersion()
```
    Gets the TUNE Android SDK version
    
    Returns:
    
    TUNE Android SDK version
  - getTRUSTeId
```
public String getTRUSTeId()
```
    Gets the TRUSTe ID set
    
    Returns:
    
    TRUSTe ID
  - getTwitterUserId
```
public String getTwitterUserId()
```
    Gets the Twitter user ID previously set.
    
    Returns:
    
    Twitter user ID
  - getUserAgent
```
public String getUserAgent()
```
    Gets the device browser user agent
    
    Returns:
    
    device user agent
  - getUserEmail
```
public String getUserEmail()
```
    Gets the custom user email.
    
    Returns:
    
    custom user email
  - getUserId
```
public String getUserId()
```
    Gets the custom user ID.
    
    Returns:
    
    custom user id
  - getUserName
```
public String getUserName()
```
    Gets the custom user name.
    
    Returns:
    
    custom user name
  - setAdvertiserId
```
public void setAdvertiserId(String advertiserId)
```
    Sets the TUNE advertiser ID.
    
    Parameters:
    
    advertiserId - TUNE advertiser ID
  - setAge
```
public void setAge(int age)
```
    Sets the user's age. When age is set to a value less than 13 IAM push notifications will not be sent to this device, in order to comply with COPPA. See https://www.ftc.gov/enforcement/rules/rulemaking-regulatory-reform-proceedings/childrens-online-privacy-protection-rule
    
    Parameters:
    
    age - User age
  - setAltitude
```
public void setAltitude(double altitude)
```
    Sets the device altitude.
    
    Parameters:
    
    altitude - device altitude
  - setAndroidId
```
public void setAndroidId(String androidId)
```
    Sets the ANDROID ID.
    
    Parameters:
    
    androidId - ANDROID_ID
  - setAndroidIdMd5
```
public void setAndroidIdMd5(String androidIdMd5)
```
    Sets the ANDROID ID MD5 hash.
    
    Parameters:
    
    androidIdMd5 - ANDROID_ID MD5 hash
  - setAndroidIdSha1
```
public void setAndroidIdSha1(String androidIdSha1)
```
    Sets the ANDROID ID SHA-1 hash.
    
    Parameters:
    
    androidIdSha1 - ANDROID_ID SHA-1 hash
  - setAndroidIdSha256
```
public void setAndroidIdSha256(String androidIdSha256)
```
    Sets the ANDROID ID SHA-256 hash.
    
    Parameters:
    
    androidIdSha256 - ANDROID_ID SHA-256 hash
  - setAppAdTrackingEnabled
```
public void setAppAdTrackingEnabled(boolean adTrackingEnabled)
```
    Sets whether app-level ad tracking is enabled.
    
    Parameters:
    
    adTrackingEnabled - true if user has opted out of ad tracking at the app-level, false if not
  - setConversionKey
```
public void setConversionKey(String conversionKey)
```
    Sets the conversion key for the SDK.
    
    Parameters:
    
    conversionKey - TUNE conversion key
  - setCurrencyCode
```
public void setCurrencyCode(String currencyCode)
```
    Sets the ISO 4217 currency code.
    
    Parameters:
    
    currencyCode - the currency code
  - setDeviceBrand
```
public void setDeviceBrand(String deviceBrand)
```
    Sets the device brand, or manufacturer.
    
    Parameters:
    
    deviceBrand - device brand
  - setDeviceBuild
```
public void setDeviceBuild(String deviceBuild)
```
    Sets the device build.
    
    Parameters:
    
    deviceBuild - device build
  - setDeviceId
```
public void setDeviceId(String deviceId)
```
    Sets the device IMEI/MEID.
    
    Parameters:
    
    deviceId - device IMEI/MEID
  - setDeviceModel
```
public void setDeviceModel(String deviceModel)
```
    Sets the device model.
    
    Parameters:
    
    deviceModel - device model
  - setExistingUser
```
public void setExistingUser(boolean existing)
```
    Sets whether app was previously installed prior to version with TUNE SDK. This should be called BEFORE your first activity resumes.
    
    Parameters:
    
    existing - true if this user already had the app installed prior to updating to TUNE version
  - setFacebookUserId
```
public void setFacebookUserId(String userId)
```
    Sets the user ID to associate with Facebook.
    
    Parameters:
    
    userId - the Facebook user id
  - setFireAdvertisingId
```
public void setFireAdvertisingId(String adId,
                                 boolean isLATEnabled)
```
    Sets the Amazon Fire Advertising ID.
    
    Parameters:
    
    adId - Amazon Fire advertising ID
    
    isLATEnabled - whether user has enabled limit ad tracking
  - setGender
```
public void setGender(TuneGender gender)
```
    Sets the user gender.
    
    Parameters:
    
    gender - use TuneGender.MALE, TuneGender.FEMALE
  - setGoogleAdvertisingId
```
public void setGoogleAdvertisingId(String adId,
                                   boolean isLATEnabled)
```
    Sets the Google Play Services Advertising ID.
    
    Parameters:
    
    adId - Google Play advertising ID
    
    isLATEnabled - whether user has enabled limit ad tracking
  - setGoogleUserId
```
public void setGoogleUserId(String userId)
```
    Sets the user ID to associate with Google.
    
    Parameters:
    
    userId - the Google user id
  - setInstallReferrer
```
public void setInstallReferrer(String referrer)
```
    Overrides the Google Play INSTALL_REFERRER received
    
    Parameters:
    
    referrer - Your custom referrer value
  - setIsPayingUser
```
public void setIsPayingUser(boolean isPayingUser)
```
    Sets whether the user is revenue-generating or not.
    
    Parameters:
    
    isPayingUser - true if the user has produced revenue, false if not
  - setLocale
```
public void setLocale(String locale)
```
    Sets the device locale
    
    Parameters:
    
    locale - the device locale
  - setLocation
```
public void setLocation(android.location.Location location)
```
    Sets the device location
    
    Parameters:
    
    location - the device location
  - setLocation
```
public void setLocation(TuneLocation location)
```
    Sets the device location. Manually setting the location through this method disables geo-location auto-collection.
    
    Parameters:
    
    location - the device location as a TuneLocation
  - setLatitude
```
public void setLatitude(double latitude)
```
    Sets the device latitude. Manually setting the latitude through this method disables geo-location auto-collection.
    
    Parameters:
    
    latitude - the device latitude
  - setLongitude
```
public void setLongitude(double longitude)
```
    Sets the device longitude. Manually setting the longitude through this method disables geo-location auto-collection.
    
    Parameters:
    
    longitude - the device longitude
  - setListener
```
public void setListener(TuneListener listener)
```
    Register a TuneListener interface to receive server response callback
    
    Parameters:
    
    listener - a TuneListener object that will be called when server request is complete
  - setMacAddress
```
public void setMacAddress(String macAddress)
```
    Sets the device MAC address.
    
    Parameters:
    
    macAddress - device MAC address
  - setOsVersion
```
public void setOsVersion(String osVersion)
```
    Sets the device OS version
    
    Parameters:
    
    osVersion - device OS version
  - setPackageName
```
public void setPackageName(String packageName)
```
    Sets the app package name
    
    Parameters:
    
    packageName - App package name
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
    Sets the device phone number
    
    Parameters:
    
    phoneNumber - Phone number
  - setPreloadedApp
```
public void setPreloadedApp(TunePreloadData preloadData)
```
    Sets publisher information for device preloaded apps
    
    Parameters:
    
    preloadData - Preload app attribution data
  - setReferralSources
```
@Deprecated
public void setReferralSources(android.app.Activity act)
```
    Deprecated. as of Tune Android SDK v4.8.0 you do not need to call this method directly. This method will be removed in Tune Android SDK v5.0.0
    
    Get referral sources from Activity
    
    Parameters:
    
    act - Activity to get referring package name and url scheme from
  - setReferralCallingPackage
```
public void setReferralCallingPackage(@Nullable
                                      String referralCallingPackage)
```
    Set the package that invoked the activity. Typically this value is from Activity.getCallingPackage() and may be null.
    
    Parameters:
    
    referralCallingPackage - The name of the callling package
  - setReferralUrl
```
public void setReferralUrl(String url)
```
    Set referral url (deeplink). You usually do not need to call this directly. If called, this method should be called BEFORE measureSessionInternal() or measureSession()
    
    Parameters:
    
    url - deeplink with which app was invoked
  - setTRUSTeId
```
public void setTRUSTeId(String tpid)
```
    Sets the TRUSTe ID, should generate via their SDK
    
    Parameters:
    
    tpid - TRUSTe ID
  - setTwitterUserId
```
public void setTwitterUserId(String userId)
```
    Sets the user ID to associate with Twitter
    
    Parameters:
    
    userId - the Twitter user id
  - setUserEmail
```
public void setUserEmail(String userEmail)
```
    Sets the custom user email.
    
    Parameters:
    
    userEmail - the user email
  - setUserId
```
public void setUserId(String userId)
```
    Sets the custom user ID.
    
    Parameters:
    
    userId - the user id
  - setUserName
```
public void setUserName(String userName)
```
    Sets the custom user name.
    
    Parameters:
    
    userName - the username
  - setPluginName
```
public void setPluginName(String pluginName)
```
    Set the name of plugin used, if any.
    
    Parameters:
    
    pluginName - the name of the plugin used
  - setDebugMode
```
public void setDebugMode(boolean debug)
```
    Turns debug mode on or off, under tag "TUNE". Additionally, setting this to 'true' will cause two exceptions to be thrown to aid in debugging the IAM configuration. Normally IAM will log an error to the console when you misconfigure or misuse a method, but this way an exception is thrown to quickly and explicitly find what is misconfigured. - TuneIAMNotEnabledException: This will be thrown if you use a IAM method without IAM enabled. - TuneIAMConfigurationException: This will be thrown if the arguments passed to an IAM method are invalid. The exception message will have more details.
    
    Parameters:
    
    debug - whether to enable debug output
  - isInDebugMode
```
public boolean isInDebugMode()
```
    Checks the current status of debug mode.
    
    Returns:
    
    Whether debug mode is on or off.
  - setEmailCollection
```
public void setEmailCollection(boolean collectEmail)
```
    Enables or disables primary Gmail address collection Requires GET_ACCOUNTS permission
    
    Parameters:
    
    collectEmail - whether to collect device email address
  - setFacebookEventLogging
```
public void setFacebookEventLogging(boolean logging,
                                    android.content.Context context,
                                    boolean limitEventAndDataUsage)
```
    Whether to log TUNE events in the FB SDK as well
    
    Parameters:
    
    logging - Whether to send TUNE events to FB as well
    
    context - Activity context
    
    limitEventAndDataUsage - Whether user opted out of ads targeting
  - setShouldAutoCollectDeviceLocation
```
public void setShouldAutoCollectDeviceLocation(boolean autoCollect)
```
    Whether to autocollect device location if location is enabled
    
    Parameters:
    
    autoCollect - Automatically collect device location, default is true
  - registerPowerHook
```
public void registerPowerHook(String hookId,
                              String friendlyName,
                              String defaultValue)
```
    Registers a Power Hook for use with TUNE. Use this method to declare the existence of a Power Hook you would like to pass in from TUNE. This declaration should occur in Application.onCreate().
    
    Parameters:
    
    hookId - The name of the configuration setting to register. Name must be unique for this app and cannot be empty.
    
    friendlyName - The name for this hook that will be displayed in TMC. This value cannot be empty.
    
    defaultValue - The default value for this hook. This value will be used if no value is passed in from TMC for this app. This value cannot be nil.
  - getValueForHookById
```
public String getValueForHookById(String hookId)
```
    Gets the value of a Power Hook. Use this method to get the value of a Power Hook from TUNE. This will return the value specified in IAM web console, or the default value if none has been specified. NOTE: If no hook was registered for the given ID, this method will return null.
    
    Parameters:
    
    hookId - The name of the Power Hook you wish to retrieve. Will return nil if the Power Hook has not been registered.
    
    Returns:
    
    the value of the Power Hook
  - setValueForHookById
```
public void setValueForHookById(String hookId,
                                String value)
```
    Sets the value of a Power Hook. Use this method to set the value of a Power Hook from TUNE. NOTE: ** This is for QA purposes only, you should not use this method in Production as it will override the value sent from the web platform. **
    
    Parameters:
    
    hookId - The name of the Power Hook you wish to set the value for.
    
    value - The new value you would like to test.
  - onPowerHooksChanged
```
public void onPowerHooksChanged(TuneCallback callback)
```
    Register a callback when any Power Hooks have changed due to a new value from the Server. NOTE: Only the latest callback registered will be executed. NOTE: ** The thread calling the block of code is not guaranteed to be on the main thread. If the code inside of the block requires executing on the main thread you will need to implement this logic. **
    
    Parameters:
    
    callback - The block of code to be executed.
  - registerDeepAction
```
public void registerDeepAction(String actionId,
                               String friendlyName,
                               Map<String,String> defaultData,
                               TuneDeepActionCallback action)
```
    Registers a code-block Deep Action for use with TUNE. Use this method to declare the existence of a Power Hook you would like to pass in from TUNE.
    
    Parameters:
    
    actionId - The name of the deep action to register. Name must be unique for this app and cannot be null or empty.
    
    friendlyName - The friendly name for this action that will be displayed in TMC. This value cannot be null.
    
    defaultData - The default values for this deep action. These values will be used if no value is passed in from TMC for this app. This cannot be null.
    
    action - The code block that implements Runnable to execute when this Deep Action fires. This cannot be null
  - executeDeepAction
```
public void executeDeepAction(android.app.Activity activity,
                              String actionId,
                              Map<String,String> data)
```
    Executes a previously registered Deep Action code-block. The data to be used by the current execution of the deep action code-block is derived by merging the Map provided here with the default Map provided during deep action registration. Also, the new values take preference over the default values when the keys match.
    
    Parameters:
    
    activity - Activity object to be made available to the deep action code-block. This object may be null depending on its usage in the code-block.
    
    actionId - Non-empty non-null name of a previously registered deep action code-block.
    
    data - Values to be used with the deep action. This Map may be null or empty or contain string keys and values.
  - getPowerHookExperimentDetails
```
public Map<String,TunePowerHookExperimentDetails> getPowerHookExperimentDetails()
```
    Get details for all currently running Power Hook Variable experiments. Details include the hook id for the Power Hook, experiment and variation ids and start and end date of the experiment.
    
    Returns:
    
    a `Map` of experiment details for all running Power Hook variable experiments, where the keys are the `String` Power Hook IDs of the Power Hooks, and the values are `TunePowerHookExperimentDetails` objects.
  - getInAppMessageExperimentDetails
```
public Map<String,TuneInAppMessageExperimentDetails> getInAppMessageExperimentDetails()
```
    Get details for all currently running In App Message experiments. Details include the experiment and variation ids and start and end date of the experiment.
    
    Returns:
    
    a `HashMap` of experiment details for all running In App Message experiments, where the keys are the `String` campaign ids of the In App Messages, and the values are `TuneInAppMessageExperimentDetails` objects.
  - onFirstPlaylistDownloaded
```
public void onFirstPlaylistDownloaded(TuneCallback callback)
```
    Register callback when the first playlist is downloaded for App's lifetime. Use this method to register a callback the first time a playlist is downloaded. This call is non-blocking so code execution will continue immediately to the next line of code. IMPORTANT: The thread executing the callback is not going to be on the main thread. You will need to implement custom logic if you want to ensure that the block of code always executes on the main thread. If the first playlist has already been downloaded when this call is made the callback is executed immediately on a background thread. Otherwise the callback will fire after TuneConstants.DEFAULT_FIRST_PLAYLIST_DOWNLOADED_TIMEOUT milliseconds or when the first playlist is downloaded, whichever comes first. NOTE: This callback will fire upon first playlist download from the application start and upon each callback registration call. If registered more than once, the latest callback will always fire, regardless of whether a previously registered callback already executed. We do not recommend registering more than once but if you do so, please make sure that executing the callback more than once will not cause any issues in your app. NOTE: Only one callback can be registered at a time. Each time a callback is registered it will fire. NOTE: Pending callbacks will be canceled upon app background and resumed upon app foreground. WARNING: If TMA is not enabled then this callback will never fire.
    
    Parameters:
    
    callback - A TuneCallback object that is to be executed.
  - onFirstPlaylistDownloaded
```
public void onFirstPlaylistDownloaded(TuneCallback callback,
                                      long timeout)
```
    Register callback when the first playlist is downloaded for the App's lifetime. Use this method to register a callback for the first time a playlist is downloaded. This call is non-blocking so code execution will continue immediately to the next line of code. IMPORTANT: The thread executing the callback is not going to be on the main thread. You will need to implement custom logic if you want to ensure that the block of code always executes on the main thread. If the first playlist has already been downloaded when this call is made the callback is executed immediately on a background thread. Otherwise the callback will fire after the given timeout (in milliseconds) or when the first playlist is downloaded, whichever comes first. If the timeout is greater than zero, the callback will fire when the timeout expires or the first playlist is downloaded, whichever comes first. NOTE: This callback will fire upon first playlist download from the application start and upon each callback registration call. If registered more than once, the latest callback will always fire, regardless of whether a previously registered callback already executed. We do not recommend registering more than once but if you do so, please make sure that executing the callback more than once will not cause any issues in your app. NOTE: Only one callback can be registered at a time. Each time a callback is registered it will fire. NOTE: Pending callbacks will be canceled upon app background and resumed upon app foreground. WARNING: If TMA is not enabled then this callback will never fire.
    
    Parameters:
    
    callback - A TuneCallback object that is to be executed.
    
    timeout - The number of miliseconds to wait until executing the callback regardless of Playlist download.
  - getInAppMessagesForCustomEvent
```
public List<TuneInAppMessage> getInAppMessagesForCustomEvent(String eventName)
```
    Get in-app messages for this device that are triggered by custom event.
    
    Parameters:
    
    eventName - Event name of custom TuneEvent that would trigger these messages
    
    Returns:
    
    List of messages that are triggered from the given event
  - getInAppMessagesForPushOpened
```
public List<TuneInAppMessage> getInAppMessagesForPushOpened(String pushId)
```
    Get in-app messages for this device that are triggered by a push opened event for a specific TUNE push message.
    
    Parameters:
    
    pushId - Push id (message variation id) of the push notification.
    
    Returns:
    
    List of messages that are triggered by Push Opened event
  - getInAppMessagesForPushEnabled
```
public List<TuneInAppMessage> getInAppMessagesForPushEnabled(boolean pushEnabled)
```
    Get in-app messages for this device that are triggered by a Push Enabled/Disabled event. Push Enabled or Disabled events are sent when a user enables/disables push at a system level or app level setOptedOutOfPush(boolean) or the user profile's age does not meet COPPA (automatically disabled)
    
    Parameters:
    
    pushEnabled - Whether Push Enabled or Push Disabled is the event to use
    
    Returns:
    
    List of messages that are triggered by Push Enabled/Disabled event
  - getInAppMessagesForStartsApp
```
public List<TuneInAppMessage> getInAppMessagesForStartsApp()
```
    Get in-app messages for this device that are triggered by a "Starts App" event. "Starts App" events are actually triggered on the first IAM playlist downloaded after the app launches and not immediately on application foreground. We do this so that all IAM messages, power hooks, deep actions, etc. are populated with the latest values by the time the message should be shown.
    
    Returns:
    
    List of messages that are triggered by "Starts App" event
  - getInAppMessagesForScreenViewed
```
public List<TuneInAppMessage> getInAppMessagesForScreenViewed(String activityName)
```
    Get in-app messages for this device that are triggered by a Screen Viewed event.
    
    Parameters:
    
    activityName - Activity name for the Viewed Screen event
    
    Returns:
    
    List of messages that are triggered by Viewed Screen event
  - getInAppMessagesByIds
```
public Map<String,TuneInAppMessage> getInAppMessagesByIds()
```
    Get all in-app messages that can be shown for this device, sorted by message variation id. Messages can be modified before displaying, or manually triggered to display.
    
    Returns:
    
    `Map` of in-app messages for this device, where the keys are the `String` message variation ids of the In-App Message, and the values are TuneInAppMessage objects.
  - getInAppMessagesByTriggerEvents
```
public Map<String,List<TuneInAppMessage>> getInAppMessagesByTriggerEvents()
```
    Get all in-app messages that can be shown for this device, sorted by trigger event. Messages can be modified for displaying, or manually triggered to display.
    
    Returns:
    
    `Map` of in-app messages for this device, where the keys are the `String` trigger event (event hash) of the In-App Message, and the values are a list of TuneInAppMessage objects with that trigger.
  - preloadMessages
```
public void preloadMessages(android.app.Activity activity)
```
    Preload all messages in a given Activity, so they're ready to be shown quickly
    
    Parameters:
    
    activity - Activity where messages would be shown when triggered
  - preloadMessagesForCustomEvent
```
public void preloadMessagesForCustomEvent(android.app.Activity activity,
                                          String eventName)
```
    Preload all messages that are triggered by given custom event
    
    Parameters:
    
    activity - Activity where messages would be shown when triggered
    
    eventName - Trigger event name for the messages
  - preloadMessageWithId
```
public void preloadMessageWithId(android.app.Activity activity,
                                 String messageId)
```
    Preload a single message with given message ID
    
    Parameters:
    
    activity - Activity where message would be shown when triggered
    
    messageId - Message ID
  - setFullScreenLoadingScreen
```
public void setFullScreenLoadingScreen(int layoutId)
```
    Sets a layout to use as the loading screen before a full screen in-app message is shown, in place of the system default ProgressDialog.
    
    Parameters:
    
    layoutId - layout id of the custom load screen to use
  - setPushNotificationSenderId
```
public void setPushNotificationSenderId(String pushSenderId)
```
    Provide Tune with your Push Sender ID. This is your Google API Project Number. We will handle getting the GCM registration Id for each device.
    
    You get your project number when you set up a project at https://console.developers.google.com/project By setting a push sender Id you are implicitly enabling Tune Push Messaging. IMPORTANT: If you use this method you should not use setPushNotificationRegistrationId(String)
    
    Parameters:
    
    pushSenderId - Your Push Sender Id.
  - setPushNotificationRegistrationId
```
public void setPushNotificationRegistrationId(String registrationId)
```
    Provide Tune with your GCM registration id for this device.
    
    By using this method you are implicitly enabling Tune Push Messaging. IMPORTANT: If you use this method you should not use setPushNotificationSenderId(String)
    
    Parameters:
    
    registrationId - The device token you want to use.
  - setPushNotificationBuilder
```
public void setPushNotificationBuilder(TuneNotificationBuilder builder)
```
    Provide Tune with a notification builder to provide defaults for your app's notifications.
    
    If you do not use setPushNotificationSenderId(String) this doesn't do anything. Important: If you do not provide a small icon for your notifications via the builder we will default to using your app icon. This may look odd if your app is targeting API 21+ because the OS will take only the alpha of the icon and display that on a neutral background. If your app is set to target API 21+ we strongly recommend that you take advantage of the TuneNotificationBuilder API.
    
    Parameters:
    
    builder - by providing a TuneNotificationBuilder you can provide defaults for your app's notifications for Tune Push Messages, like the small icon
  - setPushListener
```
public void setPushListener(TunePushListener listener)
```
    Provide Tune with a push listener to access extraPushPayload and decide if a notification should be displayed.
    
    Parameters:
    
    listener - by providing a TunePushListener you can access the extraPushPayload and decide if the notification should be displayed
  - setOptedOutOfPush
```
public void setOptedOutOfPush(boolean optedOutOfPush)
```
    Specify whether the current user has opted out of push messaging.
    
    This information is added to the personalization profile of the current user for segmentation, targeting, and reporting purposes.
    
    Also, if you are using Tune Push, then by default Tune will assume push messaging is enabled as long as the user has Google Play Services installed on their device and we can successfully get a device token for their device.
    
    If you have a custom setting that gives your end users the ability to turn off notifications for your app, you can use this method to pass that setting on to Tune. Tune will not send notifications to devices where this setting is turned off.
    
    This can be called from anywhere in your app.
    
    Parameters:
    
    optedOutOfPush - Whether the user opted out of push messaging.
  - getDeviceToken
```
public String getDeviceToken()
```
    Returns the currently registered device token for push.
    
    Returns:
    
    The currently registered device token for push, or null if we aren't registered.
  - didUserManuallyDisablePush
```
public boolean didUserManuallyDisablePush()
```
    Returns if the user manually disabled push on the Application Setting page.
    If this returns true then nothing will be allowed to be posted to the tray, not just push notifications
    
    Returns:
    
    Whether the user manually disabled push from the Application Settings screen if API Level >= 19, otherwise false.
  - didSessionStartFromTunePush
```
public boolean didSessionStartFromTunePush()
```
    Returns if the current session is because the user opened a push notification.
    This status is reset to false when the application becomes backgrounded. *NOTE:* If you are implementing TuneActivity manually then this should be called after `super.onStart();` in the activity.
    
    Returns:
    
    true if this session was started because the user opened a push message, otherwise false.
  - getTunePushInfoForSession
```
public TunePushInfo getTunePushInfoForSession()
```
    Returns a POJO containing information about the push message that started the current session.
    This is reset to null when the application becomes backgrounded. *NOTE:* If you are implementing TuneActivity manually then this should be called after `super.onStart();` in the activity.
    
    Returns:
    
    Information about the last opened push if didSessionStartFromTunePush() is true, otherwise null.
  - isUserInSegmentId
```
public boolean isUserInSegmentId(String segmentId)
```
    Returns whether the user belongs to the given segment.
    
    Parameters:
    
    segmentId - Segment ID to check for a match
    
    Returns:
    
    whether the user belongs to the given segment
  - isUserInAnySegmentIds
```
public boolean isUserInAnySegmentIds(List<String> segmentIds)
```
    Returns whether the user belongs to any of the given segments.
    
    Parameters:
    
    segmentIds - Segment IDs to check for a match
    
    Returns:
    
    whether the user belongs to any of the given segments
  - checkForDeferredDeeplink
```
@Deprecated
public void checkForDeferredDeeplink(TuneDeeplinkListener listener)
```
    Deprecated. Instead, register your TuneDeeplinkListener via registerDeeplinkListener(TuneDeeplinkListener). As of Tune Android SDK v4.8.0 this method delegates to registerDeeplinkListener(TuneDeeplinkListener) so that there is only ever one listener at a time. This method is planned for removal in Tune Android SDK v5.0.0.
    
    Checks for a deferred deeplink if exists. Opens deferred deeplink if found and returns value in the registered TuneDeeplinkListener
    
    Parameters:
    
    listener - listener for deeplink value or error
  - setDeeplinkListener
```
@Deprecated
public void setDeeplinkListener(TuneDeeplinkListener listener)
```
    Deprecated. as of Tune Android SDK v4.8.0 use registerDeeplinkListener(TuneDeeplinkListener) instead. This method will be removed in Tune Android SDK v5.0.0
    
    Parameters:
    
    listener - will be called with deferred deeplinks after install or expanded Tune links.
  - unregisterDeeplinkListener
```
public void unregisterDeeplinkListener()
```
    Remove the deeplink listener previously set with registerDeeplinkListener(TuneDeeplinkListener).
  - registerDeeplinkListener
```
public void registerDeeplinkListener(@Nullable
                                     TuneDeeplinkListener listener)
```
    Set the deeplink listener that will be called when either a deferred deeplink is found for a fresh install or for handling an opened Tune Link. Registering a deeplink listener will trigger an asynchronous call to check for deferred deeplinks during the first session after installing of the app with the Tune SDK. The TuneDeeplinkListener#didFailWithError callback will be called if there is no deferred deeplink from Tune for this user or in the event of an error from the server (possibly due to misconfiguration). The TuneDeeplinkListener#didReceiveDeeplink callback will be called when there is a deep link from Tune that you should route the user to. The string should be a fully qualified deep link url string.
    
    Parameters:
    
    listener - will be called with deferred deeplinks after install or expanded Tune links. May be null. Passing null will clear the previously set listener, although you may use unregisterDeeplinkListener() instead.
  - registerCustomTuneLinkDomain
```
public void registerCustomTuneLinkDomain(@NonNull
                                         String domainSuffix)
```
    If you have set up a custom domain for use with Tune Links (cname to a *.tlnk.io domain), then register it with this method. Tune Links are Tune-hosted App Links. Tune Links are often shared as short-urls, and the Tune SDK will handle expanding the url and returning the in-app destination url to TuneDeeplinkListener.didReceiveDeeplink(String) registered via registerDeeplinkListener(TuneDeeplinkListener) This method will test if any clicked links match the given suffix. Do not include a * for wildcard subdomains, instead pass the suffix that you would like to match against the url. So, ".customize.it" will match "1235.customize.it" and "56789.customize.it" but not "customize.it" And, "customize.it" will match "1235.customize.it" and "56789.customize.it", "customize.it", and "1235.tocustomize.it" You can register as many custom subdomains as you like.
    
    Parameters:
    
    domainSuffix - domain which you are using for Tune Links. Must not be null.
  - isTuneLink
```
public boolean isTuneLink(@NonNull
                          String appLinkUrl)
```
    Test if your custom Tune Link domain is registered with Tune. Tune Links are Tune-hosted App Links. Tune Links are often shared as short-urls, and the Tune SDK will handle expanding the url and returning the in-app destination url to TuneDeeplinkListener.didReceiveDeeplink(String) registered via registerDeeplinkListener(TuneDeeplinkListener)
    
    Parameters:
    
    appLinkUrl - url to test if it is a Tune Link. Must not be null.
    
    Returns:
    
    true if this link is a Tune Link that will be measured by Tune and routed into the TuneDeeplinkListener.
  - setUrlRequester
```
protected void setUrlRequester(UrlRequester urlRequester)
```
    Set the Url Requester.
    
    Parameters:
    
    urlRequester - UrlRequester
  - registerCustomProfileString
```
public void registerCustomProfileString(String variableName)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileStringValue(String, String). The default value is nil.
    
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
  - registerCustomProfileDate
```
public void registerCustomProfileDate(String variableName)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileDate(String, Date). The default value is nil.
    
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
  - registerCustomProfileNumber
```
public void registerCustomProfileNumber(String variableName)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileNumber(String, double), setCustomProfileNumber(String, float), or setCustomProfileNumber(String, int). You may use these setters interchangeably. The default value is nil.
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
  - registerCustomProfileGeolocation
```
public void registerCustomProfileGeolocation(String variableName)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileGeolocation(String, TuneLocation). The default value is nil.
    
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
  - registerCustomProfileString
```
public void registerCustomProfileString(String variableName,
                                        String defaultValue)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileStringValue(String, String). The default value is nil.
    
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
    
    defaultValue - Initial value for the variable.
  - registerCustomProfileDate
```
public void registerCustomProfileDate(String variableName,
                                      Date defaultValue)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileDate(String, Date). The default value is nil.
    
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
    
    defaultValue - Initial value for the variable.
  - registerCustomProfileNumber
```
public void registerCustomProfileNumber(String variableName,
                                        int defaultValue)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileNumber(String, double), setCustomProfileNumber(String, float), or setCustomProfileNumber(String, int). You may use these setters interchangeably. The default value is nil.
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
    
    defaultValue - Initial value for the variable.
  - registerCustomProfileNumber
```
public void registerCustomProfileNumber(String variableName,
                                        double defaultValue)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileNumber(String, double), setCustomProfileNumber(String, float), or setCustomProfileNumber(String, int). You may use these setters interchangeably. The default value is nil.
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
    
    defaultValue - Initial value for the variable.
  - registerCustomProfileNumber
```
public void registerCustomProfileNumber(String variableName,
                                        float defaultValue)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileNumber(String, double), setCustomProfileNumber(String, float), or setCustomProfileNumber(String, int). You may use these setters interchangeably. The default value is nil.
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
    
    defaultValue - Initial value for the variable.
  - registerCustomProfileGeolocation
```
public void registerCustomProfileGeolocation(String variableName,
                                             TuneLocation defaultValue)
```
    Register a custom profile variable for this user.
    
    This custom variable will be included in this user's personalization profile, and can be used for segmentation, targeting, and reporting purposes.
    
    Once registered, the value for this variable can be set using setCustomProfileGeolocation(String, TuneLocation). The default value is nil.
    
    This method should be called in your Application class Application.onCreate() method.
    
    Parameters:
    
    variableName - Name of the variable to register for the current user. Valid characters for this name include [0-9],[a-z],[A-Z], -, and _. Any other characters will automatically be stripped out.
    
    defaultValue - Initial value for the variable.
  - setCustomProfileStringValue
```
public void setCustomProfileStringValue(String variableName,
                                        String value)
```
    Set or update the value associated with a custom string profile variable.
    
    This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes.
    
    This can be called from anywhere in your app after the appropriate register call in Application.onCreate().
    
    Parameters:
    
    value - Value to use for the given variable.
    
    variableName - Variable to which this value should be assigned.
  - setCustomProfileDate
```
public void setCustomProfileDate(String variableName,
                                 Date value)
```
    Set or update the value associated with a custom date profile variable.
    
    This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes.
    
    This can be called from anywhere in your app after the appropriate register call in Application.onCreate().
    
    Parameters:
    
    value - Value to use for the given variable.
    
    variableName - Variable to which this value should be assigned.
  - setCustomProfileNumber
```
public void setCustomProfileNumber(String variableName,
                                   int value)
```
    Set or update the value associated with a custom number profile variable.
    
    This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes.
    
    This can be called from anywhere in your app after the appropriate register call in Application.onCreate().
    
    Parameters:
    
    value - Value to use for the given variable.
    
    variableName - Variable to which this value should be assigned.
  - setCustomProfileNumber
```
public void setCustomProfileNumber(String variableName,
                                   double value)
```
    Set or update the value associated with a custom number profile variable.
    
    This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes.
    
    This can be called from anywhere in your app after the appropriate register call in Application.onCreate().
    
    Parameters:
    
    value - Value to use for the given variable.
    
    variableName - Variable to which this value should be assigned.
  - setCustomProfileNumber
```
public void setCustomProfileNumber(String variableName,
                                   float value)
```
    Set or update the value associated with a custom number profile variable.
    
    This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes.
    
    This can be called from anywhere in your app after the appropriate register call in Application.onCreate().
    
    Parameters:
    
    value - Value to use for the given variable.
    
    variableName - Variable to which this value should be assigned.
  - setCustomProfileGeolocation
```
public void setCustomProfileGeolocation(String variableName,
                                        TuneLocation value)
```
    Set or update the value associated with a custom location profile variable.
    
    This new value will be used as part of this user's personalization profile, and will be used from this point forward for segmentation, targeting, and reporting purposes.
    
    This can be called from anywhere in your app after the appropriate register call in Application.onCreate().
    
    Parameters:
    
    value - Value to use for the given variable.
    
    variableName - Variable to which this value should be assigned.
  - getCustomProfileString
```
public String getCustomProfileString(String variableName)
```
    Get the value associated with a custom string profile variable.
    Return the value stored for the custom profile variable. Must be called after the appropriate register call in Application.onCreate().
    This will return null if the variable was registered without a default and has never been set, or if has been explicitly set as null.
    
    Parameters:
    
    variableName - Name of the custom profile variable.
    
    Returns:
    
    Value stored for the variable. It may be null.
  - getCustomProfileDate
```
public Date getCustomProfileDate(String variableName)
```
    Get the value associated with a custom date profile variable.
    Return the value stored for the custom profile variable. Must be called after the appropriate register call in Application.onCreate().
    This will return null if the variable was registered without a default and has never been set, or if has been explicitly set as null.
    
    Parameters:
    
    variableName - Name of the custom profile variable.
    
    Returns:
    
    Value stored for the variable. It may be null.
  - getCustomProfileNumber
```
public Number getCustomProfileNumber(String variableName)
```
    Get the value associated with a custom number profile variable.
    Return the value stored for the custom profile variable. Must be called after the appropriate register call in Application.onCreate().
    This will return null if the variable was registered without a default and has never been set, or if has been explicitly set as null.
    
    Parameters:
    
    variableName - Name of the custom profile variable.
    
    Returns:
    
    Value stored for the variable. It may be null.
  - getCustomProfileGeolocation
```
public TuneLocation getCustomProfileGeolocation(String variableName)
```
    Get the value associated with a custom location profile variable.
    Return the value stored for the custom profile variable. Must be called after the appropriate register call in Application.onCreate().
    This will return null if the variable was registered without a default and has never been set, or if has been explicitly set as null.
    
    Parameters:
    
    variableName - Name of the custom profile variable.
    
    Returns:
    
    Value stored for the variable. It may be null.
  - getAppId
```
public String getAppId()
```
    Returns In-App Marketing's generated app ID value
    
    Returns:
    
    App ID in In-App Marketing, or null if IAM was not enabled
  - clearCustomProfileVariable
```
public void clearCustomProfileVariable(String variableName)
```
    Unset the value for a user profile variable.
    
    Use this method to clear out the value for any custom user profile variable.
    This must be called after the associated register call.
    NOTE: This will not stop the variable from being registered again on the next Application.onCreate().
    
    Parameters:
    
    variableName - Name of the custom profile variable to clear.
  - clearAllCustomProfileVariables
```
public void clearAllCustomProfileVariables()
```
    Clear out all previously specified profile information.
    
    Use this method to clear out all custom profile variables.
    This will only clear out all profile variables that have been registered before this call.
    NOTE: This will not stop the variables from being registered again on the next Application.onCreate().
  - getTuneParams
```
public final TuneParameters getTuneParams()
```
    Returns:
    
    the TuneParameters used to initialize Tune.
  - enableSmartwhere
```
public void enableSmartwhere()
                      throws TuneConfigurationException
```
    Opt-In Smartwhere Integration with the Tune Marketing Console.
    
    Throws:
    
    TuneConfigurationException - if Smartwhere is not available.
  - disableSmartwhere
```
public void disableSmartwhere()
                       throws TuneConfigurationException
```
    Disable Smartwhere Integration.
    
    Throws:
    
    TuneConfigurationException - if Smartwhere is not available.
  - configureSmartwhere
```
public void configureSmartwhere(TuneSmartwhereConfiguration config)
                         throws TuneConfigurationException
```
    Configure Smartwhere using a configuration.
    
    Parameters:
    
    config - TuneSmartwhereConfiguration Configuration
    
    Throws:
    
    TuneConfigurationException - if Smartwhere is not available.

Class Tune

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

networkStateReceiver

mContext

pubQueue

eventQueue

locationListener

params

tuneRequest

initialized

isRegistered

collectLocation

isFirstInstall

timeLastMeasuredSession

Constructor Detail

Tune

Method Detail

getInstance

init

init

init

initAll

isOnline

addEventToQueue

dumpQueue

measureSession

measureSessionInternal

getTimeLastMeasuredSession

measureEvent

measureEvent

measureEvent

makeRequest

invokeUrlFromReferralUrl

updateLocation

getAction

getAdvertiserId

getAge

getAltitude

getAndroidId

getAppAdTrackingEnabled

getAppName

getAppVersion

getConnectionType

getCountryCode

getCurrencyCode

getDeviceBrand

getDeviceBuild

getDeviceCarrier

getDeviceId

getDeviceModel

getExistingUser

getFacebookUserId

getFireAdvertisingId

getFireAdTrackingLimited

getGender

getGoogleAdvertisingId

getGoogleAdTrackingLimited

getGoogleUserId

getInstallDate

getInstallReferrer

getIsPayingUser

getLanguage

getLastOpenLogId

getLatitude

getLocale

getLongitude

getMacAddress

getMatId

getMCC

getMNC

getOpenLogId

getOsVersion

getPackageName

getPluginName

getReferralSource

getReferralUrl