Appboy (Braze Android SDK 4.0.2)

java.lang.Object
- com.appboy.Appboy

All Implemented Interfaces:: IAppboy

public class Appboy
extends java.lang.Object
implements IAppboy

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeUser(java.lang.String userId)` When you first start using Braze on a device, the user is considered "anonymous".
`static void`	`clearAppboyEndpointProvider()` Clear the currently set `IAppboyEndpointProvider`
`void`	`closeSession(android.app.Activity activity)` Closes the current session.
`static boolean`	`configure(android.content.Context context, AppboyConfig config)` Optional static method to set configuration values for the Appboy singleton, overriding whatever values are present in the appboy.xml.
`Card`	`deserializeContentCard(org.json.JSONObject contentCardJson)` Constructs a Content Card from its `Card.forJsonPut()` output.
`Card`	`deserializeContentCard(java.lang.String contentCardString)` Helper method for `IAppboy.deserializeContentCard(JSONObject)`.
`IInAppMessage`	`deserializeInAppMessageString(java.lang.String inAppMessageJsonString)` This function returns a deserialized in-app message from the message JSON string.
`static void`	`disableSdk(android.content.Context context)` Disables the Braze SDK.
`static boolean`	`enableMockAppboyNetworkRequestsAndDropEventsMode()` Testing utility method that enables mocking for all Braze SDK network requests, essentially turning the SDK "off".
`static void`	`enableSdk(android.content.Context context)` Enables the Braze SDK after an invocation of `disableSdk(Context)`.
`static android.net.Uri`	`getAppboyApiEndpoint(android.net.Uri appboyEndpoint)` If an `IAppboyEndpointProvider` is configured, that provider's delegate is used to generate the Uri for the Braze API endpoint.
`IAppboyImageLoader`	`getAppboyImageLoader()` Returns the `IAppboyImageLoader` for the Braze instance.
`java.lang.String`	`getAppboyPushMessageRegistrationId()` Returns the FCM/ADM/Baidu registration Id used to send the device push messages.
`java.util.List<Card>`	`getCachedContentCards()` Retrieves the offline/cached list of Content Cards from offline storage.
`int`	`getContentCardCount()` Retrieves information about Content Cards based on the currently cached data.
`long`	`getContentCardsLastUpdatedInSecondsFromEpoch()` Retrieves information about Content Cards based on the currently cached data.
`int`	`getContentCardUnviewedCount()` Retrieves information about Content Cards based on the currently cached data.
`AppboyUser`	`getCurrentUser()` Returns the user currently being tracked by Braze.
`static IAppboyNotificationFactory`	`getCustomAppboyNotificationFactory()` Returns the currently set custom IAppboyNotificationFactory or null.
`java.lang.String`	`getDeviceId()` Get the device ID - a randomly generated, app specific ID that is stored on the device.
`java.lang.String`	`getInstallTrackingId()` Returns a unique device ID for install tracking.
`static Appboy`	`getInstance(android.content.Context context)` Static method that returns the Appboy singleton.
`static boolean`	`getOutboundNetworkRequestsOffline()`
`void`	`logContentCardsDisplayed()` Reports that Content Cards were displayed.
`void`	`logCustomEvent(java.lang.String eventName)` Reports a custom named event.
`void`	`logCustomEvent(java.lang.String eventNameInput, AppboyProperties properties)` Reports a custom named event.
`void`	`logFeedCardClick(java.lang.String cardId)`
`void`	`logFeedCardImpression(java.lang.String cardId)`
`void`	`logFeedDisplayed()` Reports that the feed was displayed.
`void`	`logPurchase(java.lang.String productId, java.lang.String currencyCode, java.math.BigDecimal price)` In order to log a purchase, switch to logPurchase(String productId, String currencyCode, BigDecimal price, int quantity).
`void`	`logPurchase(java.lang.String productId, java.lang.String currencyCode, java.math.BigDecimal price, AppboyProperties properties)` In order to log a purchase, switch to logPurchase(String productId, String currencyCode, BigDecimal price, int quantity, AppboyProperties properties).
`void`	`logPurchase(java.lang.String productId, java.lang.String currencyCode, java.math.BigDecimal price, int quantity)` In order to log a purchase, switch to logPurchase(String productId, String currencyCode, BigDecimal price, int quantity, AppboyProperties properties).
`void`	`logPurchase(java.lang.String productIdInput, java.lang.String currencyCodeInput, java.math.BigDecimal price, int quantity, AppboyProperties properties)` Reports that the current user made an in app purchase.
`void`	`logPushDeliveryEvent(java.lang.String campaignId)` Reports that a push notification was delivered to the device.
`void`	`logPushNotificationActionClicked(java.lang.String campaignId, java.lang.String actionId, java.lang.String actionType)` Reports that the user clicked on a push notification action button.
`void`	`logPushNotificationOpened(android.content.Intent intent)` Reports that the user clicked on the push notification.
`void`	`logPushNotificationOpened(java.lang.String campaignId)` When possible, logPushNotificationOpened(Intent intent) should be used instead.
`void`	`logPushStoryPageClicked(java.lang.String campaignId, java.lang.String pageId)` Reports that the user clicked on a push story page.
`void`	`openSession(android.app.Activity activity)` Opens a new session or resumes the previous session.
`void`	`registerAppboyPushMessages(java.lang.String registrationId)` Registers the device as eligible to receive push notifications from Braze.
`<T> void`	`removeSingleSubscription(IEventSubscriber<T> subscriber, java.lang.Class<T> eventClass)` Removes a single subscription associated with the given activity and event class.
`void`	`requestContentCardsRefresh(boolean fromCache)` Requests an immediate refresh of Content Cards.
`void`	`requestFeedRefresh()` Requests an immediate refresh of the news feed from the Braze server.
`void`	`requestFeedRefreshFromCache()` Requests a refresh of the news feed from offline storage.
`void`	`requestImmediateDataFlush()` Requests an immediate flush of any analytics data waiting to be sent to Appboy's servers.
`static void`	`setAppboyEndpointProvider(IAppboyEndpointProvider appboyEndpointProvider)` Sets an `IAppboyEndpointProvider` to be used to route Braze API traffic Note that if a custom endpoint is specified using `AppboyConfig.Builder#setCustomEndpoint(String)` or via appboy.xml configuration, any `IAppboyEndpointProvider` previously set using this method will be overridden when the Appboy singleton initializes.
`void`	`setAppboyImageLoader(IAppboyImageLoader appboyImageLoader)` Sets the `IAppboyImageLoader` for the Braze instance.
`static void`	`setCustomAppboyNotificationFactory(IAppboyNotificationFactory customAppboyNotificationFactory)` Set a custom IAppboyNotificationFactory to be used to modify or create Braze push notifications.
`void`	`setGoogleAdvertisingId(java.lang.String googleAdvertisingId, boolean limitAdTrackingEnabled)` Sets the Google Advertising ID and associated ad-tracking enabled field for this device.
`static void`	`setOutboundNetworkRequestsOffline(boolean isOffline)` Pauses or resumes outbound network requests from the Braze SDK at any point during runtime.
`void`	`subscribeToContentCardsUpdates(IEventSubscriber<ContentCardsUpdatedEvent> subscriber)` Subscribes to Content Cards events.
`void`	`subscribeToFeedUpdates(IEventSubscriber<FeedUpdatedEvent> subscriber)` Subscribes to news feed events.
`void`	`subscribeToNewInAppMessages(IEventSubscriber<InAppMessageEvent> subscriber)` Subscribes to in-app message events.
`static void`	`wipeData(android.content.Context context)` Hard resets all data created by the Braze SDK from the internal storage directory.

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

