com.iterable.iterableapi

Class IterableApi

java.lang.Object

com.iterable.iterableapi.IterableApi

public class IterableApi
extends java.lang.Object

Created by David Truong dt@iterable.com

Method Summary

Modifier and Type	Method and Description
void	clearInboxSessionId()
void	disablePush() Disables the device from push notifications
protected void	disableToken(java.lang.String email, java.lang.String userId, java.lang.String token)
protected void	disableToken(java.lang.String email, java.lang.String userId, java.lang.String authToken, java.lang.String deviceToken, IterableHelper.SuccessHandler onSuccess, IterableHelper.FailureHandler onFailure) Internal api call made from IterablePushRegistration after a registrationToken is obtained.
static void	getAndTrackDeeplink(java.lang.String uri, IterableHelper.IterableActionHandler onCallback) Tracks a click on the uri if it is an iterable link.
IterableAttributionInfo	getAttributionInfo() Returns the attribution information (IterableAttributionInfo) for last push open or app link click from an email.
IterableInAppManager	getInAppManager() Returns an IterableInAppManager that can be used to manage in-app messages.
static IterableApi	getInstance() Get IterableApi singleton instance
android.os.Bundle	getPayloadData() Retrieves all of the payload as a single Bundle Object
java.lang.String	getPayloadData(java.lang.String key) Retrieves the payload string for a given key.
static boolean	handleAppLink(java.lang.String uri) Handles an App Link For Iterable links, it will track the click and retrieve the original URL, pass it to IterableUrlHandler for handling If it's not an Iterable link, it just passes the same URL to IterableUrlHandler Call this from Activity.onCreate(Bundle) and Activity.onNewIntent(Intent) in your deep link handler activity
void	inAppConsume(IterableInAppMessage message, IterableInAppDeleteActionType source, IterableInAppLocation clickLocation) Tracks InApp delete.
void	inAppConsume(java.lang.String messageId) Consumes an InApp message.
static void	initialize(android.content.Context context, java.lang.String apiKey) Initializes IterableApi This method must be called from Application.onCreate() Note: Make sure you also call setEmail(String) or setUserId(String) before calling other methods
static void	initialize(android.content.Context context, java.lang.String apiKey, IterableConfig config) Initializes IterableApi This method must be called from Application.onCreate() Note: Make sure you also call setEmail(String) or setUserId(String) before calling other methods
boolean	isIterableIntent(android.content.Intent intent) Returns whether or not the intent was sent from Iterable.
static void	overrideURLEndpointPath(java.lang.String url) Debugging function to send API calls to different url endpoints.
void	registerDeviceToken(java.lang.String deviceToken) Registers a device token with Iterable.
protected void	registerDeviceToken(java.lang.String email, java.lang.String userId, java.lang.String authToken, java.lang.String applicationName, java.lang.String deviceToken, java.util.HashMap<java.lang.String,java.lang.String> deviceAttributes)
protected void	registerDeviceToken(java.lang.String email, java.lang.String userId, java.lang.String authToken, java.lang.String applicationName, java.lang.String deviceToken, org.json.JSONObject dataFields, java.util.HashMap<java.lang.String,java.lang.String> deviceAttributes) Registers the GCM registration ID with Iterable.
void	registerForPush() Registers for push notifications.
void	removeDeviceAttribute(java.lang.String key)
void	setDeviceAttribute(java.lang.String key, java.lang.String value)
void	setEmail(java.lang.String email) Set user email used for API calls Calling this or setUserId(String) is required before making any API calls.
void	setInboxSessionId(java.lang.String inboxSessionId)
void	setNotificationIcon(java.lang.String iconName) Sets the icon to be displayed in notifications.
void	setUserId(java.lang.String userId) Set user ID used for API calls Calling this or setEmail(String) is required before making any API calls.
void	track(java.lang.String eventName) Track an event.
void	track(java.lang.String eventName, int campaignId, int templateId) Track an event.
void	track(java.lang.String eventName, int campaignId, int templateId, org.json.JSONObject dataFields) Track an event.
void	track(java.lang.String eventName, org.json.JSONObject dataFields) Track an event.
void	trackInAppClick(IterableInAppMessage message, java.lang.String clickedUrl, IterableInAppLocation clickLocation) Tracks an InApp click.
void	trackInAppClick(java.lang.String messageId, java.lang.String clickedUrl) Tracks an InApp click.
void	trackInAppOpen(IterableInAppMessage message, IterableInAppLocation location) Tracks an in-app open.
void	trackInAppOpen(java.lang.String messageId) Tracks an in-app open.
void	trackInboxSession(IterableInboxSession session)
void	trackPurchase(double total, java.util.List<CommerceItem> items) Tracks a purchase.
void	trackPurchase(double total, java.util.List<CommerceItem> items, org.json.JSONObject dataFields) Tracks a purchase.
protected void	trackPushOpen(int campaignId, int templateId, java.lang.String messageId)
protected void	trackPushOpen(int campaignId, int templateId, java.lang.String messageId, org.json.JSONObject dataFields) Tracks when a push notification is opened on device.
void	updateEmail(java.lang.String newEmail) Updates the current user's email.
void	updateEmail(java.lang.String newEmail, IterableHelper.SuccessHandler successHandler, IterableHelper.FailureHandler failureHandler) Updates the current user's email.
void	updateSubscriptions(java.lang.Integer[] emailListIds, java.lang.Integer[] unsubscribedChannelIds, java.lang.Integer[] unsubscribedMessageTypeIds) Updates the user subscription preferences.
void	updateSubscriptions(java.lang.Integer[] emailListIds, java.lang.Integer[] unsubscribedChannelIds, java.lang.Integer[] unsubscribedMessageTypeIds, java.lang.Integer[] subscribedMessageTypeIDs, java.lang.Integer campaignId, java.lang.Integer templateId)
void	updateUser(org.json.JSONObject dataFields) Updates the current user.
void	updateUser(org.json.JSONObject dataFields, java.lang.Boolean mergeNestedObjects) Updates the current user.

