IAppboy (Braze Android SDK 8.1.0)

All Known Implementing Classes:

Appboy
```
public interface IAppboy
```
The public interface for the Braze SDK. This interface is used to send and receive data to and from Braze.
Overview
To use this class properly, follow the pattern below:
1. Add your Braze API key to your appboy.xml file or call Appboy.configure(Context, AppboyConfig) with your Braze API key.
2. Create an IAppboy instance by calling Appboy.getInstance(android.content.Context).
3. Call openSession(android.app.Activity) and closeSession(android.app.Activity) in your Activity's onStart() and onStop() respectively.
During the course of the application you may call Appboy.getInstance(android.content.Context) multiple times and with different Activities. Braze uses the initial Activity that is passed in and grabs the Application context, which it then uses for the length of the process.
```
   
   // Creating an IAppboy instance
   IAppboy appboy = Appboy.getInstance(this);
   
 
```
```
   
   // The Braze API key is read from the appboy.xml file. Be sure to include the 'com_appboy_api_key' string resource.
   <resources>
     <string translatable="false" name="com_appboy_api_key">YOUR-API-KEY</string>
       ...
   
 
```
Automatic Session Handling
In your Application class, you can register an instance of an AppboyLifecycleCallbackListener to automatically listen for activity lifecycle callbacks. The listener can call openSession(Activity) and closeSession(Activity) in every Activity and can additionally register for in-app messages.
```
   

   public class MyApplication extends Application {
     @Override
     public void onCreate() {
       super.onCreate();
       registerActivityLifecycleCallbacks(new AppboyLifecycleCallbackListener());
     }
   }
   
 
```
Manual Session Handling
It's imperative that you call openSession(Activity) and closeSession(Activity) in every Activity. Check your AndroidManifest.xml file for the list of Activities defined in your app and be sure to add these two method calls in the manner shown below. Forgetting to add them may result in incorrect session count.
```
   

   @Override
   public void onStart() {
     super.onStart();
     // Opens a new Braze session.
     Appboy.getInstance(this).openSession(this);
   }

   @Override
   public void onStop() {
     // Closes the Braze session.
     Appboy.getInstance(this).closeSession(this);
     super.onStop();
   }
   
 
```
Configurable Api Key (Optional)
To manually set an Braze API key for the Braze singleton and override whatever API key is present in the appboy.xml, use Appboy.configure(this, appboyConfig) with a properly configured appboyConfig object before the first call to Appboy.getInstance(this) is made. Appboy.configure() should be called in the onCreate() of your Application subclass.
```
   

 public class MyApplication extends Application {
   @Override
   public void onCreate() {
     super.onCreate();
     ...
     // Sets the api key in code, overriding the xml defined key
     AppboyConfig appboyConfig = new AppboyConfig.Builder()
       .setApiKey("your-api-key")
       .build();
     Appboy.configure(this, appboyConfig);
   }
 }

   
 
```
However, this is not suggested if you have long running code to determine the API key. Disk reads and writes, slow or blocking code, and network requests are examples of things that should be avoided.

If the provided value is null, then the api key found in the appboy.xml will be used.

An Braze API key value set by this method is sticky across application opens. I.e. whatever Braze API key is set by this method will be used for all future uses of the application unless the user clears their app data.