- Method Detail
  - getInstance
```
public static Appboy getInstance(android.content.Context context)
```
    Static method that returns the Appboy singleton. All requests to Braze are made through this instance.
    
    Parameters:
    
    context - Current context
    
    Returns:
    
    the singleton Appboy instance
  - openSession
```
public void openSession(android.app.Activity activity)
```
    Description copied from interface: IAppboy
    
    Opens a new session or resumes the previous session. A call to IAppboy.openSession(Activity) within the session timeout of a call to IAppboy.closeSession(Activity) will cause the previous session to be resumed. This is done so that transitions from one Activity to another do not create a new session each time. This must be called in every Activity's onStart method if using a manual session handling integration.
    
    Specified by:
    
    openSession in interface IAppboy
    
    Parameters:
    
    activity - The current Activity.
    
    See Also:
    
    IAppboy.openSession(android.app.Activity)
  - closeSession
```
public void closeSession(android.app.Activity activity)
```
    Description copied from interface: IAppboy
    
    Closes the current session. The session may be reopened if a call is made to IAppboy.openSession(Activity) within the session timeout. This must be called every the Activity's onStop method if using a manual session handling integration.
    
    Specified by:
    
    closeSession in interface IAppboy
    
    Parameters:
    
    activity - The current Activity.
    
    See Also:
    
    IAppboy.closeSession(android.app.Activity)
  - logCustomEvent
```
public void logCustomEvent(java.lang.String eventName)
```
    Description copied from interface: IAppboy
    
    Reports a custom named event.
    
    Specified by:
    
    logCustomEvent in interface IAppboy
    
    Parameters:
    
    eventName - The String identifier for the event to track. Best practice is to track generic events useful for segmenting, instead of specific user actions (i.e. track watched_sports_video instead of watched_video_adrian_peterson_td_mnf).
    
    See Also:
    
    IAppboy.logCustomEvent(String)
  - logCustomEvent
```
public void logCustomEvent(java.lang.String eventNameInput,
                           AppboyProperties properties)
```
    Description copied from interface: IAppboy
    
    Reports a custom named event.
    
    Specified by:
    
    logCustomEvent in interface IAppboy
    
    Parameters:
    
    eventNameInput - The String identifier for the event to track. Best practice is to track generic events useful for segmenting, instead of specific user actions (i.e. track watched_sports_video instead of watched_video_adrian_peterson_td_mnf).
    
    properties - An object containing key-value properties describing this event. Property names are non-empty strings <= 255 characters, with no leading dollar signs. Property values can be integers, floats, booleans, java.util.Date objects, or strings <= 255 characters.
    
    See Also:
    
    IAppboy.logCustomEvent(String, AppboyProperties)
  - logPurchase