Methods inherited from class java.lang.Object

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

Method Detail

setNotificationIcon

public void setNotificationIcon(@Nullable
                                java.lang.String iconName)

Sets the icon to be displayed in notifications. The icon name should match the resource name stored in the /res/drawable directory.

Parameters:

iconName -

getPayloadData

@Nullable
public java.lang.String getPayloadData(@NonNull
                                                 java.lang.String key)

Retrieves the payload string for a given key. Used for deeplinking and retrieving extra data passed down along with a campaign.

Parameters:

key -

Returns:

Returns the requested payload data from the current push campaign if it exists.

getPayloadData

@Nullable
public android.os.Bundle getPayloadData()

Retrieves all of the payload as a single Bundle Object

Returns:

Bundle

getInAppManager

@NonNull
public IterableInAppManager getInAppManager()

Returns an IterableInAppManager that can be used to manage in-app messages. Make sure the Iterable API is initialized before calling this method.

Returns:

IterableInAppManager instance

getAttributionInfo

@Nullable
public IterableAttributionInfo getAttributionInfo()

Returns the attribution information (IterableAttributionInfo) for last push open or app link click from an email.

Returns:

IterableAttributionInfo Object containing

setDeviceAttribute

public void setDeviceAttribute(java.lang.String key,
                               java.lang.String value)

removeDeviceAttribute

public void removeDeviceAttribute(java.lang.String key)

getInstance

@NonNull
public static IterableApi getInstance()

Get IterableApi singleton instance

Returns:

IterableApi singleton instance

initialize

public static void initialize(@NonNull
                              android.content.Context context,
                              @NonNull
                              java.lang.String apiKey)

Initializes IterableApi This method must be called from Application.onCreate() Note: Make sure you also call setEmail(String) or setUserId(String) before calling other methods

Parameters:

context - Application context

apiKey - Iterable Mobile API key

initialize

public static void initialize(@NonNull
                              android.content.Context context,
                              @NonNull
                              java.lang.String apiKey,
                              @Nullable
                              IterableConfig config)

Initializes IterableApi This method must be called from Application.onCreate() Note: Make sure you also call setEmail(String) or setUserId(String) before calling other methods

Parameters:

context - Application context

apiKey - Iterable Mobile API key

config - IterableConfig object holding SDK configuration options

setEmail

public void setEmail(@Nullable
                     java.lang.String email)

Set user email used for API calls Calling this or setUserId(String) is required before making any API calls. Note: This clears userId and persists the user email so you only need to call this once when the user logs in.

Parameters:

email - User email

setUserId

public void setUserId(@Nullable
                      java.lang.String userId)

Set user ID used for API calls Calling this or setEmail(String) is required before making any API calls. Note: This clears user email and persists the user ID so you only need to call this once when the user logs in.

Parameters:

userId - User ID

getAndTrackDeeplink

public static void getAndTrackDeeplink(@NonNull
                                       java.lang.String uri,
                                       @NonNull
                                       IterableHelper.IterableActionHandler onCallback)