To manually clear the cached value for the Braze API key set by this method, pass null as the Braze API key. The Braze API key then used will be the default Braze API key found in the appboy.xml.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated 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".
`void`	`closeSession(android.app.Activity activity)` Closes the current session.
`Card`	`deserializeContentCard(org.json.JSONObject contentCardJson)` Constructs a Content Card from its `Card.forJsonPut()` output.
`Card`	`deserializeContentCard(java.lang.String contentCardString)` Helper method for `deserializeContentCard(JSONObject)`.
`IInAppMessage`	`deserializeInAppMessageString(java.lang.String inAppMessageString)` This function returns a deserialized in-app message from the message JSON string.
`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.
`void`	`getCurrentUser(IValueCallback<AppboyUser> completionCallback)` Returns the user currently being tracked by Braze.
`java.lang.String`	`getInstallTrackingId()` Returns a unique device ID for install tracking.
`void`	`logContentCardsDisplayed()` Reports that Content Cards were displayed.
`void`	`logCustomEvent(java.lang.String eventName)` Reports a custom named event.
`void`	`logCustomEvent(java.lang.String eventName, AppboyProperties properties)` Reports a custom named event.
`void`	`logFeedCardClick(java.lang.String cardId)` Deprecated. Please call `Card.logClick()` instead to log a click. Reports a feed card was clicked.
`void`	`logFeedCardImpression(java.lang.String cardId)` Deprecated. Please call `Card.logImpression()` instead to log an impression. Reports a feed card was displayed to the user. Card impressions tracks how many times a card has been seen. Impressions should only be reported once the card becomes viewable to the user. Cards that are part of the stream but not visible should not log a card impression. If a card is viewed more than once in a particular view, it generates only one impression. If closed and reopened, a card will again generate an impression.
`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 productId, java.lang.String currencyCode, java.math.BigDecimal price, int quantity, AppboyProperties properties)` Reports that the current user made an in app purchase.
`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`	`requestGeofences(double latitude, double longitude)` Requests a refresh of Braze Geofences for the specified GPS coordinate.
`void`	`requestImmediateDataFlush()` Requests an immediate flush of any analytics data waiting to be sent to Appboy's servers.
`void`	`setAppboyImageLoader(IAppboyImageLoader appboyImageLoader)` Sets the `IAppboyImageLoader` for the Braze instance.
`void`	`setGoogleAdvertisingId(java.lang.String googleAdvertisingId, boolean isLimitAdTrackingEnabled)` Sets the Google Advertising ID and associated ad-tracking enabled field for this device.
`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.
`void`	`subscribeToSessionUpdates(IEventSubscriber<SessionStateChangedEvent> subscriber)` Subscribes to Session start and close events.

- Method Detail
  - openSession
```
void openSession(android.app.Activity activity)
```
    Opens a new session or resumes the previous session. A call to openSession(Activity) within the session timeout of a call to 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.
    
    Parameters:
    
    activity - The current Activity.
  - closeSession
```
void closeSession(android.app.Activity activity)
```
    Closes the current session. The session may be reopened if a call is made to openSession(Activity) within the session timeout. This must be called every the Activity's onStop method if using a manual session handling integration.
    
    Parameters:
    
    activity - The current Activity.
  - logCustomEvent
```
void logCustomEvent(java.lang.String eventName)
```
    Reports a custom named event.
    
    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).
  - logCustomEvent
```
void logCustomEvent(java.lang.String eventName,
                    AppboyProperties properties)
```
    Reports a custom named event.
    
    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).
    
    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.
  - logPurchase
```
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). Using this method will by default log a purchase with a quantity of one.
    
    See Also:
    
    logPurchase(String, String, java.math.BigDecimal, int)
  - logPurchase
```
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). Using this method will by default log a purchase with a quantity of one.
    
    See Also:
    
    logPurchase(String, String, java.math.BigDecimal, int, AppboyProperties)
  - logPurchase
```
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).
    
    See Also:
    
    logPurchase(String, String, java.math.BigDecimal, int, AppboyProperties)
  - logPurchase
```
void logPurchase(java.lang.String productId,
                 java.lang.String currencyCode,
                 java.math.BigDecimal price,
                 int quantity,
                 AppboyProperties properties)
```
    Reports that the current user made an in app purchase. Useful for tracking and segmenting users more likely to make purchases.
    
    Parameters:
    
    productId - The String identifier for the product purchased. Usually the Google Play SKU.
    
    currencyCode - 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));
  - logPushNotificationOpened
```
void logPushNotificationOpened(java.lang.String campaignId)
```
    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.
    
    Parameters:
    
    campaignId - The ID of the campaign that triggered the push notification. This can be found as an extra in the push notification intent.
  - logPushNotificationOpened
```
void logPushNotificationOpened(android.content.Intent intent)
```
    Reports that the user clicked on the push notification. Note that integrations shouldn't be calling this method directly.
    
    Parameters:
    
    intent - The push notification intent.
  - logPushNotificationActionClicked
```
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.
    
    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.
  - logPushStoryPageClicked
```
void logPushStoryPageClicked(java.lang.String campaignId,
                             java.lang.String pageId)
```
    Reports that the user clicked on a push story page.
    
    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.
  - logContentCardsDisplayed
```
void logContentCardsDisplayed()
```
    Reports that Content Cards were displayed.
  - logFeedDisplayed
```
void logFeedDisplayed()
```
    Reports that the feed was displayed.
  - requestContentCardsRefresh
```
void requestContentCardsRefresh(boolean fromCache)
```
    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 subscribeToContentCardsUpdates(IEventSubscriber)
    
    If the network call returns before any subscribers are active, the result will be lost.
    
    Parameters:
    
    fromCache - whether to request data from offline storage.
  - requestFeedRefresh
```
void requestFeedRefresh()
```
    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.
  - requestFeedRefreshFromCache
```
void requestFeedRefreshFromCache()
```
    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 requestFeedRefresh().
  - requestImmediateDataFlush