```
public void logPurchase(java.lang.String productId,
                        java.lang.String currencyCode,
                        java.math.BigDecimal price)
```
    Description copied from interface: IAppboy
    
    In order to log a purchase, switch to logPurchase(String productId, String currencyCode, BigDecimal price, int quantity). Using this method will by default log a purchase with a quantity of one.
    
    Specified by:
    
    logPurchase in interface IAppboy
    
    See Also:
    
    IAppboy.logPurchase(String, String, BigDecimal)
  - logPurchase
```
public void logPurchase(java.lang.String productId,
                        java.lang.String currencyCode,
                        java.math.BigDecimal price,
                        AppboyProperties properties)
```
    Description copied from interface: IAppboy
    
    In order to log a purchase, switch to logPurchase(String productId, String currencyCode, BigDecimal price, int quantity, AppboyProperties properties). Using this method will by default log a purchase with a quantity of one.
    
    Specified by:
    
    logPurchase in interface IAppboy
    
    See Also:
    
    IAppboy.logPurchase(String, String, BigDecimal, AppboyProperties)
  - logPurchase
```
public void logPurchase(java.lang.String productId,
                        java.lang.String currencyCode,
                        java.math.BigDecimal price,
                        int quantity)
```
    Description copied from interface: IAppboy
    
    In order to log a purchase, switch to logPurchase(String productId, String currencyCode, BigDecimal price, int quantity, AppboyProperties properties).
    
    Specified by:
    
    logPurchase in interface IAppboy
    
    See Also:
    
    IAppboy.logPurchase(String, String, BigDecimal, int)
  - logPurchase
```
public void logPurchase(java.lang.String productIdInput,
                        java.lang.String currencyCodeInput,
                        java.math.BigDecimal price,
                        int quantity,
                        AppboyProperties properties)
```
    Description copied from interface: IAppboy
    
    Reports that the current user made an in app purchase. Useful for tracking and segmenting users more likely to make purchases.
    
    Specified by:
    
    logPurchase in interface IAppboy
    
    Parameters:
    
    productIdInput - The String identifier for the product purchased. Usually the Google Play SKU.
    
    currencyCodeInput - Currencies should be represented as an ISO 4217 currency code. Supported currency symbols include: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MTL, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMK, ZMW and ZWL. Any other provided currency symbol will result in a logged warning and no other action taken by the SDK.
    
    price - The price paid. Base units depend on the currency. As an example, USD should be reported as Dollars.Cents, whereas JPY should be reported as a whole number of Yen. All provided BigDecimal values will have RoundingMode.HALF_UP rounding applied such that a maximum of two digits exist after the decimal point. May be negative.
    
    quantity - The quantity of items purchased expressed as a whole number. Must be greater than zero.
    
    properties - A map of key-value properties describing this purchase. Property names are non-empty strings <= 255 characters, with no leading dollar signs. Property values can be integers, floats, booleans, datetimes (of the formats "%FT%T%z", "%Y-%m-%d %H:%M:%S", "%Y-%m-%d", "%m/%d/%Y"), or strings <= 255 characters. Note: The productId and currencyCode are trimmed of any whitespace characters before being sent to Braze.
    
    Note: Querying the Google Play store for SKU details may return the price of a in-app purchases in micros. Therefore, a purchase of price 0.99USD will be returned as 9900000. To pass this value to Braze, be sure to convert it to a BigDecimal before attempting to convert it from micros to a decimal value in order to avoid integer division rounding errors.
    
    BigDecimal priceInMicro = new BigDecimal(9900000L); BigDecimal priceInDecimal = priceInMicro.divide(new BigDecimal(10e6));
    
    See Also:
    
    IAppboy.logPurchase(String, String, BigDecimal, int, AppboyProperties)
  - logPushNotificationOpened
```
public void logPushNotificationOpened(java.lang.String campaignId)
```
    Description copied from interface: IAppboy
    
    When possible, logPushNotificationOpened(Intent intent) should be used instead. Note that integrations shouldn't be calling this method directly. Reports that the user clicked on the push notification.
    
    Specified by:
    
    logPushNotificationOpened in interface IAppboy
    
    Parameters:
    
    campaignId - The ID of the campaign that triggered the push notification. This can be found as an extra in the push notification intent.
    
    See Also:
    
    IAppboy.logPushNotificationOpened(String)
  - logPushNotificationOpened
```
public void logPushNotificationOpened(android.content.Intent intent)
```
    Description copied from interface: IAppboy
    
    Reports that the user clicked on the push notification. Note that integrations shouldn't be calling this method directly.
    
    Specified by:
    
    logPushNotificationOpened in interface IAppboy
    
    Parameters:
    
    intent - The push notification intent.
    
    See Also:
    
    IAppboy.logPushNotificationOpened(Intent intent)
  - logPushDeliveryEvent
```
public void logPushDeliveryEvent(java.lang.String campaignId)
```
    Description copied from interface: IAppboy
    
    Reports that a push notification was delivered to the device.
    
    Specified by:
    
    logPushDeliveryEvent in interface IAppboy
    
    Parameters:
    
    campaignId - The ID of the campaign that triggered the push notification. This can be found as an extra in the push notification intent.
    
    See Also:
    
    IAppboy.logPushDeliveryEvent(String)
  - logPushNotificationActionClicked