Tracks a click on the uri if it is an iterable link.

Parameters:

uri - the

onCallback - Calls the callback handler with the destination location or the original url if it is not an Iterable link.

handleAppLink

public static boolean handleAppLink(@NonNull
                                    java.lang.String uri)

Handles an App Link For Iterable links, it will track the click and retrieve the original URL, pass it to IterableUrlHandler for handling If it's not an Iterable link, it just passes the same URL to IterableUrlHandler Call this from Activity.onCreate(Bundle) and Activity.onNewIntent(Intent) in your deep link handler activity

Parameters:

uri - the URL obtained from Intent.getData() in your deep link handler activity

Returns:

whether or not the app link was handled

overrideURLEndpointPath

public static void overrideURLEndpointPath(@NonNull
                                           java.lang.String url)

Debugging function to send API calls to different url endpoints.

Parameters:

url -

isIterableIntent

public boolean isIterableIntent(@Nullable
                                android.content.Intent intent)

Returns whether or not the intent was sent from Iterable.

registerDeviceToken

public void registerDeviceToken(@NonNull
                                java.lang.String deviceToken)

Registers a device token with Iterable. Make sure IterableConfig.pushIntegrationName is set before calling this.

Parameters:

deviceToken - Push token obtained from GCM or FCM

registerDeviceToken

protected void registerDeviceToken(@Nullable
                                   java.lang.String email,
                                   @Nullable
                                   java.lang.String userId,
                                   @Nullable
                                   java.lang.String authToken,
                                   @NonNull
                                   java.lang.String applicationName,
                                   @NonNull
                                   java.lang.String deviceToken,
                                   java.util.HashMap<java.lang.String,java.lang.String> deviceAttributes)

track

public void track(@NonNull
                  java.lang.String eventName)

Track an event.

Parameters:

eventName -

track

public void track(@NonNull
                  java.lang.String eventName,
                  @Nullable
                  org.json.JSONObject dataFields)

Track an event.

Parameters:

eventName -

dataFields -

track

public void track(@NonNull
                  java.lang.String eventName,
                  int campaignId,
                  int templateId)

Track an event.

Parameters:

eventName -

campaignId -

templateId -

track

public void track(@NonNull
                  java.lang.String eventName,
                  int campaignId,
                  int templateId,
                  @Nullable
                  org.json.JSONObject dataFields)

Track an event.

Parameters:

eventName -

campaignId -

templateId -

dataFields -

trackPurchase

public void trackPurchase(double total,
                          @NonNull
                          java.util.List<CommerceItem> items)

Tracks a purchase.

Parameters:

total - total purchase amount

items - list of purchased items

trackPurchase

public void trackPurchase(double total,
                          @NonNull
                          java.util.List<CommerceItem> items,
                          @Nullable
                          org.json.JSONObject dataFields)

Tracks a purchase.

Parameters:

total - total purchase amount

items - list of purchased items

dataFields - a `JSONObject` containing any additional information to save along with the event

updateEmail

public void updateEmail(@NonNull
                        java.lang.String newEmail)

Updates the current user's email. Also updates the current email in this IterableAPI instance if the API call was successful.

Parameters:

newEmail - New email

updateEmail

public void updateEmail(@NonNull
                        java.lang.String newEmail,
                        @Nullable
                        IterableHelper.SuccessHandler successHandler,
                        @Nullable
                        IterableHelper.FailureHandler failureHandler)

Updates the current user's email. Also updates the current email and authToken in this IterableAPI instance if the API call was successful.

Parameters:

newEmail - New email

successHandler - Success handler. Called when the server returns a success code.

failureHandler - Failure handler. Called when the server call failed.

updateUser

public void updateUser(@NonNull
                       org.json.JSONObject dataFields)

Updates the current user.

Parameters:

dataFields -

updateUser

public void updateUser(@NonNull
                       org.json.JSONObject dataFields,
                       java.lang.Boolean mergeNestedObjects)

Updates the current user.

Parameters:

dataFields -

mergeNestedObjects -

registerForPush

public void registerForPush()

Registers for push notifications. Make sure the API is initialized with IterableConfig.pushIntegrationName defined, and user email or user ID is set before calling this method.

disablePush

public void disablePush()

Disables the device from push notifications

updateSubscriptions

public void updateSubscriptions(@Nullable
                                java.lang.Integer[] emailListIds,
                                @Nullable
                                java.lang.Integer[] unsubscribedChannelIds,
                                @Nullable
                                java.lang.Integer[] unsubscribedMessageTypeIds)