```
void requestImmediateDataFlush()
```
    Requests an immediate flush of any analytics data waiting to be sent to Appboy's servers.
  - subscribeToContentCardsUpdates
```
void subscribeToContentCardsUpdates(IEventSubscriber<ContentCardsUpdatedEvent> subscriber)
```
    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 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.
    
    Parameters:
    
    subscriber - A callback that will be executed when Content Cards are updated.
  - subscribeToFeedUpdates
```
void subscribeToFeedUpdates(IEventSubscriber<FeedUpdatedEvent> subscriber)
```
    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 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.
    
    Parameters:
    
    subscriber - A callback that should be executed when the news feed is updated.
  - subscribeToNewInAppMessages
```
void subscribeToNewInAppMessages(IEventSubscriber<InAppMessageEvent> subscriber)
```
    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 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.
    
    Parameters:
    
    subscriber - A callback that should be executed when the news feed is updated.
  - subscribeToSessionUpdates
```
void subscribeToSessionUpdates(IEventSubscriber<SessionStateChangedEvent> subscriber)
```
    Subscribes to Session start and close events. The subscriber callback will be called when a session is created or sealed. The subscriber will be called with a SessionStateChangedEvent.
    
    For reference, a session is created or sealed only once.
    
    Subscriptions should be cleaned up manually by calling 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.
    
    Parameters:
    
    subscriber - A callback that will be executed when a session is created or sealed.
  - removeSingleSubscription
```
<T> void removeSingleSubscription(IEventSubscriber<T> subscriber,
                                  java.lang.Class<T> eventClass)
```
    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.
    
    Parameters:
    
    subscriber - The callback which is currently subscribed.
    
    eventClass - The Event class which this IEventSubscriber is subscribed to.
  - changeUser
```
void changeUser(java.lang.String userId)
```
    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 getCurrentUser().
    
    Parameters:
    
    userId - An external user identifier. May not be longer than Constants.USER_ID_MAX_LENGTH_BYTES.
    
    See Also:
    
    getCurrentUser()
  - getCurrentUser
```
AppboyUser getCurrentUser()
```
    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.
    
    Note that this method will block the caller thread until the current AppboyUser is available. Please use getCurrentUser(IValueCallback) for the asynchronous version of this method.
  - getCurrentUser
```
void getCurrentUser(IValueCallback<AppboyUser> completionCallback)
```
    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.
    
    Note that this method is asynchronous and will not block the caller thread. Please use getCurrentUser() for the synchronous version of this method.
    
    Parameters:
    
    completionCallback - that has IValueCallback.onSuccess(T) called with a non-null AppboyUser or IValueCallback.onError() called otherwise.
  - registerAppboyPushMessages
```
void registerAppboyPushMessages(java.lang.String registrationId)
```
    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.
    
    Parameters:
    
    registrationId - The registration ID, or for apps integrating Baidu Cloud Push, the Baidu user id
  - getAppboyPushMessageRegistrationId
```
java.lang.String getAppboyPushMessageRegistrationId()
```
    Returns the FCM/ADM/Baidu registration Id used to send the device push messages.
  - getInstallTrackingId
```
java.lang.String getInstallTrackingId()
```
    Returns a unique device ID for install tracking.
  - getAppboyImageLoader
```
IAppboyImageLoader getAppboyImageLoader()
```
    Returns the IAppboyImageLoader for the Braze instance.
  - setAppboyImageLoader
```
void setAppboyImageLoader(IAppboyImageLoader appboyImageLoader)
```
    Sets the IAppboyImageLoader for the Braze instance. This IAppboyImageLoader is used for all image related
    
    Parameters:
    
    appboyImageLoader - The image loader to be set for the Braze instance. If null, then the existing image loader is unchanged.
  - getContentCardCount
```
int getContentCardCount()
```
    Retrieves information about Content Cards based on the currently cached data.
    
    Note that this method is synchronous and will block the current running thread.
    
    Returns:
    
    The total number of cached Content Cards. If Content Cards information cannot be retrieved, returns -1.
    
    See Also:
    
    requestContentCardsRefresh(boolean)
  - getContentCardUnviewedCount
```
int getContentCardUnviewedCount()
```
    Retrieves information about Content Cards based on the currently cached data.
    
    Note that this method is synchronous and will block the current running thread.
    
    Returns:
    
    The number of cached unviewed Content Cards. If Content Cards information cannot be retrieved, returns -1.
    
    See Also:
    
    requestContentCardsRefresh(boolean)
  - getContentCardsLastUpdatedInSecondsFromEpoch