```
public void logPushNotificationActionClicked(java.lang.String campaignId,
                                             java.lang.String actionId,
                                             java.lang.String actionType)
```
    Description copied from interface: IAppboy
    
    Reports that the user clicked on a push notification action button.
    
    Specified by:
    
    logPushNotificationActionClicked in interface IAppboy
    
    Parameters:
    
    campaignId - The ID of the campaign that triggered the push notification. This can be found as an extra in the push notification intent.
    
    actionId - The ID of the action button that was clicked.
    
    actionType - The action type from the intent's string extra under Constants.APPBOY_ACTION_TYPE_KEY.
    
    See Also:
    
    IAppboy.logPushNotificationActionClicked(String, String, String)
  - logPushStoryPageClicked
```
public void logPushStoryPageClicked(java.lang.String campaignId,
                                    java.lang.String pageId)
```
    Description copied from interface: IAppboy
    
    Reports that the user clicked on a push story page.
    
    Specified by:
    
    logPushStoryPageClicked in interface IAppboy
    
    Parameters:
    
    campaignId - The ID of the campaign that triggered the push notification. This can be found as an extra in the push notification intent.
    
    pageId - The ID of the push story page that was clicked.
    
    See Also:
    
    IAppboy.logPushStoryPageClicked(String, String)
  - logContentCardsDisplayed
```
public void logContentCardsDisplayed()
```
    Description copied from interface: IAppboy
    
    Reports that Content Cards were displayed.
    
    Specified by:
    
    logContentCardsDisplayed in interface IAppboy
    
    See Also:
    
    IAppboy.logContentCardsDisplayed()
  - logFeedDisplayed
```
public void logFeedDisplayed()
```
    Description copied from interface: IAppboy
    
    Reports that the feed was displayed.
    
    Specified by:
    
    logFeedDisplayed in interface IAppboy
    
    See Also:
    
    IAppboy.logFeedDisplayed()
  - requestFeedRefreshFromCache
```
public void requestFeedRefreshFromCache()
```
    Description copied from interface: IAppboy
    
    Requests a refresh of the news feed from offline storage. The result of this call will be reported asynchronously via a FeedUpdatedEvent, similar to a call to IAppboy.requestFeedRefresh().
    
    Specified by:
    
    requestFeedRefreshFromCache in interface IAppboy
    
    See Also:
    
    IAppboy.requestFeedRefreshFromCache()
  - requestFeedRefresh
```
public void requestFeedRefresh()
```
    Description copied from interface: IAppboy
    
    Requests an immediate refresh of the news feed from the Braze server.
    
    All refresh requests also flush the session/events queue when the network request executes.
    
    Results of refresh calls are reported asynchronously via events. Events can be subscribed to with other methods in this class. If the network call returns before any subscribers are active, the result will be lost.
    
    Specified by:
    
    requestFeedRefresh in interface IAppboy
    
    See Also:
    
    IAppboy.requestFeedRefresh()
  - requestContentCardsRefresh
```
public void requestContentCardsRefresh(boolean fromCache)
```
    Description copied from interface: IAppboy
    
    Requests an immediate refresh of Content Cards. If fromCache is true, data will be pulled from offline storage. If fromCache is false, the SDK will request an immediate refresh of Content Cards from the Appboy server.
    
    Results of both cached and non-cached refresh calls are reported asynchronously via events. Events can be subscribed to using IAppboy.subscribeToContentCardsUpdates(IEventSubscriber)
    
    If the network call returns before any subscribers are active, the result will be lost.
    
    Specified by:
    
    requestContentCardsRefresh in interface IAppboy
    
    Parameters:
    
    fromCache - whether to request data from offline storage.
    
    See Also:
    
    IAppboy.requestContentCardsRefresh(boolean)
  - requestImmediateDataFlush
```
public void requestImmediateDataFlush()
```
    Description copied from interface: IAppboy
    
    Requests an immediate flush of any analytics data waiting to be sent to Appboy's servers.
    
    Specified by:
    
    requestImmediateDataFlush in interface IAppboy
  - subscribeToNewInAppMessages
```
public void subscribeToNewInAppMessages(IEventSubscriber<InAppMessageEvent> subscriber)
```
    Description copied from interface: IAppboy
    
    Subscribes to in-app message events. The subscriber callback will be called when a new in-app message is sent. The subscriber will be called with a InAppMessageEvent.
    
    Subscriptions should be cleaned up manually by calling IAppboy.removeSingleSubscription(com.appboy.events.IEventSubscriber, Class).
    
    All events are triggered from background threads and isolate any encountered exceptions. If you need to do work on the UI thread in response to an event, you will need to coordinate that in the IEventSubscriber's trigger method.
    
    Specified by:
    
    subscribeToNewInAppMessages in interface IAppboy
    
    Parameters:
    
    subscriber - A callback that should be executed when the news feed is updated.
    
    See Also:
    
    IAppboy.subscribeToNewInAppMessages(com.appboy.events.IEventSubscriber)
  - subscribeToContentCardsUpdates