Updates the user subscription preferences. Passing in an empty array will clear the list, passing in null will not modify the list

Parameters:

emailListIds -

unsubscribedChannelIds -

unsubscribedMessageTypeIds -

updateSubscriptions

public void updateSubscriptions(@Nullable
                                java.lang.Integer[] emailListIds,
                                @Nullable
                                java.lang.Integer[] unsubscribedChannelIds,
                                @Nullable
                                java.lang.Integer[] unsubscribedMessageTypeIds,
                                @Nullable
                                java.lang.Integer[] subscribedMessageTypeIDs,
                                java.lang.Integer campaignId,
                                java.lang.Integer templateId)

trackInAppOpen

public void trackInAppOpen(@NonNull
                           java.lang.String messageId)

Tracks an in-app open.

Parameters:

messageId -

trackInAppOpen

public void trackInAppOpen(@NonNull
                           IterableInAppMessage message,
                           @NonNull
                           IterableInAppLocation location)

Tracks an in-app open.

Parameters:

message - in-app message

trackInAppClick

public void trackInAppClick(@NonNull
                            java.lang.String messageId,
                            @NonNull
                            java.lang.String clickedUrl)

Tracks an InApp click.

Parameters:

messageId -

clickedUrl -

trackInAppClick

public void trackInAppClick(@NonNull
                            IterableInAppMessage message,
                            @NonNull
                            java.lang.String clickedUrl,
                            @NonNull
                            IterableInAppLocation clickLocation)

Tracks an InApp click.

Parameters:

message - in-app message

clickedUrl -

inAppConsume

public void inAppConsume(@NonNull
                         java.lang.String messageId)

Consumes an InApp message.

Parameters:

messageId -

inAppConsume

public void inAppConsume(@NonNull
                         IterableInAppMessage message,
                         @Nullable
                         IterableInAppDeleteActionType source,
                         @Nullable
                         IterableInAppLocation clickLocation)

Tracks InApp delete. This method from informs Iterable about inApp messages deleted with additional paramters. Call this method from places where inApp deletion are invoked by user. The messages can be swiped to delete or can be deleted using the link to delete button.

Parameters:

message - message object

source - An enum describing how the in App delete was triggered

clickLocation - The module in which the action happened

trackInboxSession

public void trackInboxSession(@NonNull
                              IterableInboxSession session)

trackPushOpen

protected void trackPushOpen(int campaignId,
                             int templateId,
                             @NonNull
                             java.lang.String messageId)

trackPushOpen

protected void trackPushOpen(int campaignId,
                             int templateId,
                             @NonNull
                             java.lang.String messageId,
                             @Nullable
                             org.json.JSONObject dataFields)

Tracks when a push notification is opened on device.

Parameters:

campaignId -

templateId -

disableToken

protected void disableToken(@Nullable
                            java.lang.String email,
                            @Nullable
                            java.lang.String userId,
                            @NonNull
                            java.lang.String token)

disableToken

protected void disableToken(@Nullable
                            java.lang.String email,
                            @Nullable
                            java.lang.String userId,
                            @Nullable
                            java.lang.String authToken,
                            @NonNull
                            java.lang.String deviceToken,
                            @Nullable
                            IterableHelper.SuccessHandler onSuccess,
                            @Nullable
                            IterableHelper.FailureHandler onFailure)

Internal api call made from IterablePushRegistration after a registrationToken is obtained. It disables the device for all users with this device by default. If `email` or `userId` is provided, it will disable the device for the specific user.

Parameters:

email - User email for whom to disable the device.

userId - User ID for whom to disable the device.

authToken -

deviceToken - The device token

registerDeviceToken

protected void registerDeviceToken(@Nullable
                                   java.lang.String email,
                                   @Nullable
                                   java.lang.String userId,
                                   @Nullable
                                   java.lang.String authToken,
                                   @NonNull
                                   java.lang.String applicationName,
                                   @NonNull
                                   java.lang.String deviceToken,
                                   @Nullable
                                   org.json.JSONObject dataFields,
                                   java.util.HashMap<java.lang.String,java.lang.String> deviceAttributes)

Registers the GCM registration ID with Iterable.

Parameters:

authToken -

applicationName -

deviceToken -

dataFields -

setInboxSessionId

public void setInboxSessionId(@Nullable
                              java.lang.String inboxSessionId)

clearInboxSessionId

public void clearInboxSessionId()