```
long getContentCardsLastUpdatedInSecondsFromEpoch()
```
    Retrieves information about Content Cards based on the currently cached data.
    
    Note that this method is synchronous and will block the current running thread.
    
    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:
    
    requestContentCardsRefresh(boolean)
  - getCachedContentCards
```
java.util.List<Card> getCachedContentCards()
```
    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.
    
    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.
  - setGoogleAdvertisingId
```
void setGoogleAdvertisingId(java.lang.String googleAdvertisingId,
                            boolean isLimitAdTrackingEnabled)
```
    Sets the Google Advertising ID and associated ad-tracking enabled field for this device. Note that the SDK does not automatically collect this data.
    
    Parameters:
    
    googleAdvertisingId - The Google Advertising ID.
    
    isLimitAdTrackingEnabled - Whether ad-tracking is enabled for the Google Advertising ID.
  - deserializeInAppMessageString
```
IInAppMessage deserializeInAppMessageString(java.lang.String inAppMessageString)
```
    This function returns a deserialized in-app message from the message JSON string.
    
    Parameters:
    
    inAppMessageString - The in-app message JSON string
  - deserializeContentCard
```
Card deserializeContentCard(java.lang.String contentCardString)
```
    Helper method for deserializeContentCard(JSONObject).
    
    Parameters:
    
    contentCardString - The string content of a Content Card's JSONObject obtained via JSONObject.toString().
  - deserializeContentCard
```
Card deserializeContentCard(org.json.JSONObject contentCardJson)
```
    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.
    
    Parameters:
    
    contentCardJson - The JSONObject representation of a Content Card as obtained via Card.forJsonPut().
  - requestGeofences
```
void requestGeofences(double latitude,
                      double longitude)
```
    Requests a refresh of Braze Geofences for the specified GPS coordinate.
    
    Note that Braze Geofences can be requested (either manually here or automatically by default) a max of 1 times per session. To be sure that this method has an effect, you should disable Braze Geofences from being automatically requested on session start in your configuration.
    
    This method should be called after location permissions have be provided to the SDK and after a session has been started.
    
    Parameters:
    
    latitude - A valid GPS latitude in range (-90, 90)
    
    longitude - A valid GPS longitude in range (-180, 180)
    
    See Also:
    
    AppboyConfig.Builder#setAutomaticGeofenceRequestsEnabled(boolean), ValidationUtils.isValidLocation(double, double)
  - logFeedCardImpression
```
@Deprecated
void logFeedCardImpression(java.lang.String cardId)
```
    Deprecated. Please call Card.logImpression() instead to log an impression.
    
    Reports a feed card was displayed to the user.
    
    Card impressions tracks how many times a card has been seen. Impressions should only be reported once the card becomes viewable to the user. Cards that are part of the stream but not visible should not log a card impression. If a card is viewed more than once in a particular view, it generates only one impression. If closed and reopened, a card will again generate an impression.
    
    Parameters:
    
    cardId - The ID of the feed card.
    
    See Also:
    
    Card.logImpression()
  - logFeedCardClick
```
@Deprecated
void logFeedCardClick(java.lang.String cardId)
```
    Deprecated. Please call Card.logClick() instead to log a click.
    
    Reports a feed card was clicked.
    
    Parameters:
    
    cardId - The ID of the feed card.
    
    See Also:
    
    Card.logClick()

Interface IAppboy

Overview

Automatic Session Handling

Manual Session Handling

Configurable Api Key (Optional)

Method Summary

Method Detail

openSession

closeSession

logCustomEvent

logCustomEvent

logPurchase

logPurchase

logPurchase

logPurchase

logPushNotificationOpened

logPushNotificationOpened

logPushNotificationActionClicked

logPushStoryPageClicked

logContentCardsDisplayed

logFeedDisplayed

requestContentCardsRefresh

requestFeedRefresh

requestFeedRefreshFromCache

requestImmediateDataFlush

subscribeToContentCardsUpdates

subscribeToFeedUpdates

subscribeToNewInAppMessages

subscribeToSessionUpdates

removeSingleSubscription

changeUser

getCurrentUser

getCurrentUser

registerAppboyPushMessages

getAppboyPushMessageRegistrationId

getInstallTrackingId

getAppboyImageLoader

setAppboyImageLoader

getContentCardCount

getContentCardUnviewedCount

getContentCardsLastUpdatedInSecondsFromEpoch

getCachedContentCards

setGoogleAdvertisingId

deserializeInAppMessageString

deserializeContentCard

deserializeContentCard

requestGeofences

logFeedCardImpression

logFeedCardClick