```
public void subscribeToContentCardsUpdates(IEventSubscriber<ContentCardsUpdatedEvent> subscriber)
```
    Description copied from interface: IAppboy
    
    Subscribes to Content Cards events. The subscriber callback will be called when Content Cards is updated. The subscriber will be called with a ContentCardsUpdatedEvent.
    
    Subscriptions should be cleaned up manually by calling IAppboy.removeSingleSubscription(com.appboy.events.IEventSubscriber, Class).
    
    All events are triggered from background threads and isolate any encountered exceptions. If you need to do work on the UI thread in response to an event, you will need to coordinate that in the IEventSubscriber's trigger method.
    
    Specified by:
    
    subscribeToContentCardsUpdates in interface IAppboy
    
    Parameters:
    
    subscriber - A callback that will be executed when Content Cards are updated.
    
    See Also:
    
    IAppboy.subscribeToContentCardsUpdates(com.appboy.events.IEventSubscriber)
  - subscribeToFeedUpdates
```
public void subscribeToFeedUpdates(IEventSubscriber<FeedUpdatedEvent> subscriber)
```
    Description copied from interface: IAppboy
    
    Subscribes to news feed events. The subscriber callback will be called when the news feed is updated. The subscriber will be called with a FeedUpdatedEvent.
    
    Subscriptions should be cleaned up manually by calling IAppboy.removeSingleSubscription(com.appboy.events.IEventSubscriber, Class).
    
    All events are triggered from background threads and isolate any encountered exceptions. If you need to do work on the UI thread in response to an event, you will need to coordinate that in the IEventSubscriber's trigger method.
    
    Specified by:
    
    subscribeToFeedUpdates in interface IAppboy
    
    Parameters:
    
    subscriber - A callback that should be executed when the news feed is updated.
    
    See Also:
    
    IAppboy.subscribeToFeedUpdates(com.appboy.events.IEventSubscriber)
  - removeSingleSubscription
```
public <T> void removeSingleSubscription(IEventSubscriber<T> subscriber,
                                         java.lang.Class<T> eventClass)
```
    Description copied from interface: IAppboy
    
    Removes a single subscription associated with the given activity and event class. This should be called if you want to selectively unsubscribe from an event, but do not want to remove every subscription for the activity.
    
    Specified by:
    
    removeSingleSubscription in interface IAppboy
    
    Parameters:
    
    subscriber - The callback which is currently subscribed.
    
    eventClass - The Event class which this IEventSubscriber is subscribed to.
    
    See Also:
    
    IAppboy.removeSingleSubscription(com.appboy.events.IEventSubscriber, Class)
  - changeUser
```
public void changeUser(java.lang.String userId)
```
    Description copied from interface: IAppboy
    
    When you first start using Braze on a device, the user is considered "anonymous". You can use this method to optionally identify a user with a unique ID, which enables the following:
    * If the same user is identified on another device, their user profile, usage history and event history will be shared across devices.
    * If your app is used by multiple people, you can assign each of them a unique identifier to track them separately. Only the most recent user on a particular device will receive push notifications and in-app messages.
    
    When you request a user switch (which is any call to changeUser where the new user ID is not the same as the existing user ID), the current session for the previous user (anonymous or not) is automatically sealed and a new session is started. Similarly, following a call to changeUser, any events which fire are guaranteed to be for the new user -- if an in flight server request completes for the old user after the user switch no events will fire, so you do not need to worry about filtering out events from Braze for old users.
    
    Additionally, if you identify a user which has never been identified on another device, the entire history of that user as an "anonymous" user on this device will be preserved and associated with the newly identified user. However, if you identify a user which *has* been identified in another app, any history which was already flushed to the server for the anonymous user on this device will become orphaned and will not be associated with any future users. These orphaned users are not considered in your user counts and will not be messaged.
    
    As part of the user change process, if you switch from an identified user to another identified user, Braze attempts to flush the previous user's data with a background task. If that background task fails, Braze will not attempt to re-flush the previous user's data until the next time you switch back to that user ID, instead preferring to minimize network traffic and free up any resources being used by the previous user's operations.
    
    When this method returns, all subsequent calls to your Braze instance will operate on the new user.
    Note: Once you identify a user, you cannot revert to the "anonymous" user. The transition from anonymous to identified tracking is only allowed once because the initial anonymous user receives special treatment to allow for preservation of their history. As a result, we recommend against changing the user ID just because your app has entered a "logged out" state because it makes you unable to target the previously logged out user with re-engagement campaigns. If you anticipate multiple users on the same device, but only want to target one of them when your app is in a logged out state, we recommend separately keeping track of the user ID you want to target while logged out and switching back to that user ID as part of your app's logout process.
    
    Note that an AppboyUser can be retrieved at any time using IAppboy.getCurrentUser().
    
    Specified by:
    
    changeUser in interface IAppboy
    
    Parameters:
    
    userId - An external user identifier. May not be longer than Constants.USER_ID_MAX_LENGTH_BYTES.
    
    See Also:
    
    IAppboy.changeUser(String)
  - getCurrentUser
```
public AppboyUser getCurrentUser()
```
    Description copied from interface: IAppboy
    
    Returns the user currently being tracked by Braze. Note that modifying values on instances of AppboyUser for a previous user will result in those values being stored locally, but they will not be synced with the Braze server until that user becomes active again.
    
    Specified by:
    
    getCurrentUser in interface IAppboy
    
    See Also:
    
    IAppboy.getCurrentUser()
  - registerAppboyPushMessages
