Localytics (android-client-library API)

java.lang.Object
- com.localytics.android.Localytics

```
public class Localytics
extends java.lang.Object
```
All calls to the Localytics library go through this singleton.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Localytics.ImpressionType`
`static class`	`Localytics.InAppMessageDismissButtonLocation` Relative position of the dismiss button for in-app messages.
`static class`	`Localytics.ProfileScope` Possible profile scopes

Field Summary

Fields
Modifier and Type Field and Description

static int LOCATION_PERMISSION_REQUEST_CODE

Fields
Modifier and Type	Field and Description
`static int`	`LOCATION_PERMISSION_REQUEST_CODE`

Constructor Summary

Constructors
Constructor and Description

Localytics()

Constructors
Constructor and Description
`Localytics()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addProfileAttributesToSet(java.lang.String attributeName, java.util.Date[] attributeValue)` Add a set of values to a customer profile attribute, defaulting to the app scope.
`static void`	`addProfileAttributesToSet(java.lang.String attributeName, java.util.Date[] attributeValue, Localytics.ProfileScope scope)` Add a set of values to a customer profile attribute.
`static void`	`addProfileAttributesToSet(java.lang.String attributeName, long[] attributeValue)` Add a set of values to a customer profile attribute, defaulting to the app scope.
`static void`	`addProfileAttributesToSet(java.lang.String attributeName, long[] attributeValue, Localytics.ProfileScope scope)` Add a set of values to a customer profile attribute.
`static void`	`addProfileAttributesToSet(java.lang.String attributeName, java.lang.String[] attributeValue)` Add a set of values to a customer profile attribute, defaulting to the app scope.
`static void`	`addProfileAttributesToSet(java.lang.String attributeName, java.lang.String[] attributeValue, Localytics.ProfileScope scope)` Add a set of values to a customer profile attribute.
`static void`	`appendAdidToInAppUrls(boolean enabled)` Set whether ADID parameter is added to In-App call to action URLs.
`static void`	`appendAdidToInboxUrls(boolean enabled)` Set whether ADID parameter is added to In-App call to action URLs.
`static boolean`	`areNotificationsDisabled()` Deprecated. @see #setNotificationsDisabled(boolean)
`static void`	`autoIntegrate(android.app.Application application)` Integrates Localytics.
`static void`	`clearInAppMessageDisplayActivity()` Opposite from the setInAppMessageDisplayActivity, this method detaches any fragment manager from Localytics.
`static void`	`closeSession()` Closes the Localytics session.
`static void`	`decrementProfileAttribute(java.lang.String attributeName, long decrementValue)` Decrement the value of a customer profile attribute by a specified amount, defaulting to the app scope.
`static void`	`decrementProfileAttribute(java.lang.String attributeName, long decrementValue, Localytics.ProfileScope scope)` Decrement the value of a customer profile attribute by a specified amount.
`static void`	`deleteInboxCampaign(InboxCampaign campaign)` Set an inbox campaign as deleted.
`static void`	`deleteProfileAttribute(java.lang.String attributeName)` Delete a customer profile attribute, defaulting to the app scope.
`static void`	`deleteProfileAttribute(java.lang.String attributeName, Localytics.ProfileScope scope)` Delete a customer profile attribute.
`static void`	`dismissCurrentInAppMessage()` If an in-app message is currently displayed, dismiss it.
`static boolean`	`displayPushNotification(android.os.Bundle data)` Handle displaying a Localytics push notification.
`static void`	`enableLiveDeviceLogging()` Enter live device logging mode.
`static java.util.List<InboxCampaign>`	`getAllInboxCampaigns()` Get all Inbox campaigns.
`static java.lang.String`	`getAppKey()` Get the Localytics app key.
`static java.lang.String`	`getCustomDimension(int dimension)` Get the current value for a given dimension.
`static java.lang.String`	`getCustomerId()` Convenience method to get a customer's id.
`static java.util.List<InboxCampaign>`	`getDisplayableInboxCampaigns()` Get all Inbox campaigns that can be displayed.
`static java.util.List<CircularRegion>`	`getGeofencesToMonitor(double latitude, double longitude)` Get a list of geofences to monitor for enter/exit events
`static java.lang.String`	`getIdentifier(java.lang.String key)` Get the identifier associated with a key.
`static Localytics.InAppMessageDismissButtonLocation`	`getInAppMessageDismissButtonLocation()` Get the relative position of the in-app message dismiss button.
`static int`	`getInboxCampaignsUnreadCount()` Get the count of unread inbox messages
`static MarketingWebViewManager`	`getInboxWebViewManager(java.util.concurrent.Callable<android.app.Activity> activityRetriever)` FOR LOCALYTICS WRAPPER USE ONLY.
`static java.lang.String`	`getInstallId()` Get the app's installation id.
`static java.lang.String`	`getLibraryVersion()` Get the Localytics library version.
`static java.lang.String`	`getLocalAuthenticationToken()` Get the app's local authentication token.
`static java.lang.String`	`getPushRegistrationId()`
`static boolean`	`handleFirebaseMessage(java.util.Map<java.lang.String,java.lang.String> messageData)` Conditionally handles the display of a Firebase remote notification if the message data is determined to be a Localytics message.
`static void`	`handlePushNotificationOpened(android.content.Intent intent)` Handle opening a Localytics push notification.
`static void`	`handleTestMode(android.content.Intent intent)` Handle the intent for push test mode.
`static void`	`inboxListItemTapped(InboxCampaign campaign)` Tell the Localytics SDK that an Inbox campaign was tapped in the list view.
`static void`	`incrementProfileAttribute(java.lang.String attributeName, long incrementValue)` Increment the value of a customer profile attribute by a specified amount, defaulting to the app scope.
`static void`	`incrementProfileAttribute(java.lang.String attributeName, long incrementValue, Localytics.ProfileScope scope)` Increment the value of a customer profile attribute by a specified amount.
`static void`	`integrate(android.content.Context context)` Integrates Localytics and initializes the Handlers.
`static boolean`	`isAdidAppendedToInAppUrls()` Returns whether the ADID parameter is added to In-App call to action URLs
`static boolean`	`isAdidAppendedToInboxUrls()` Returns whether the ADID parameter is added to Inbox call to action URLs
`static boolean`	`isLoggingEnabled()` Check whether the logging is enabled or disabled.
`static boolean`	`isOptedOut()` Get the opted in/out state.
`static boolean`	`isPrivacyOptedOut()` Get the privacy opted in/out state.
`static boolean`	`isTestModeEnabled()` Determine whether the test mode is enabled.
`static void`	`onActivityPause(android.app.Activity activity)` For alternative session management only
`static void`	`onActivityResume(android.app.Activity activity)` For alternative session management only
`static void`	`onNewIntent(android.app.Activity activity, android.content.Intent intent)` Performs the same session management tasks as `onActivityResume(Activity, Intent)` but with the new Intent
`static void`	`openSession()` Opens the Localytics session.
`static void`	`pauseDataUploading(boolean pause)` Halt the uploading of Analytics and Profiles data to the Localytics servers.
`static void`	`redirectLogsToDisk(boolean writeExternally, android.content.Context context)` No production builds should call this method. Enable/Disable log rerouting to a file on disk.
`static void`	`refreshAllInboxCampaigns(InboxRefreshListener callback)` Refresh all Inbox campaigns from the Localytics server.
`static void`	`refreshInboxCampaigns(InboxRefreshListener callback)` Refresh all Inbox campaigns that can be displayed from the Localytics server.
`static void`	`registerPush()` Register app to receive push notifications from Localytics.
`static void`	`removeProfileAttributesFromSet(java.lang.String attributeName, java.util.Date[] attributeValue)` Remove a set of values to a customer profile attribute, defaulting to the app scope.
`static void`	`removeProfileAttributesFromSet(java.lang.String attributeName, java.util.Date[] attributeValue, Localytics.ProfileScope scope)` Remove a set of values to a customer profile attribute.
`static void`	`removeProfileAttributesFromSet(java.lang.String attributeName, long[] attributeValue)` Remove a set of values to a customer profile attribute, defaulting to the app scope.
`static void`	`removeProfileAttributesFromSet(java.lang.String attributeName, long[] attributeValue, Localytics.ProfileScope scope)` Remove a set of values to a customer profile attribute.
`static void`	`removeProfileAttributesFromSet(java.lang.String attributeName, java.lang.String[] attributeValue)` Remove a set of values to a customer profile attribute, defaulting to the app scope.
`static void`	`removeProfileAttributesFromSet(java.lang.String attributeName, java.lang.String[] attributeValue, Localytics.ProfileScope scope)` Remove a set of values to a customer profile attribute.
`static void`	`setAnalyticsListener(AnalyticsListener listener)` Add a listener that will be notified of certain analytics callbacks: `AnalyticsListener.localyticsDidTagEvent(String, java.util.Map, long)` `AnalyticsListener.localyticsSessionWillOpen(boolean, boolean, boolean)` `AnalyticsListener.localyticsSessionDidOpen(boolean, boolean, boolean)` `AnalyticsListener.localyticsSessionWillClose()`
`static void`	`setCallToActionListener(CallToActionListener listener)` Add a listener that will be notified of certain callbacks: `CallToActionListener.localyticsShouldDeeplink(String, Campaign)` `CallToActionListener.localyticsDidOptOut(boolean, Campaign)` `CallToActionListener.localyticsDidPrivacyOptOut(boolean, Campaign)` Note, all methods invoked by this interface will be invoked on the main thread.
`static void`	`setCustomDimension(int dimension, java.lang.String value)` Sets the value of a custom dimension.
`static void`	`setCustomerEmail(java.lang.String email)` Convenience method to set a customer's email as both a profile attribute and as a customer identifier.
`static void`	`setCustomerFirstName(java.lang.String firstName)` Convenience method to set a customer's first name as both a profile attribute and as a customer identifier.
`static void`	`setCustomerFullName(java.lang.String fullName)` Convenience method to set a customer's full name as both a profile attribute and as a customer identifier.
`static void`	`setCustomerId(java.lang.String customerId)` Convenience method to set a customer's id.
`static void`	`setCustomerIdWithPrivacyOptedOut(java.lang.String customerId, boolean optedOut)` Convenience method to set a customer's id.
`static void`	`setCustomerLastName(java.lang.String lastName)` Convenience method to set a customer's last name as both a profile attribute and as a customer identifier.
`static void`	`setIdentifier(java.lang.String key, java.lang.String value)` Record your custom customer data.
`static void`	`setInAppMessageDismissButtonImage(android.content.res.Resources resources, android.graphics.Bitmap image)` Set a bitmap object for user-defined dismiss button display.
`static void`	`setInAppMessageDismissButtonImage(android.content.res.Resources resources, int id)` Set a image associated with a particular resource id for user-defined dismiss button display.
`static void`	`setInAppMessageDismissButtonLocation(Localytics.InAppMessageDismissButtonLocation buttonLocation)` Set the relative position of the in-app message dismiss button.
`static void`	`setInAppMessageDismissButtonVisibility(int visibility)` Set the visibility of the dismiss button.
`static void`	`setInAppMessageDisplayActivity(android.app.Activity activity)` Attach the current foreground activity Localytics.
`static void`	`setInboxCampaignRead(InboxCampaign campaign, boolean read)` Set an inbox campaign as read.
`static void`	`setLocation(android.location.Location location)` Set a user's location.
`static void`	`setLocationListener(LocationListener listener)` Add a listener that will be notified of certain location callbacks: `LocationListener.localyticsDidUpdateLocation(Location)`} `LocationListener.localyticsDidUpdateMonitoredGeofences(List, List)`
`static void`	`setLocationMonitoringEnabled(boolean enabled)` Enable or disable location monitoring for geofence monitoring
`static void`	`setLocationMonitoringEnabled(boolean enabled, boolean persist)` Enable or disable location monitoring for geofence monitoring and allow Localytics to automatically reinitialize Location monitoring on App Launch
`static void`	`setLoggingEnabled(boolean enabled)` Enable/Disable logging.
`static void`	`setMessagingListener(MessagingListenerV2 listener)` Add a listener that will be notified of certain messaging callbacks: `MessagingListenerV2.localyticsDidDisplayInAppMessage()` `MessagingListenerV2.localyticsWillDismissInAppMessage()` `MessagingListenerV2.localyticsDidDismissInAppMessage()` `MessagingListenerV2.localyticsShouldShowInAppMessage(InAppCampaign)`} `MessagingListenerV2.localyticsShouldDelaySessionStartInAppMessages()`} `MessagingListenerV2.localyticsWillDisplayInAppMessage(InAppCampaign, InAppConfiguration)` Note, all methods invoked by this interface will be invoked on the main thread.
`static void`	`setNotificationsDisabled(boolean disable)` Deprecated. This is deprecated in SDK 5.1 so that the standard dimension "notifications enabled" can be directly tied to the OS setting. We recommend using a custom dimension to continue supporting any app-level notification settings.
`static void`	`setOptedOut(boolean newOptOut)` Sets the Localytics opt-out state for this application.
`static void`	`setOption(java.lang.String key, java.lang.Object value)` Customize the behavior of the SDK by setting a custom value for an option.
`static void`	`setOptions(java.util.Map<java.lang.String,java.lang.Object> options)` Customize the behavior of the SDK by setting custom values for various options.
`static void`	`setPrivacyOptedOut(boolean privacyOptedOut)` Sets the Localytics opt-out state for this application.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.util.Date attributeValue)` Set a customer profile attribute, defaulting to the app scope.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.util.Date[] attributeValue)` Set a customer profile attribute, defaulting to the app scope.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.util.Date[] attributeValue, Localytics.ProfileScope scope)` Set a customer profile attribute.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.util.Date attributeValue, Localytics.ProfileScope scope)` Set a customer profile attribute.
`static void`	`setProfileAttribute(java.lang.String attributeName, long attributeValue)` Set a customer profile attribute, defaulting to the app scope.
`static void`	`setProfileAttribute(java.lang.String attributeName, long[] attributeValue)` Set a customer profile attribute, defaulting to the app scope.
`static void`	`setProfileAttribute(java.lang.String attributeName, long[] attributeValue, Localytics.ProfileScope scope)` Set a customer profile attribute.
`static void`	`setProfileAttribute(java.lang.String attributeName, long attributeValue, Localytics.ProfileScope scope)` Set a customer profile attribute.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.lang.String attributeValue)` Set a customer profile attribute, defaulting to the app scope.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.lang.String[] attributeValue)` Set a customer profile attribute, defaulting to the app scope.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.lang.String[] attributeValue, Localytics.ProfileScope scope)` Set a customer profile attribute.
`static void`	`setProfileAttribute(java.lang.String attributeName, java.lang.String attributeValue, Localytics.ProfileScope scope)` Set a customer profile attribute.
`static void`	`setPushRegistrationId(java.lang.String registrationId)` Set the push registration Id which was registered with FCM
`static void`	`setTestModeEnabled(boolean enabled)` Enable/Disable the test mode with the given flag.
`static void`	`tagAddedToCart(java.lang.String itemName, java.lang.String itemId, java.lang.String itemType, java.lang.Long itemPrice, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the addition of a single item to a cart (after the action has occurred)
`static void`	`tagCompletedCheckout(java.lang.Long totalPrice, java.lang.Long itemCount, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the conclusions of the checkout process (after the action has occurred)
`static void`	`tagContentRated(java.lang.String contentName, java.lang.String contentId, java.lang.String contentType, java.lang.Long rating, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the rating of content (after the action has occurred)
`static void`	`tagContentViewed(java.lang.String contentName, java.lang.String contentId, java.lang.String contentType, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the viewing of content (after the action has occurred)
`static void`	`tagCustomerLoggedIn(Customer customer, java.lang.String methodName, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the logging in of a user (after the action has occurred)
`static void`	`tagCustomerLoggedOut(java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the logging out of a user (after the action has occurred)
`static void`	`tagCustomerRegistered(Customer customer, java.lang.String methodName, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the registration of a user (after the action has occurred)
`static void`	`tagEvent(java.lang.String eventName)` Behaves identically to calling `tagEvent(eventName, null, 0)`.
`static void`	`tagEvent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.String> attributes)` Behaves identically to calling `tagEvent(eventName, attributes, 0)`.
`static void`	`tagEvent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.String> attributes, long customerValueIncrease)` Within the currently open session, tags that `event` occurred (with optionally included attributes).
`static void`	`tagInAppImpression(InAppCampaign campaign, Localytics.ImpressionType impressionType)` A standard event to tag an In-App impression
`static void`	`tagInAppImpression(InAppCampaign campaign, java.lang.String customAction)` A standard event to tag an In-App impression.
`static void`	`tagInboxImpression(InboxCampaign campaign, Localytics.ImpressionType impressionType)` A standard event to tag an Inbox impression
`static void`	`tagInboxImpression(InboxCampaign campaign, java.lang.String customAction)` A standard event to tag an Inbox impression.
`static void`	`tagInvited(java.lang.String methodName, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the invitation of a user (after the action has occured)
`static void`	`tagPlacesPushOpened(PlacesCampaign campaign)` A standard event to tag a Places Push Opened.
`static void`	`tagPlacesPushOpened(PlacesCampaign campaign, java.lang.String action)` A standard event to tag a Places Push Opened.
`static void`	`tagPlacesPushReceived(PlacesCampaign campaign)` A standard event to tag a Places Push Received.
`static void`	`tagPurchased(java.lang.String itemName, java.lang.String itemId, java.lang.String itemType, java.lang.Long itemPrice, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag a single item purchase event (after the action has occurred)
`static void`	`tagPushReceivedEvent(android.os.Bundle data)` Handle tagging the Localytics Push Received event.
`static void`	`tagPushReceivedEvent(java.util.Map<java.lang.String,java.lang.String> data)` Handle tagging the Localytics Push Received event.
`static void`	`tagPushToInboxImpression(InboxCampaign campaign)` A standard event to tag a Push to Inbox impression.
`static void`	`tagScreen(java.lang.String screen)` Note: This implementation will perform duplicate suppression on two identical screen events that occur in a row within a single session.
`static void`	`tagSearched(java.lang.String queryText, java.lang.String contentType, java.lang.Long resultCount, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag a search event (after the action has occurred)
`static void`	`tagShared(java.lang.String contentName, java.lang.String contentId, java.lang.String contentType, java.lang.String methodName, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag a share event (after the action has occurred)
`static void`	`tagStartedCheckout(java.lang.Long totalPrice, java.lang.Long itemCount, java.util.Map<java.lang.String,java.lang.String> attributes)` A standard event to tag the start of the checkout process (after the action has occurred)
`static void`	`triggerInAppMessage(java.lang.String triggerName)` Trigger an in-app message
`static void`	`triggerInAppMessage(java.lang.String triggerName, java.util.Map<java.lang.String,java.lang.String> attributes)` Trigger an in-app message
`static void`	`triggerInAppMessagesForSessionStart()` Trigger campaigns as if a Session Start event had just occurred.
`static void`	`triggerPlacesNotification(long campaignId, java.lang.String regionId)` Trigger a places notification for the given campaign id
`static void`	`triggerPlacesNotification(PlacesCampaign campaign)` Trigger a places notification for the given campaign
`static void`	`triggerRegion(Region region, Region.Event event, android.location.Location location)` Trigger a region with a certain event and location.
`static void`	`triggerRegions(java.util.List<Region> regions, Region.Event event, android.location.Location location)` Trigger a list of regions with a certain event and location.
`static void`	`upload()` Initiates an upload of all Localytics data.

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

- Field Detail
  - LOCATION_PERMISSION_REQUEST_CODE
```
public static final int LOCATION_PERMISSION_REQUEST_CODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Localytics
```
public Localytics()
```
- Method Detail
  - integrate
```
public static void integrate(@NonNull
                             android.content.Context context)
```
    Integrates Localytics and initializes the Handlers.
    
    Parameters:
    
    context - The context used to access resources on behalf of the app. Cannot be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if context is an Activity context or null, if ll_app_key in localytics.xml is null or empty, or if PushReceiver is declared in AndroidManifest.xml but PushTrackingActivity isn't declared
  - autoIntegrate
```
public static void autoIntegrate(@NonNull
                                 android.app.Application application)
```
    Integrates Localytics.
    
    Parameters:
    
    application - The app's application object. Cannot be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if application is null, or if ll_app_key in localytics.xml is null or empty.
  - upload
```
public static void upload()
```
    Initiates an upload of all Localytics data. This should be done early in the process life in order to guarantee as much time as possible for slow connections to complete. It is necessary to do this even if the user has opted out because this is how the opt out is transported to the webservice.
  - pauseDataUploading
```
public static void pauseDataUploading(boolean pause)
```
    Halt the uploading of Analytics and Profiles data to the Localytics servers. Re-enabling the upload of data will cause an immediate upload.
    
    Parameters:
    
    pause - if set to true, all data uploading will be halted. If false, data uploading will resume as normal.
  - setOptedOut
```
public static void setOptedOut(boolean newOptOut)
```
    Sets the Localytics opt-out state for this application. This call is not necessary and is provided for people who wish to allow their users the ability to opt out of data collection. It can be called at any time. Passing true causes all further data collection to stop, and an opt-out event to be sent to the server so the user's data is removed from the charts.
    There are very serious implications to the quality of your data when providing an opt out option. For example, users who have opted out will appear as never returning, causing your new/returning chart to skew.
    If two instances of the same application are running, and one is opted in and the second opts out, the first will also become opted out, and neither will collect any more data.
    If a session was started while the app was opted out, the session open event has already been lost. For this reason, all sessions started while opted out will not collect data even after the user opts back in or else it taints the comparisons of session lengths and other metrics.
    
    Parameters:
    
    newOptOut - True if the user should be be opted out, halting further data collection
    
    See Also:
    
    isOptedOut()
  - setPrivacyOptedOut
```
public static void setPrivacyOptedOut(boolean privacyOptedOut)
```
    Sets the Localytics opt-out state for this application. This call is not necessary and is provided for people who wish to allow their users the ability to opt out of data collection. It can be called at any time. Passing true causes all further data collection to stop, and an opt-out event to be sent to the server so the user's data is removed from the charts.
    Additionally, a profile attribute will be set causing a deletion of data request to be made for Localytics in line with the GDPR standard. There are very serious implications to the quality of your data when providing an opt out option. For example, users who have opted out will appear as never returning, causing your new/returning chart to skew.
    As a side effect of protecting a user's data, the SDK will internally ensure that ADID's are no longer appended to the url's of In-App and Inbox call to action links.
    
    Parameters:
    
    privacyOptedOut - True if the user should be privacy opted out and have all his Localytics data deleted.
    
    See Also:
    
    setOptedOut(boolean), isPrivacyOptedOut()
  - isOptedOut
```
public static boolean isOptedOut()
```
    Get the opted in/out state.
    
    Returns:
    
    True if opted out; false otherwise.
    
    See Also:
    
    setOptedOut(boolean)
  - isPrivacyOptedOut
```
public static boolean isPrivacyOptedOut()
```
    Get the privacy opted in/out state.
    
    Returns:
    
    True if privacy opted out; false otherwise.
    
    See Also:
    
    setPrivacyOptedOut(boolean)
  - openSession
```
public static void openSession()
```
    Opens the Localytics session. The session should be opened before tagEvent(String), tagEvent(String, java.util.Map), tagEvent(String, java.util.Map), or tagScreen(String) are called.
    If a new session is opened shortly--within a few seconds--after an earlier session is closed, Localytics will reconnect to the previous session (effectively causing the previous close to be ignored). This ensures that as a user moves from Activity to Activity in an app, that is considered a single session. When a session is reconnected, the customDimensions for the initial open are kept and dimensions for the second open are ignored.
    If for any reason open is called more than once without an intervening call to closeSession(), subsequent calls to open will be ignored.
  - closeSession
```
public static void closeSession()
```
    Closes the Localytics session. Once a session has been opened via openSession(), close the session when data collection is complete.
    If close is called without open having ever been called, the close has no effect. Similarly, once a session is closed, subsequent calls to close will be ignored.
  - tagEvent
```
public static void tagEvent(java.lang.String eventName)
```
    Behaves identically to calling tagEvent(eventName, null, 0).
    
    Parameters:
    
    eventName - The name of the event which occurred. Cannot be null or empty string.
    
    Throws:
    
    java.lang.IllegalArgumentException - if eventName is null.
    
    java.lang.IllegalArgumentException - if eventName is empty.
    
    See Also:
    
    tagEvent(String, java.util.Map, long)
  - tagEvent
```
public static void tagEvent(java.lang.String eventName,
                            java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Behaves identically to calling tagEvent(eventName, attributes, 0).
    
    Parameters:
    
    eventName - The name of the event which occurred. Cannot be null or empty string.
    
    attributes - The collection of attributes for this particular event. If this parameter is null or empty, then calling this method has the same effect as calling tagEvent(String). This parameter may not contain null or empty keys or values.
    
    Throws:
    
    java.lang.IllegalArgumentException - if eventName is null.
    
    java.lang.IllegalArgumentException - if eventName is empty.
    
    java.lang.IllegalArgumentException - if attributes contains null keys, empty keys, null values, or empty values.
    
    See Also:
    
    tagEvent(String, java.util.Map, long)
  - tagEvent
```
public static void tagEvent(java.lang.String eventName,
                            java.util.Map<java.lang.String,java.lang.String> attributes,
                            long customerValueIncrease)
```
    Within the currently open session, tags that event occurred (with optionally included attributes).
    
    Attributes: Additional key/value pairs with data related to an event. For example, let's say your app displays a dialog with two buttons: OK and Cancel. When the user clicks on one of the buttons, the event might be "button clicked." The attribute key might be "button_label" and the value would either be "OK" or "Cancel" depending on which button was clicked.
    Best Practices
    - DO NOT use events, attributes, or dimensions to record personally identifiable information.
    - The best way to use events is to create all the event strings as predefined constants and only use those. This is more efficient and removes the risk of collecting personal information.
    - Do not tag events inside loops or any other place which gets called frequently. This can cause a lot of data to be stored and uploaded.
    Parameters:
    
    eventName - The name of the event which occurred. Cannot be null or empty string.
    
    attributes - The collection of attributes for this particular event. If this parameter is null or empty, then no attributes are recorded and the behavior with respect to attributes is like simply calling tagEvent(String). This parameter may not contain null or empty keys or values.
    
    customerValueIncrease - Added to customer lifetime value. Try to use lowest possible unit, such as cents for US currency.
    
    Throws:
    
    java.lang.IllegalArgumentException - if eventName is null.
    
    java.lang.IllegalArgumentException - if eventName is empty.
    
    java.lang.IllegalArgumentException - if attributes contains null keys, empty keys, null values, or empty values.
  - tagPurchased
```
public static void tagPurchased(@Nullable
                                java.lang.String itemName,
                                @Nullable
                                java.lang.String itemId,
                                @Nullable
                                java.lang.String itemType,
                                @Nullable
                                java.lang.Long itemPrice,
                                @Nullable
                                java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag a single item purchase event (after the action has occurred)
    
    Parameters:
    
    itemName - The name of the item purchased (optional, can be null)
    
    itemId - A unique identifier of the item being purchased, such as a SKU (optional, can be null)
    
    itemType - The type of item (optional, can be null)
    
    itemPrice - The price of the item (optional, can be null). Will be added to customer lifetime value. Try to use lowest possible unit, such as cents for US currency.
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagAddedToCart
```
public static void tagAddedToCart(@Nullable
                                  java.lang.String itemName,
                                  @Nullable
                                  java.lang.String itemId,
                                  @Nullable
                                  java.lang.String itemType,
                                  @Nullable
                                  java.lang.Long itemPrice,
                                  @Nullable
                                  java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the addition of a single item to a cart (after the action has occurred)
    
    Parameters:
    
    itemName - The name of the item purchased (optional, can be null)
    
    itemId - A unique identifier of the item being purchased, such as a SKU (optional, can be null)
    
    itemType - The type of item (optional, can be null)
    
    itemPrice - The price of the item (optional, can be null). Will NOT be added to customer lifetime value.
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagStartedCheckout
```
public static void tagStartedCheckout(@Nullable
                                      java.lang.Long totalPrice,
                                      @Nullable
                                      java.lang.Long itemCount,
                                      @Nullable
                                      java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the start of the checkout process (after the action has occurred)
    
    Parameters:
    
    totalPrice - The total price of all the items in the cart (optional, can be null). Will NOT be added to customer lifetime value.
    
    itemCount - Total count of items in the cart (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagCompletedCheckout
```
public static void tagCompletedCheckout(@Nullable
                                        java.lang.Long totalPrice,
                                        @Nullable
                                        java.lang.Long itemCount,
                                        @Nullable
                                        java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the conclusions of the checkout process (after the action has occurred)
    
    Parameters:
    
    totalPrice - The total price of all the items in the cart (optional, can be null). Will be added to customer lifetime value. Try to use lowest possible unit, such as cents for US currency.
    
    itemCount - Total count of items in the cart (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagContentViewed
```
public static void tagContentViewed(@Nullable
                                    java.lang.String contentName,
                                    @Nullable
                                    java.lang.String contentId,
                                    @Nullable
                                    java.lang.String contentType,
                                    @Nullable
                                    java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the viewing of content (after the action has occurred)
    
    Parameters:
    
    contentName - The name of the content being viewed (such as article name) (optional, can be null)
    
    contentId - A unique identifier of the content being viewed (optional, can be null)
    
    contentType - The type of content (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagSearched
```
public static void tagSearched(@Nullable
                               java.lang.String queryText,
                               @Nullable
                               java.lang.String contentType,
                               @Nullable
                               java.lang.Long resultCount,
                               @Nullable
                               java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag a search event (after the action has occurred)
    
    Parameters:
    
    queryText - The query user for the search (optional, can be null)
    
    contentType - The type of content (optional, can be null)
    
    resultCount - The number of results returned by the query (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagShared
```
public static void tagShared(@Nullable
                             java.lang.String contentName,
                             @Nullable
                             java.lang.String contentId,
                             @Nullable
                             java.lang.String contentType,
                             @Nullable
                             java.lang.String methodName,
                             @Nullable
                             java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag a share event (after the action has occurred)
    
    Parameters:
    
    contentName - The name of the content being viewed (such as article name) (optional, can be null)
    
    contentId - A unique identifier of the content being viewed (optional, can be null)
    
    contentType - The type of content (optional, can be null)
    
    methodName - The method by which the content was shared such as Twitter, Facebook, Native (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagContentRated
```
public static void tagContentRated(@Nullable
                                   java.lang.String contentName,
                                   @Nullable
                                   java.lang.String contentId,
                                   @Nullable
                                   java.lang.String contentType,
                                   @Nullable
                                   java.lang.Long rating,
                                   @Nullable
                                   java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the rating of content (after the action has occurred)
    
    Parameters:
    
    contentName - The name of the content being viewed (such as article name) (optional, can be null)
    
    contentId - A unique identifier of the content being viewed (optional, can be null)
    
    contentType - The type of content (optional, can be null)
    
    rating - A rating of the content (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagCustomerRegistered
```
public static void tagCustomerRegistered(@Nullable
                                         Customer customer,
                                         @Nullable
                                         java.lang.String methodName,
                                         @Nullable
                                         java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the registration of a user (after the action has occurred)
    
    Parameters:
    
    customer - An object providing information about the customer that registered (optional, can be null)
    
    methodName - The method by which the user was registered such as Twitter, Facebook, Native (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagCustomerLoggedIn
```
public static void tagCustomerLoggedIn(@Nullable
                                       Customer customer,
                                       @Nullable
                                       java.lang.String methodName,
                                       @Nullable
                                       java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the logging in of a user (after the action has occurred)
    
    Parameters:
    
    customer - An object providing information about the customer that logged in (optional, can be null)
    
    methodName - The method by which the user was logged in such as Twitter, Facebook, Native (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagCustomerLoggedOut
```
public static void tagCustomerLoggedOut(@Nullable
                                        java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the logging out of a user (after the action has occurred)
    
    Parameters:
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagInvited
```
public static void tagInvited(@Nullable
                              java.lang.String methodName,
                              @Nullable
                              java.util.Map<java.lang.String,java.lang.String> attributes)
```
    A standard event to tag the invitation of a user (after the action has occured)
    
    Parameters:
    
    methodName - The method by which the user was invited such as Twitter, Facebook, Native (optional, can be null)
    
    attributes - Any additional attributes to attach to this event (optional, can be null)
  - tagInAppImpression
```
public static void tagInAppImpression(@NonNull
                                      InAppCampaign campaign,
                                      @NonNull
                                      Localytics.ImpressionType impressionType)
```
    A standard event to tag an In-App impression
    
    Parameters:
    
    campaign - The In-App campaign for which to tag an impression
    
    impressionType - an enum of CLICK or DISMISS
  - tagInAppImpression
```
public static void tagInAppImpression(@NonNull
                                      InAppCampaign campaign,
                                      @NonNull
                                      java.lang.String customAction)
```
    A standard event to tag an In-App impression. This method should be used when the standard methods are not intended. If a standard impression is desirable use tagInAppImpression(InAppCampaign, ImpressionType) Any String value passed in that is not equal to 'X' will result in a click on the dashboard. If an empty String is passed in, a dismiss impression will be tagged.
    
    Parameters:
    
    campaign - The In-App campaign for which to tag an impression
    
    customAction - a string to tag the impression with.
  - tagInboxImpression
```
public static void tagInboxImpression(@NonNull
                                      InboxCampaign campaign,
                                      @NonNull
                                      Localytics.ImpressionType impressionType)
```
    A standard event to tag an Inbox impression
    
    Parameters:
    
    campaign - The inbox campaign for which to tag an impression
    
    impressionType - an enum of CLICK or DISMISS
  - tagInboxImpression
```
public static void tagInboxImpression(@NonNull
                                      InboxCampaign campaign,
                                      @NonNull
                                      java.lang.String customAction)
```
    A standard event to tag an Inbox impression. This method should be used when the standard methods are not intended. If a standard impression is desirable use tagInboxImpression(InboxCampaign, ImpressionType) Any String value passed in that is not equal to 'X' will result in a click on the dashboard. If an empty String is passed in, a dismiss impression will be tagged.
    
    Parameters:
    
    campaign - The inbox campaign for which to tag an impression
    
    customAction - a string to tag the impression with.
  - tagPushToInboxImpression
```
public static void tagPushToInboxImpression(@NonNull
                                            InboxCampaign campaign)
```
    A standard event to tag a Push to Inbox impression.
    
    Parameters:
    
    campaign - The inbox campaign for which to tag an impression
  - tagPlacesPushReceived
```
public static void tagPlacesPushReceived(@NonNull
                                         PlacesCampaign campaign)
```
    A standard event to tag a Places Push Received.
    Standard integrations should not require this method. Rather it should only be used if standard places triggering is suppressed in favor of custom logic.
    
    Parameters:
    
    campaign - The Places campaign for which to tag an event
  - tagPlacesPushOpened
```
public static void tagPlacesPushOpened(@NonNull
                                       PlacesCampaign campaign)
```
    A standard event to tag a Places Push Opened.
    Standard integrations should not require this method. Rather it should only be used if standard places triggering is suppressed in favor of custom logic.
    
    Parameters:
    
    campaign - The Places campaign for which to tag an event
  - tagPlacesPushOpened
```
public static void tagPlacesPushOpened(@NonNull
                                       PlacesCampaign campaign,
                                       @Nullable
                                       java.lang.String action)
```
    A standard event to tag a Places Push Opened.
    Standard integrations should not require this method. Rather it should only be used if standard places triggering is suppressed in favor of custom logic.
    
    Parameters:
    
    campaign - The Places campaign for which to tag an event
    
    action - The title of the button that was pressed. This property will be passed as the value of the 'Action' attribute ('Click' will be used if null).
  - triggerPlacesNotification
```
public static void triggerPlacesNotification(@NonNull
                                             PlacesCampaign campaign)
```
    Trigger a places notification for the given campaign
    
    Parameters:
    
    campaign - The Places campaign for which to trigger a notification
  - triggerPlacesNotification
```
public static void triggerPlacesNotification(long campaignId,
                                             @NonNull
                                             java.lang.String regionId)
```
    Trigger a places notification for the given campaign id
    
    Parameters:
    
    campaignId - The Places campaign id for which to trigger a notification
    
    regionId - The unique region id which triggered the Places Campaign.
  - tagScreen
```
public static void tagScreen(java.lang.String screen)
```
    Note: This implementation will perform duplicate suppression on two identical screen events that occur in a row within a single session. For example, in the set of screens {"Screen 1", "Screen 1"} the second screen would be suppressed. However in the set {"Screen 1", "Screen 2", "Screen 1"}, no duplicate suppression would occur.
    
    Parameters:
    
    screen - Name of the screen that was entered. Cannot be null or the empty string.
    
    Throws:
    
    java.lang.IllegalArgumentException - if screen is null.
    
    java.lang.IllegalArgumentException - if screen is empty.
  - setCustomDimension
```
public static void setCustomDimension(int dimension,
                                      java.lang.String value)
```
    Sets the value of a custom dimension. Custom dimensions are dimensions which contain user defined data unlike the predefined dimensions such as carrier, model, and country. Once a value for a custom dimension is set, the device it was set on will continue to upload that value until the value is changed. To clear a value pass null as the value. The proper use of custom dimensions involves defining a dimension with less than ten distinct possible values and assigning it to one of the four available custom dimensions. Once assigned this definition should never be changed without changing the App Key otherwise old installs of the application will pollute new data.
    
    Parameters:
    
    dimension - A dimension between 0 and 9.
    
    value - The value to set for the given dimension.
    
    Throws:
    
    java.lang.IllegalArgumentException - if dimension is not between 0 and 9.
    
    See Also:
    
    getCustomDimension(int)
  - getCustomDimension
```
public static java.lang.String getCustomDimension(int dimension)
```
    Get the current value for a given dimension.
    
    Parameters:
    
    dimension - A dimension between 0 and 9.
    
    Returns:
    
    The current value for the given dimension.
    
    See Also:
    
    setCustomDimension(int, String)
  - setAnalyticsListener
```
public static void setAnalyticsListener(@Nullable
                                        AnalyticsListener listener)
```
    Add a listener that will be notified of certain analytics callbacks:
    Parameters:
    
    listener - The object that will receive the callbacks. Pass in null to remove an existing listener.
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       long attributeValue,
                                       Localytics.ProfileScope scope)
```
    Set a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       long attributeValue)
```
    Set a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       long[] attributeValue,
                                       Localytics.ProfileScope scope)
```
    Set a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute values (cannot be null).
    
    scope - The scope of the attribute.
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       long[] attributeValue)
```
    Set a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.lang.String attributeValue,
                                       Localytics.ProfileScope scope)
```
    Set a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.lang.String attributeValue)
```
    Set a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.lang.String[] attributeValue,
                                       Localytics.ProfileScope scope)
```
    Set a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.lang.String[] attributeValue)
```
    Set a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.util.Date attributeValue,
                                       Localytics.ProfileScope scope)
```
    Set a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.util.Date attributeValue)
```
    Set a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.util.Date[] attributeValue,
                                       Localytics.ProfileScope scope)
```
    Set a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - setProfileAttribute
```
public static void setProfileAttribute(java.lang.String attributeName,
                                       java.util.Date[] attributeValue)
```
    Set a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - addProfileAttributesToSet
```
public static void addProfileAttributesToSet(java.lang.String attributeName,
                                             long[] attributeValue,
                                             Localytics.ProfileScope scope)
```
    Add a set of values to a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - addProfileAttributesToSet
```
public static void addProfileAttributesToSet(java.lang.String attributeName,
                                             long[] attributeValue)
```
    Add a set of values to a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - addProfileAttributesToSet
```
public static void addProfileAttributesToSet(java.lang.String attributeName,
                                             java.lang.String[] attributeValue,
                                             Localytics.ProfileScope scope)
```
    Add a set of values to a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - addProfileAttributesToSet
```
public static void addProfileAttributesToSet(java.lang.String attributeName,
                                             java.lang.String[] attributeValue)
```
    Add a set of values to a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - addProfileAttributesToSet
```
public static void addProfileAttributesToSet(java.lang.String attributeName,
                                             java.util.Date[] attributeValue,
                                             Localytics.ProfileScope scope)
```
    Add a set of values to a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - addProfileAttributesToSet
```
public static void addProfileAttributesToSet(java.lang.String attributeName,
                                             java.util.Date[] attributeValue)
```
    Add a set of values to a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - removeProfileAttributesFromSet
```
public static void removeProfileAttributesFromSet(java.lang.String attributeName,
                                                  long[] attributeValue,
                                                  Localytics.ProfileScope scope)
```
    Remove a set of values to a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - removeProfileAttributesFromSet
```
public static void removeProfileAttributesFromSet(java.lang.String attributeName,
                                                  long[] attributeValue)
```
    Remove a set of values to a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - removeProfileAttributesFromSet
```
public static void removeProfileAttributesFromSet(java.lang.String attributeName,
                                                  java.lang.String[] attributeValue,
                                                  Localytics.ProfileScope scope)
```
    Remove a set of values to a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - removeProfileAttributesFromSet
```
public static void removeProfileAttributesFromSet(java.lang.String attributeName,
                                                  java.lang.String[] attributeValue)
```
    Remove a set of values to a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - removeProfileAttributesFromSet
```
public static void removeProfileAttributesFromSet(java.lang.String attributeName,
                                                  java.util.Date[] attributeValue,
                                                  Localytics.ProfileScope scope)
```
    Remove a set of values to a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
    
    scope - The scope of the attribute.
  - removeProfileAttributesFromSet
```
public static void removeProfileAttributesFromSet(java.lang.String attributeName,
                                                  java.util.Date[] attributeValue)
```
    Remove a set of values to a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    attributeValue - The attribute value (cannot be null).
  - incrementProfileAttribute
```
public static void incrementProfileAttribute(java.lang.String attributeName,
                                             long incrementValue,
                                             Localytics.ProfileScope scope)
```
    Increment the value of a customer profile attribute by a specified amount.
    
    Parameters:
    
    attributeName - The attribute name.
    
    incrementValue - The amount by which to increment the value.
    
    scope - The scope of the attribute.
  - incrementProfileAttribute
```
public static void incrementProfileAttribute(java.lang.String attributeName,
                                             long incrementValue)
```
    Increment the value of a customer profile attribute by a specified amount, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    incrementValue - The amount by which to increment the value.
  - decrementProfileAttribute
```
public static void decrementProfileAttribute(java.lang.String attributeName,
                                             long decrementValue,
                                             Localytics.ProfileScope scope)
```
    Decrement the value of a customer profile attribute by a specified amount.
    
    Parameters:
    
    attributeName - The attribute name.
    
    decrementValue - The amount by which to decrement the value.
    
    scope - The scope of the attribute.
  - decrementProfileAttribute
```
public static void decrementProfileAttribute(java.lang.String attributeName,
                                             long decrementValue)
```
    Decrement the value of a customer profile attribute by a specified amount, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
    
    decrementValue - The amount by which to decrement the value.
  - deleteProfileAttribute
```
public static void deleteProfileAttribute(java.lang.String attributeName,
                                          Localytics.ProfileScope scope)
```
    Delete a customer profile attribute.
    
    Parameters:
    
    attributeName - The attribute name.
    
    scope - The scope of the attribute.
  - deleteProfileAttribute
```
public static void deleteProfileAttribute(java.lang.String attributeName)
```
    Delete a customer profile attribute, defaulting to the app scope.
    
    Parameters:
    
    attributeName - The attribute name.
  - setCustomerEmail
```
public static void setCustomerEmail(java.lang.String email)
```
    Convenience method to set a customer's email as both a profile attribute and as a customer identifier. Attribute is org-scoped.
    
    Parameters:
    
    email - Customer's email
  - setCustomerFirstName
```
public static void setCustomerFirstName(java.lang.String firstName)
```
    Convenience method to set a customer's first name as both a profile attribute and as a customer identifier. Attribute is org-scoped.
    
    Parameters:
    
    firstName - Customer's first name
  - setCustomerLastName
```
public static void setCustomerLastName(java.lang.String lastName)
```
    Convenience method to set a customer's last name as both a profile attribute and as a customer identifier. Attribute is org-scoped.
    
    Parameters:
    
    lastName - Customer's last name
  - setCustomerFullName
```
public static void setCustomerFullName(java.lang.String fullName)
```
    Convenience method to set a customer's full name as both a profile attribute and as a customer identifier. Attribute is org-scoped.
    
    Parameters:
    
    fullName - Customer's full name
  - setInAppMessageDisplayActivity
```
public static void setInAppMessageDisplayActivity(android.app.Activity activity)
```
    Attach the current foreground activity Localytics. The fragment manager associated with each activity is needed for showing the dialog fragment which hosts the marketing dialog. This method gets the fragment manager from the input activity and attaches it with the marketing handler which controls the marketing trigger.
    
    Parameters:
    
    activity - The foreground activity, must not be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if activity is null.
    
    See Also:
    
    clearInAppMessageDisplayActivity()
  - clearInAppMessageDisplayActivity
```
public static void clearInAppMessageDisplayActivity()
```
    Opposite from the setInAppMessageDisplayActivity, this method detaches any fragment manager from Localytics.
    
    See Also:
    
    setInAppMessageDisplayActivity(android.app.Activity)
  - triggerInAppMessage
```
public static void triggerInAppMessage(java.lang.String triggerName)
```
    Trigger an in-app message
    
    Parameters:
    
    triggerName - The name of the in-app message trigger
  - triggerInAppMessagesForSessionStart
```
public static void triggerInAppMessagesForSessionStart()
```
    Trigger campaigns as if a Session Start event had just occurred.
    This is useful for integrations that want to delay presentation of startup campaigns due to some startup state, such as a splash screen. In order to delay the triggering, implement MessagingListenerV2 and respond appropriately to MessagingListenerV2.localyticsShouldDelaySessionStartInAppMessages(). Finally, once the start up state has cleared, call this method to trigger in-app campaigns as if a session had just been started.
  - triggerInAppMessage
```
public static void triggerInAppMessage(java.lang.String triggerName,
                                       java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Trigger an in-app message
    
    Parameters:
    
    triggerName - The name of the in-app message trigger
    
    attributes - The attributes associated with the in-app triggering event
  - dismissCurrentInAppMessage
```
public static void dismissCurrentInAppMessage()
```
    If an in-app message is currently displayed, dismiss it. Is a no-op otherwise.
  - registerPush
```
public static void registerPush()
```
    Register app to receive push notifications from Localytics.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if com.google.firebase:firebase-messaging is excluded from the app.
  - getPushRegistrationId
```
public static java.lang.String getPushRegistrationId()
```
    Returns:
    
    The push registration Id once the app has registered with FCM.
  - setPushRegistrationId
```
public static void setPushRegistrationId(java.lang.String registrationId)
```
    Set the push registration Id which was registered with FCM
    
    Parameters:
    
    registrationId - The FCM registration Id
  - setNotificationsDisabled
```
@Deprecated
public static void setNotificationsDisabled(boolean disable)
```
    Deprecated. This is deprecated in SDK 5.1 so that the standard dimension "notifications enabled" can be directly tied to the OS setting. We recommend using a custom dimension to continue supporting any app-level notification settings.
    
    Enable or disable the app from receiving push notifications from Localytics. Should be called only after registerPush() has been called. This is typically used for app-level notification settings, since for Android 4.4+ this is populated with the OS-level settings from the support library.
    
    Parameters:
    
    disable - Boolean flag to enable or disable push notifications. Note that true value disables push while a false value enables it.
    
    See Also:
    
    areNotificationsDisabled()
  - areNotificationsDisabled
```
@Deprecated
public static boolean areNotificationsDisabled()
```
    Deprecated. @see #setNotificationsDisabled(boolean)
    
    Get the push disabled/enabled state. This is the OS-level settings for Android 4.4+ unless it has been set with setNotificationsDisabled(boolean).
    
    Returns:
    
    Boolean indicating whether Localytics push notifications have been disabled.
  - handlePushNotificationOpened
```
public static void handlePushNotificationOpened(android.content.Intent intent)
```
    Handle opening a Localytics push notification.
    
    Parameters:
    
    intent - The Intent of the push notification.
  - handleFirebaseMessage
```
public static boolean handleFirebaseMessage(java.util.Map<java.lang.String,java.lang.String> messageData)
```
    Conditionally handles the display of a Firebase remote notification if the message data is determined to be a Localytics message. Will return true if the message was handled, and false otherwise. A return of false indicates a non-Localytics message that should be handled by the calling application.
    
    Parameters:
    
    messageData - The data map derived from com.google.firebase.messaging.RemoteMessage.getData()
    
    Returns:
    
    true if the message was handled as a Localytics push message, false otherwise
  - tagPushReceivedEvent
```
public static void tagPushReceivedEvent(android.os.Bundle data)
```
    Handle tagging the Localytics Push Received event. Use this method if you use your own BroadcastReceiver or Service (and not the Localytics FirebaseTokenService. Pass the RemoteMessage.getData() delivered to FirebaseMessagingService.onMessageReceived(RemoteMessage) to this method to tag the 'Localytics Push Received' event.
    
    Parameters:
    
    data - The Bundle of the push notification.
  - tagPushReceivedEvent
```
public static void tagPushReceivedEvent(java.util.Map<java.lang.String,java.lang.String> data)
```
    Handle tagging the Localytics Push Received event. Use this method if you use your own FirebaseMessagingService (and not the Localytics FirebaseService or handleFirebaseMessage(Map) method). Pass the RemoteMessage.getData() delivered to FirebaseMessagingService.onMessageReceived(com.google.firebase.messaging.RemoteMessage) to this method to tag the 'Localytics Push Received' event.
    
    Parameters:
    
    data - The data of the push notification retrieved by calling RemoteMessage.getData().
  - displayPushNotification
```
public static boolean displayPushNotification(android.os.Bundle data)
```
    Handle displaying a Localytics push notification.
    
    Parameters:
    
    data - The Bundle of the push notification.
    
    Returns:
    
    true if the message was handled as a Localytics push message, false otherwise
  - handleTestMode
```
public static void handleTestMode(android.content.Intent intent)
```
    Handle the intent for push test mode. User can define the correct intent filter in the Manifest.xml file so when they got the mail from Localytics they can enable the marketing test mode or test the marketing push immediately.
    
    Parameters:
    
    intent - The same intent object from activity's getIntent method. The intent contains params for push test mode. Cannot be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if intent is null.
  - setTestModeEnabled
```
public static void setTestModeEnabled(boolean enabled)
```
    Enable/Disable the test mode with the given flag. If the user is not in the test mode, all marketing-message dialogs will not show once and the information to show the dialog will be deleted after the dialog is closed. In test mode, the information will never be deleted so the same marketing-message dialog will always show under the right condition.
    
    Parameters:
    
    enabled - Flag to indicate whether to enable the test mode or not.
    
    See Also:
    
    isTestModeEnabled()
  - isTestModeEnabled
```
public static boolean isTestModeEnabled()
```
    Determine whether the test mode is enabled.
    
    Returns:
    
    true if the test mode is enabled, otherwise false.
    
    See Also:
    
    setTestModeEnabled(boolean)
  - enableLiveDeviceLogging
```
public static void enableLiveDeviceLogging()
```
    Enter live device logging mode.
  - setInAppMessageDismissButtonImage
```
public static void setInAppMessageDismissButtonImage(android.content.res.Resources resources,
                                                     @DrawableRes
                                                     int id)
```
    Set a image associated with a particular resource id for user-defined dismiss button display.
    
    Parameters:
    
    resources - The Resources instance for your application's package.
    
    id - The image resource id for the close button appearance.
  - setInAppMessageDismissButtonImage
```
public static void setInAppMessageDismissButtonImage(android.content.res.Resources resources,
                                                     android.graphics.Bitmap image)
```
    Set a bitmap object for user-defined dismiss button display.
    
    Parameters:
    
    resources - The Resources instance for your application's package.
    
    image - The bitmap object for the close button appearance.
  - setInAppMessageDismissButtonVisibility
```
public static void setInAppMessageDismissButtonVisibility(int visibility)
```
    Set the visibility of the dismiss button.
    
    Parameters:
    
    visibility - The visibility state of the dismiss button
    
    See Also:
    
    View.setVisibility(int)
  - setMessagingListener
```
public static void setMessagingListener(@Nullable
                                        MessagingListenerV2 listener)
```
    Add a listener that will be notified of certain messaging callbacks:
    Note, all methods invoked by this interface will be invoked on the main thread. As a result, please ensure that no calls perform any blocking operations.
    Parameters:
    
    listener - The object that will receive the callbacks. Pass in null to remove an existing listener.
  - setCallToActionListener
```
public static void setCallToActionListener(@Nullable
                                           CallToActionListener listener)
```
    Add a listener that will be notified of certain callbacks:
    Note, all methods invoked by this interface will be invoked on the main thread. As a result, please ensure that no calls perform any blocking operations.
    Parameters:
    
    listener - The object that will receive the callbacks. Pass in null to remove an existing listener.
  - appendAdidToInAppUrls
```
public static void appendAdidToInAppUrls(boolean enabled)
```
    Set whether ADID parameter is added to In-App call to action URLs. By default the ADID parameter will be added to call to action URLs.
    
    Parameters:
    
    enabled - Set to true to enable the ADID parameter or false to disable it
  - isAdidAppendedToInAppUrls
```
public static boolean isAdidAppendedToInAppUrls()
```
    Returns whether the ADID parameter is added to In-App call to action URLs
    
    Returns:
    
    true if parameter is added, false otherwise
  - appendAdidToInboxUrls
```
public static void appendAdidToInboxUrls(boolean enabled)
```
    Set whether ADID parameter is added to In-App call to action URLs. By default the ADID parameter will be added to call to action URLs.
    
    Parameters:
    
    enabled - Set to true to enable the ADID parameter or false to disable it
  - isAdidAppendedToInboxUrls
```
public static boolean isAdidAppendedToInboxUrls()
```
    Returns whether the ADID parameter is added to Inbox call to action URLs
    
    Returns:
    
    true if parameter is added, false otherwise
  - getDisplayableInboxCampaigns
```
public static java.util.List<InboxCampaign> getDisplayableInboxCampaigns()
```
    Get all Inbox campaigns that can be displayed.
    
    Returns:
    
    A list of InboxCampaign objects
  - getAllInboxCampaigns
```
public static java.util.List<InboxCampaign> getAllInboxCampaigns()
```
    Get all Inbox campaigns. The return value will include Inbox campaigns with no listing title, and thus no visible UI element as well as deleted campaigns.
    
    Returns:
    
    A list of InboxCampaign objects
  - refreshInboxCampaigns
```
public static void refreshInboxCampaigns(InboxRefreshListener callback)
```
    Refresh all Inbox campaigns that can be displayed from the Localytics server.
    
    Parameters:
    
    callback - Interface callback for when refresh is complete
    
    See Also:
    
    InboxRefreshListener
  - refreshAllInboxCampaigns
```
public static void refreshAllInboxCampaigns(InboxRefreshListener callback)
```
    Refresh all Inbox campaigns from the Localytics server. The return value will include Inbox campaigns with no listing title, and thus no visible UI element as well as deleted campaigns.
    
    Parameters:
    
    callback - Interface callback for when refresh is complete
    
    See Also:
    
    InboxRefreshListener
  - setInboxCampaignRead
```
public static void setInboxCampaignRead(InboxCampaign campaign,
                                        boolean read)
```
    Set an inbox campaign as read. Read state can be used to display opened inbox campaigns campaigns differently (e.g. an unread indicator).
    
    Parameters:
    
    campaign - the campaign object of the Inbox campaign.
    
    read - true to mark the campaign as read, false to mark it as unread
    
    See Also:
    
    InboxCampaign.isRead(), InboxListAdapter
  - deleteInboxCampaign
```
public static void deleteInboxCampaign(InboxCampaign campaign)
```
    Set an inbox campaign as deleted. Deleted Inbox items will no longer be returned in calls to getDisplayableInboxCampaigns or getAllInboxCampaigns and will be removed from UIs.
    
    Parameters:
    
    campaign - the campaign object of the Inbox campaign.
    
    See Also:
    
    InboxListAdapter
  - getInboxCampaignsUnreadCount
```
public static int getInboxCampaignsUnreadCount()
```
    Get the count of unread inbox messages
    
    Returns:
    
    An integer representing the count of unread inbox messages
  - inboxListItemTapped
```
public static void inboxListItemTapped(InboxCampaign campaign)
```
    Tell the Localytics SDK that an Inbox campaign was tapped in the list view.
    
    Parameters:
    
    campaign - The Inbox campaign that was tapped in the list view.
  - getInboxWebViewManager
```
public static MarketingWebViewManager getInboxWebViewManager(java.util.concurrent.Callable<android.app.Activity> activityRetriever)
```
    FOR LOCALYTICS WRAPPER USE ONLY. Retrieve some webview specific classes for presenting Inbox campaigns in wrappers.
    
    Parameters:
    
    activityRetriever - A callable that will return the current Activity.
    
    Returns:
    
    A web view manager used by Localytics to handle navigation and impression tagging.
  - setLocationMonitoringEnabled
```
public static void setLocationMonitoringEnabled(boolean enabled)
```
    Enable or disable location monitoring for geofence monitoring
    
    Parameters:
    
    enabled - Flag to indicate whether the monitoring should be enabled or disabled.
  - setLocationMonitoringEnabled
```
public static void setLocationMonitoringEnabled(boolean enabled,
                                                boolean persist)
```
    Enable or disable location monitoring for geofence monitoring and allow Localytics to automatically reinitialize Location monitoring on App Launch
    
    Parameters:
    
    enabled - Flag to indicate whether the monitoring should be enabled or disabled.
    
    persist - Flag to indicate whether the monitoring should be enabled or disabled automatically on App Launch.
  - getGeofencesToMonitor
```
@NonNull
public static java.util.List<CircularRegion> getGeofencesToMonitor(double latitude,
                                                                            double longitude)
```
    Get a list of geofences to monitor for enter/exit events
    
    Parameters:
    
    latitude - The user's current location latitude value
    
    longitude - The user's current location longitude value
    
    Returns:
    
    List of CircularRegion objects to begin monitoring
  - triggerRegion
```
public static void triggerRegion(@NonNull
                                 Region region,
                                 @NonNull
                                 Region.Event event,
                                 @Nullable
                                 android.location.Location location)
```
    Trigger a region with a certain event and location.
    
    Parameters:
    
    region - The region that was triggered
    
    event - The event that triggered the region (@see Region.Event.
    
    location - The location that triggered the regions
  - triggerRegions
```
public static void triggerRegions(@NonNull
                                  java.util.List<Region> regions,
                                  @NonNull
                                  Region.Event event,
                                  @Nullable
                                  android.location.Location location)
```
    Trigger a list of regions with a certain event and location.
    
    Parameters:
    
    regions - A list of regions that were triggered
    
    event - The event that triggered the region (@see Region.Event.
    
    location - The location that triggered the regions
  - setLocationListener
```
public static void setLocationListener(@Nullable
                                       LocationListener listener)
```
    Add a listener that will be notified of certain location callbacks:
    - LocationListener.localyticsDidUpdateLocation(Location)}
    - LocationListener.localyticsDidUpdateMonitoredGeofences(List, List)
    Parameters:
    
    listener - The object that will receive the callbacks. Pass in null to remove an existing listener.
  - setIdentifier
```
public static void setIdentifier(java.lang.String key,
                                 java.lang.String value)
```
    Record your custom customer data. Once this value is set, the device it was set on will continue to upload that value until the value is changed. To delete the value, pass in null.
    
    Parameters:
    
    key - The custom data key.
    
    value - The value for the key.
  - setCustomerId
```
public static void setCustomerId(@Nullable
                                 java.lang.String customerId)
```
    Convenience method to set a customer's id.
    
    Parameters:
    
    customerId - Customer's id.
    
    See Also:
    
    setIdentifier(String, String)
  - setCustomerIdWithPrivacyOptedOut
```
public static void setCustomerIdWithPrivacyOptedOut(@Nullable
                                                    java.lang.String customerId,
                                                    boolean optedOut)
```
    Convenience method to set a customer's id. This method will additionally set the privacy opt out state for the user, and will ensure there can be no data leakage for a customer opting out of data collection.
    
    Parameters:
    
    customerId - Customer's id.
    
    optedOut - True if the user should be privacy opted out and have all his Localytics data deleted.
    
    See Also:
    
    setPrivacyOptedOut(boolean), setCustomerId(String)
  - getCustomerId
```
public static java.lang.String getCustomerId()
```
    Convenience method to get a customer's id.
    
    Returns:
    
    Customer's id.
  - getIdentifier
```
public static java.lang.String getIdentifier(java.lang.String key)
```
    Get the identifier associated with a key.
    
    Parameters:
    
    key - The key for an identifier.
    
    Returns:
    
    The value of the identifier.
    
    See Also:
    
    setIdentifier(String, String)
  - setLocation
```
public static void setLocation(android.location.Location location)
```
    Set a user's location.
    
    Parameters:
    
    location - User's location.
  - onActivityResume
```
public static void onActivityResume(@NonNull
                                    android.app.Activity activity)
```
    For alternative session management only
    This will: ~ open a new session ~ kick off an uplaod ~ handle test mode ~ handle opening a push notification ~ allow an activity of type FragmentActivity to display a marketing message
    
    Parameters:
    
    activity - The current Activity
  - onActivityPause
```
public static void onActivityPause(android.app.Activity activity)
```
    For alternative session management only
    This will: ~ close an existing session ~ kick off an upload ~ dismiss a currently displayed marketing message
    
    Parameters:
    
    activity - The current Activity
  - onNewIntent
```
public static void onNewIntent(android.app.Activity activity,
                               android.content.Intent intent)
```
    Performs the same session management tasks as onActivityResume(Activity, Intent) but with the new Intent
    
    Parameters:
    
    activity - The current Activity
    
    intent - The new Intent
    
    See Also:
    
    onActivityResume(Activity, Intent)
  - setOptions
```
public static void setOptions(@NonNull
                              java.util.Map<java.lang.String,java.lang.Object> options)
```
    Customize the behavior of the SDK by setting custom values for various options. In each entry, the key specifies the option to modify, and the value specifies what value to set the option to. Options can be restored to default by passing in a value of null, or an empty string for values with type String.
    
    Parameters:
    
    options - The map of options and values to modify
  - setOption
```
public static void setOption(@NonNull
                             java.lang.String key,
                             @Nullable
                             java.lang.Object value)
```
    Customize the behavior of the SDK by setting a custom value for an option. The key specifies the option to modify, and the value specifies what value to set the option to. An option can be restored to default by passing in a value of null, or an empty string for values with type String.
    
    Parameters:
    
    key - The key of the option
    
    value - The value of the option or null to restore the default
  - setLoggingEnabled
```
public static void setLoggingEnabled(boolean enabled)
```
    Enable/Disable logging.
    
    Parameters:
    
    enabled - Flag to indicate whether the logging should be enabled or disabled.
    
    See Also:
    
    isLoggingEnabled()
  - redirectLogsToDisk
```
public static void redirectLogsToDisk(boolean writeExternally,
                                      @NonNull
                                      android.content.Context context)
```
    No production builds should call this method.
    Enable/Disable log rerouting to a file on disk. Calling this method will allow logs to be copied later. The method allows two options:
    - writeExternally set to false will write the logs to files/console.log within the app's directory.
    - writeExternally set to true will write the logs to console.log in the app's external storage directory. This option requires requesting WRITE_EXTERNAL_STORAGE permissions from the user.
    Parameters:
    
    writeExternally - a boolean value to indicate where to write the logs.
    
    context - The Application's Context object.
  - isLoggingEnabled
```
public static boolean isLoggingEnabled()
```
    Check whether the logging is enabled or disabled.
    
    Returns:
    
    true if the logging is enabled, otherwise false.
    
    See Also:
    
    setLoggingEnabled(boolean)
  - getInstallId
```
public static java.lang.String getInstallId()
```
    Get the app's installation id.
    
    Returns:
    
    App's installation id.
  - getLocalAuthenticationToken
```
public static java.lang.String getLocalAuthenticationToken()
```
    Get the app's local authentication token. This token should not be shared outside of the app as it ensure the behavior of certain features that could be otherwise vulnerable. This token should attached as an extra to any intent that Localytics should trigger as a deeplink from a push message. The token should be keyed by the value ll_launch_intent_token. This value will be removed once read to prevent exposing it externally. If the token is not included, then the intent will be suppressed in favor of the app's homescreen.
    
    Returns:
    
    App's local authentication token.
  - getAppKey
```
public static java.lang.String getAppKey()
```
    Get the Localytics app key.
    
    Returns:
    
    The Localytics app key.
  - getLibraryVersion
```
@NonNull
public static java.lang.String getLibraryVersion()
```
    Get the Localytics library version.
    
    Returns:
    
    The Localytics library version.
  - setInAppMessageDismissButtonLocation
```
public static void setInAppMessageDismissButtonLocation(Localytics.InAppMessageDismissButtonLocation buttonLocation)
```
    Set the relative position of the in-app message dismiss button.
    
    Parameters:
    
    buttonLocation - The button location.
    
    See Also:
    
    getInAppMessageDismissButtonLocation()
  - getInAppMessageDismissButtonLocation
```
public static Localytics.InAppMessageDismissButtonLocation getInAppMessageDismissButtonLocation()
```
    Get the relative position of the in-app message dismiss button.
    
    Returns:
    
    The relative position of the in-app message dismiss button.
    
    See Also:
    
    setInAppMessageDismissButtonLocation(com.localytics.android.Localytics.InAppMessageDismissButtonLocation)

Class Localytics

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCATION_PERMISSION_REQUEST_CODE

Constructor Detail

Localytics

Method Detail

integrate

autoIntegrate

upload

pauseDataUploading

setOptedOut

setPrivacyOptedOut

isOptedOut

isPrivacyOptedOut

openSession

closeSession

tagEvent

tagEvent

tagEvent

tagPurchased

tagAddedToCart

tagStartedCheckout

tagCompletedCheckout

tagContentViewed

tagSearched

tagShared

tagContentRated

tagCustomerRegistered

tagCustomerLoggedIn

tagCustomerLoggedOut

tagInvited

tagInAppImpression

tagInAppImpression

tagInboxImpression

tagInboxImpression

tagPushToInboxImpression

tagPlacesPushReceived

tagPlacesPushOpened

tagPlacesPushOpened

triggerPlacesNotification

triggerPlacesNotification

tagScreen

setCustomDimension

getCustomDimension

setAnalyticsListener

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

setProfileAttribute

addProfileAttributesToSet

addProfileAttributesToSet

addProfileAttributesToSet

addProfileAttributesToSet

addProfileAttributesToSet

addProfileAttributesToSet

removeProfileAttributesFromSet

removeProfileAttributesFromSet

removeProfileAttributesFromSet

removeProfileAttributesFromSet

removeProfileAttributesFromSet

removeProfileAttributesFromSet

incrementProfileAttribute

incrementProfileAttribute

decrementProfileAttribute

decrementProfileAttribute

deleteProfileAttribute

deleteProfileAttribute