```
public void registerAppboyPushMessages(java.lang.String registrationId)
```
    Description copied from interface: IAppboy
    
    Registers the device as eligible to receive push notifications from Braze. For FCM/ADM applications, this takes the FCM/ADM registration ID to send the device FCM/ADM messages. For apps integrating Baidu Cloud Push, this method is used to register the Baidu user with Braze. The registration ID is flushed immediately.
    
    This should only be used if you already use FCM/ADM/FCM messaging in your app from another provider or are integrating Baidu Cloud Push.
    
    Specified by:
    
    registerAppboyPushMessages in interface IAppboy
    
    Parameters:
    
    registrationId - The registration ID, or for apps integrating Baidu Cloud Push, the Baidu user id
    
    See Also:
    
    IAppboy.registerAppboyPushMessages(String)
  - getAppboyPushMessageRegistrationId
```
public java.lang.String getAppboyPushMessageRegistrationId()
```
    Description copied from interface: IAppboy
    
    Returns the FCM/ADM/Baidu registration Id used to send the device push messages.
    
    Specified by:
    
    getAppboyPushMessageRegistrationId in interface IAppboy
    
    See Also:
    
    IAppboy.getAppboyPushMessageRegistrationId()
  - getInstallTrackingId
```
public java.lang.String getInstallTrackingId()
```
    Description copied from interface: IAppboy
    
    Returns a unique device ID for install tracking.
    
    Specified by:
    
    getInstallTrackingId in interface IAppboy
    
    See Also:
    
    IAppboy.getInstallTrackingId()
  - getAppboyImageLoader
```
public IAppboyImageLoader getAppboyImageLoader()
```
    Description copied from interface: IAppboy
    
    Returns the IAppboyImageLoader for the Braze instance.
    
    Specified by:
    
    getAppboyImageLoader in interface IAppboy
    
    See Also:
    
    IAppboy.getAppboyImageLoader()
  - setAppboyImageLoader
```
public void setAppboyImageLoader(IAppboyImageLoader appboyImageLoader)
```
    Description copied from interface: IAppboy
    
    Sets the IAppboyImageLoader for the Braze instance. This IAppboyImageLoader is used for all image related
    
    Specified by:
    
    setAppboyImageLoader in interface IAppboy
    
    Parameters:
    
    appboyImageLoader - The image loader to be set for the Braze instance. If null, then the existing image loader is unchanged.
    
    See Also:
    
    IAppboy.setAppboyImageLoader(IAppboyImageLoader)
  - getContentCardCount
```
public int getContentCardCount()
```
    Description copied from interface: IAppboy
    
    Retrieves information about Content Cards based on the currently cached data.
    
    Note that this method is synchronous and will block the current running thread.
    
    Specified by:
    
    getContentCardCount in interface IAppboy
    
    Returns:
    
    The total number of cached Content Cards. If Content Cards information cannot be retrieved, returns -1.
    
    See Also:
    
    IAppboy.requestContentCardsRefresh(boolean)
  - getContentCardUnviewedCount
```
public int getContentCardUnviewedCount()
```
    Description copied from interface: IAppboy
    
    Retrieves information about Content Cards based on the currently cached data.
    
    Note that this method is synchronous and will block the current running thread.
    
    Specified by:
    
    getContentCardUnviewedCount in interface IAppboy
    
    Returns:
    
    The number of cached unviewed Content Cards. If Content Cards information cannot be retrieved, returns -1.
    
    See Also:
    
    IAppboy.requestContentCardsRefresh(boolean)
  - getContentCardsLastUpdatedInSecondsFromEpoch
```
public long getContentCardsLastUpdatedInSecondsFromEpoch()
```
    Description copied from interface: IAppboy
    
    Retrieves information about Content Cards based on the currently cached data.
    
    Note that this method is synchronous and will block the current running thread.
    
    Specified by:
    
    getContentCardsLastUpdatedInSecondsFromEpoch in interface IAppboy
    
    Returns:
    
    The Unix timestamp (in seconds) of when this snapshot of Content Cards was last received from Braze's servers. If Content Cards information cannot be retrieved, returns -1.
    
    See Also:
    
    IAppboy.requestContentCardsRefresh(boolean)
  - getCachedContentCards
```
public java.util.List<Card> getCachedContentCards()
```
    Description copied from interface: IAppboy
    
    Retrieves the offline/cached list of Content Cards from offline storage. Useful method to synchronously check the state of Content Cards already synced to the device.
    
    Specified by:
    
    getCachedContentCards in interface IAppboy
    
    Returns:
    
    The list of cached Content Cards. Note that this does not request a fresh list of Content Cards from Braze. If the SDK is disabled or the cached list of cards cannot be retrieved, returns null.
  - deserializeContentCard
```
public Card deserializeContentCard(java.lang.String contentCardString)
```
    Description copied from interface: IAppboy
    
    Helper method for IAppboy.deserializeContentCard(JSONObject).
    
    Specified by:
    
    deserializeContentCard in interface IAppboy
    
    Parameters:
    
    contentCardString - The string content of a Content Card's JSONObject obtained via JSONObject.toString().
  - deserializeContentCard
```
public Card deserializeContentCard(org.json.JSONObject contentCardJson)
```
    Description copied from interface: IAppboy
    
    Constructs a Content Card from its Card.forJsonPut() output. Useful for caching Content Card data and recreating them for your own purposes.
    
    Note that the analytics methods on this deserialized cards will work in the same way as a standard Braze provided Card. I.e. clicks and impressions can be logged on the returned object.
    
    Specified by:
    
    deserializeContentCard in interface IAppboy
    
    Parameters:
    
    contentCardJson - The JSONObject representation of a Content Card as obtained via Card.forJsonPut().
  - logFeedCardImpression
```
public void logFeedCardImpression(java.lang.String cardId)
```
    Specified by:
    
    logFeedCardImpression in interface IAppboy
    
    Parameters:
    
    cardId - The ID of the feed card.
    
    See Also:
    
    Card.logImpression()
  - logFeedCardClick
```
public void logFeedCardClick(java.lang.String cardId)
```
    Specified by:
    
    logFeedCardClick in interface IAppboy
    
    Parameters:
    
    cardId - The ID of the feed card.
    
    See Also:
    
    Card.logClick()
  - deserializeInAppMessageString
```
public IInAppMessage deserializeInAppMessageString(java.lang.String inAppMessageJsonString)
```
    Description copied from interface: IAppboy
    
    This function returns a deserialized in-app message from the message JSON string.
    
    Specified by:
    
    deserializeInAppMessageString in interface IAppboy
    
    Parameters:
    
    inAppMessageJsonString - The in-app message JSON string
  - setGoogleAdvertisingId
```
public void setGoogleAdvertisingId(java.lang.String googleAdvertisingId,
                                   boolean limitAdTrackingEnabled)
```
    Description copied from interface: IAppboy
    
    Sets the Google Advertising ID and associated ad-tracking enabled field for this device. Note that the SDK does not automatically collect this data.
    
    Specified by:
    
    setGoogleAdvertisingId in interface IAppboy
    
    Parameters:
    
    googleAdvertisingId - The Google Advertising ID.
    
    limitAdTrackingEnabled - Whether ad-tracking is enabled for the Google Advertising ID.
  - getDeviceId
```
public java.lang.String getDeviceId()
```
    Get the device ID - a randomly generated, app specific ID that is stored on the device. A new ID will be generated if the user clears the data for the app or removes/re-installs the app. The ID will persist across changeUser(String) calls.
    
    Returns:
    
    The device ID.
  - setOutboundNetworkRequestsOffline
```
public static void setOutboundNetworkRequestsOffline(boolean isOffline)
```
    Pauses or resumes outbound network requests from the Braze SDK at any point during runtime. Events are not lost during the offline state. Manual requests made from the Appboy singleton will also be offline. Single shot requests in offline mode, (such as templating, image, and file requests) are lost and will not be repeated later. Basically, everything that is not an event logged to a session will be lost.
    Offline mode defaults to false, meaning outbound network requests are enabled by default.
    The following is a breakdown of network behavior for various facets of the Braze SDK.
    For push, inbound push messages will still be received, but any network requests required to display the notification will not download. For example, if a push message contains a remote image url and text, only the text will display on the notification since the remote image won't be downloaded in offline mode.
    For in-app messages, any outbound network request for a non-cached image will not download and the in-app message will not display. Images that are locally cached will display normally in the in-app message. The Braze SDK does not display any in-app message where the required assets are not available. In offline mode, this means that any in-app message with images not cached locally will not display.
    For HTML in-app messages, zip asset files can't be downloaded in offline mode and thus the HTML in-app message won't be displayed. However, if the assets have already been downloaded, then the message will be displayed. Additionally, the WebView displaying the HTML in-app message will not respect the offline mode value. I.e., any outbound network requests originating from inside the HTML in-app message itself will proceed with no respect to the offline state. This is because these network requests are not handled by Appboy.
    For the News Feed, non-cached images will not be downloaded in offline mode. Images that are locally cached will display normally. Any WebView opened from a News Feed card will not respect the offline mode value. Thus network requests from inside a WebView opened from the News Feed will proceed without respect to the offline state.
    
    Parameters:
    
    isOffline - If true, sets the SDK to offline and pauses all outbound network requests. If false, all outbound network requests from the SDK are enabled.
  - getOutboundNetworkRequestsOffline
```
public static boolean getOutboundNetworkRequestsOffline()
```
    Returns:
    
    Whether outbound network requests from the Braze SDK are offline.
    
    See Also:
    
    setOutboundNetworkRequestsOffline(boolean)
  - setAppboyEndpointProvider
```
public static void setAppboyEndpointProvider(IAppboyEndpointProvider appboyEndpointProvider)
```
    Sets an IAppboyEndpointProvider to be used to route Braze API traffic
    Note that if a custom endpoint is specified using AppboyConfig.Builder#setCustomEndpoint(String) or via appboy.xml configuration, any IAppboyEndpointProvider previously set using this method will be overridden when the Appboy singleton initializes.
    
    Parameters:
    
    appboyEndpointProvider - The IAppboyEndpointProvider that will return the URI for routing Braze traffic
  - clearAppboyEndpointProvider
```
public static void clearAppboyEndpointProvider()
```
    Clear the currently set IAppboyEndpointProvider
  - getAppboyApiEndpoint
```
public static android.net.Uri getAppboyApiEndpoint(android.net.Uri appboyEndpoint)
```
    If an IAppboyEndpointProvider is configured, that provider's delegate is used to generate the Uri for the Braze API endpoint. Otherwise, return the Uri given.
    
    Parameters:
    
    appboyEndpoint - A Uri for a Braze API endpoint
    
    Returns:
    
    A Braze Api Endpoint Uri
  - setCustomAppboyNotificationFactory
```
public static void setCustomAppboyNotificationFactory(IAppboyNotificationFactory customAppboyNotificationFactory)
```
    Set a custom IAppboyNotificationFactory to be used to modify or create Braze push notifications.
    To ensure that your custom notification factory is always set before a notification is received, call this method in the Application.onCreate() method of your Application class.
    
    Parameters:
    
    customAppboyNotificationFactory - The IAppboyNotificationFactory that will return the notification to be displayed.
  - getCustomAppboyNotificationFactory
```
public static IAppboyNotificationFactory getCustomAppboyNotificationFactory()
```
    Returns the currently set custom IAppboyNotificationFactory or null.
  - configure
```
public static boolean configure(android.content.Context context,
                                AppboyConfig config)
```
    Optional static method to set configuration values for the Appboy singleton, overriding whatever values are present in the appboy.xml. To have effect, this MUST be called before any call to getInstance() in a given app run (in the onCreate() method of your application is a good place). Calling this method at the beginning of each app run is encouraged as clearing of application data (i.e. If the user clears all application data in the system settings) will reset the override value.
    
    Override values will persist through app runs. To clear the override cache, pass a null AppboyConfig object. Multiple calls to configure will merge together. For example, setting parameter A in one config calls and parameter B in another config call will result in both parameter A & B being present in the override cache.
    
    The Appboy singleton can only be configured once during the lifetime of the singleton.
    
    If you don't have a default API key value in your appboy.xml and you don't configure an API key before you attempt to call Appboy.getInstance(), Braze will throw a runtime exception upon initialization.
    
    Parameters:
    
    context - Application context
    
    config - An AppboyConfig to override any values in the `appboy.xml` configuration or from a previously set AppboyConfig
  - enableMockAppboyNetworkRequestsAndDropEventsMode
```
public static boolean enableMockAppboyNetworkRequestsAndDropEventsMode()
```
    Testing utility method that enables mocking for all Braze SDK network requests, essentially turning the SDK "off". Calls to the Braze server will be mocked and return success responses with no content (i.e. no in-app messages or News Feed cards will be received). All events dispatched while this mode is enabled will be dropped, meaning sessions or events logged while in this mode will almost certainly be lost. To have effect, this method MUST be called before any call to getInstance() in a given app run (in the onCreate() method of your application is a good place).
    This method is intended to be used for CI and other automated solutions, to prevent test data from polluting your Braze dashboard. This method should not be used in a production environment.
    
    Returns:
    
    true if this was called before the first call (and will have effect) to getInstance() or else false.
  - disableSdk
```
public static void disableSdk(android.content.Context context)
```
    Disables the Braze SDK. This call persists across Braze SDK instances until enableSdk(Context) is called.
    Any in-flight actions such as event logging, data syncing, etc. will be dropped and not retried as a result of this call.
    Any stored instances of Appboy should not be used. A new instance of getInstance(Context) should be obtained after this call.
    All network requests for subsequent invocations of the Braze SDK (including new instances) will be offline. To re-enable network requests and Braze SDK functionality, call enableSdk(Context).
  - enableSdk
```
public static void enableSdk(android.content.Context context)
```
    Enables the Braze SDK after an invocation of disableSdk(Context). Note that the Braze SDK is enabled by default.
    All network requests will be online as a result of this call.
  - wipeData
```
public static void wipeData(android.content.Context context)
```
    Hard resets all data created by the Braze SDK from the internal storage directory. Note that any in-flight actions such as event logging, data syncing, etc. will be cancelled as a result of this call.
    Note that any references to this Appboy instance will be unusable after this call. Subsequent calls to getInstance(Context) will be usable.

Class Appboy

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

openSession

closeSession

logCustomEvent

logCustomEvent

logPurchase

logPurchase

logPurchase

logPurchase

logPushNotificationOpened

logPushNotificationOpened

logPushDeliveryEvent

logPushNotificationActionClicked

logPushStoryPageClicked

logContentCardsDisplayed

logFeedDisplayed

requestFeedRefreshFromCache

requestFeedRefresh

requestContentCardsRefresh

requestImmediateDataFlush

subscribeToNewInAppMessages

subscribeToContentCardsUpdates

subscribeToFeedUpdates

removeSingleSubscription

changeUser

getCurrentUser

registerAppboyPushMessages

getAppboyPushMessageRegistrationId

getInstallTrackingId

getAppboyImageLoader

setAppboyImageLoader

getContentCardCount

getContentCardUnviewedCount

getContentCardsLastUpdatedInSecondsFromEpoch

getCachedContentCards

deserializeContentCard

deserializeContentCard

logFeedCardImpression

logFeedCardClick

deserializeInAppMessageString

setGoogleAdvertisingId

getDeviceId

setOutboundNetworkRequestsOffline

getOutboundNetworkRequestsOffline

setAppboyEndpointProvider

clearAppboyEndpointProvider

getAppboyApiEndpoint

setCustomAppboyNotificationFactory

getCustomAppboyNotificationFactory

configure

enableMockAppboyNetworkRequestsAndDropEventsMode

disableSdk

enableSdk

wipeData