com.blueshift

Class Blueshift

java.lang.Object

com.blueshift.Blueshift

public class Blueshift
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Blueshift.DeviceIdSource

Method Summary

Modifier and Type	Method and Description
void	displayInAppMessages()
void	fetchInAppMessages(InAppApiCallback callback)
static BlueshiftInAppListener	getBlueshiftInAppListener()
static BlueshiftPushListener	getBlueshiftPushListener()
Configuration	getConfiguration() Method to get the current configuration
org.json.JSONObject	getInAppMessageAPIRequestPayload(android.content.Context context)
static Blueshift	getInstance(android.content.Context context) This method return the only object of the class Blueshift
void	getLiveContentByCustomerId(java.lang.String slot, java.util.HashMap<java.lang.String,java.lang.Object> liveContentContext, LiveContentCallback callback)
void	getLiveContentByCustomerId(java.lang.String slot, LiveContentCallback callback)
void	getLiveContentByDeviceId(java.lang.String slot, java.util.HashMap<java.lang.String,java.lang.Object> liveContentContext, LiveContentCallback callback)
void	getLiveContentByDeviceId(java.lang.String slot, LiveContentCallback callback)
void	getLiveContentByEmail(java.lang.String slot, java.util.HashMap<java.lang.String,java.lang.Object> liveContentContext, LiveContentCallback callback)
void	getLiveContentByEmail(java.lang.String slot, LiveContentCallback callback)
void	handleInAppMessageAPIResponse(android.content.Context context, java.lang.String response)
static boolean	hasPermission(android.content.Context context, java.lang.String permission)
void	identifyUser(java.util.HashMap<java.lang.String,java.lang.Object> details, boolean canBatchThisEvent) This method fires an identify event that fills in customer identifiers from user info and device info
void	identifyUserByCustomerId(java.lang.String customerId, java.util.HashMap<java.lang.String,java.lang.Object> details, boolean canBatchThisEvent) Helps trigger identify user api call using key 'retailer_customer_id'.
void	identifyUserByDeviceId(java.lang.String androidAdId, java.util.HashMap<java.lang.String,java.lang.Object> details, boolean canBatchThisEvent) Helps trigger identify user api call using key 'device_identifier'.
void	identifyUserByEmail(java.lang.String email, java.util.HashMap<java.lang.String,java.lang.Object> details, boolean canBatchThisEvent) Helps trigger identify user api call using key 'email'.
void	initialize(Configuration configuration) This method initializes the sdk with the configuration set by user
static boolean	isTrackingEnabled(android.content.Context context)
static void	optInForInAppNotifications(android.content.Context context, boolean isOptedIn) Utility method to set in-app opt-in status.
static void	optInForPushNotifications(android.content.Context context, boolean isOptedIn) Utility method to set push opt-in status.
void	registerForInAppMessages(android.app.Activity activity)
void	registerForInAppMessages(android.app.Activity activity, java.lang.String screenName)
void	resetDeviceId() Reset uuid which is being sent as device_id for this app
static void	setBlueshiftInAppListener(BlueshiftInAppListener inAppListener)
static void	setBlueshiftPushListener(BlueshiftPushListener pushListener)
void	setInAppActionCallback(InAppActionCallback callback)
static void	setTrackingEnabled(android.content.Context context, boolean isEnabled) Enable/disable the event tracking done by the SDK.
static void	setTrackingEnabled(android.content.Context context, boolean isEnabled, boolean shouldRemoveEvents) Enable/disable the event tracking done by the SDK.
void	trackAddToCart(java.lang.String sku, int quantity, boolean canBatchThisEvent)
void	trackAddToCart(java.lang.String sku, int quantity, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackAlertDismiss(Message message, boolean canBatchThisEvent)
void	trackAlertDismiss(java.lang.String notificationId, boolean canBatchThisEvent)
void	trackAlertDismiss(java.lang.String notificationId, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackAppInstall(java.lang.String referrer, boolean canBatchThisEvent) Method to track the campaign measurement
void	trackAppOpen(boolean canBatchThisEvent)
void	trackAppOpen(java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackCheckoutCart(Product[] products, float revenue, float discount, java.lang.String coupon, boolean canBatchThisEvent)
void	trackCheckoutCart(Product[] products, float revenue, float discount, java.lang.String coupon, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackEmailListSubscription(java.lang.String email, boolean canBatchThisEvent)
void	trackEmailListSubscription(java.lang.String email, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackEmailListUnsubscription(java.lang.String email, boolean canBatchThisEvent)
void	trackEmailListUnsubscription(java.lang.String email, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackEvent(java.lang.String eventName, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent) Method to send generic events
void	trackInAppMessageClick(InAppMessage inAppMessage, org.json.JSONObject extraJson)
void	trackInAppMessageDelivered(InAppMessage inAppMessage)
void	trackInAppMessageView(InAppMessage inAppMessage)
void	trackNotificationClick(Message message)
void	trackNotificationClick(Message message, java.util.HashMap<java.lang.String,java.lang.Object> extras)
void	trackNotificationClick(java.lang.String notificationId)
void	trackNotificationClick(java.lang.String notificationId, java.util.HashMap<java.lang.String,java.lang.Object> params)
void	trackNotificationPageOpen(Message message, boolean canBatchThisEvent)
void	trackNotificationPageOpen(java.lang.String notificationId, boolean canBatchThisEvent)
void	trackNotificationPageOpen(java.lang.String notificationId, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackNotificationView(Message message)
void	trackNotificationView(java.lang.String notificationId)
void	trackNotificationView(java.lang.String notificationId, java.util.HashMap<java.lang.String,java.lang.Object> params)
void	trackProductSearch(java.lang.String[] skus, int numberOfResults, int pageNumber, java.lang.String query, boolean canBatchThisEvent)
void	trackProductSearch(java.lang.String[] skus, int numberOfResults, int pageNumber, java.lang.String query, java.util.HashMap<java.lang.String,java.lang.Object> filters, boolean canBatchThisEvent)
void	trackProductSearch(java.lang.String[] skus, int numberOfResults, int pageNumber, java.lang.String query, java.util.HashMap<java.lang.String,java.lang.Object> filters, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackProductsPurchase(java.lang.String orderId, Product[] products, float revenue, float shippingCost, float discount, java.lang.String coupon, boolean canBatchThisEvent)
void	trackProductsPurchase(java.lang.String orderId, Product[] products, float revenue, float shippingCost, float discount, java.lang.String coupon, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackProductView(java.lang.String sku, boolean canBatchThisEvent)
void	trackProductView(java.lang.String sku, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackProductView(java.lang.String sku, int categoryId, boolean canBatchThisEvent)
void	trackProductView(java.lang.String sku, int categoryId, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackPurchaseCancel(java.lang.String orderId, boolean canBatchThisEvent)
void	trackPurchaseCancel(java.lang.String orderId, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackPurchaseReturn(java.lang.String orderId, Product[] products, boolean canBatchThisEvent)
void	trackPurchaseReturn(java.lang.String orderId, Product[] products, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackScreenView(android.app.Activity activity, boolean canBatchThisEvent)
void	trackScreenView(java.lang.String screenName, boolean canBatchThisEvent)
void	trackSubscriptionCancel(boolean canBatchThisEvent)
void	trackSubscriptionCancel(java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackSubscriptionInitialization(SubscriptionState subscriptionState, java.lang.String cycleType, int cycleLength, java.lang.String subscriptionType, float price, long startDate, boolean canBatchThisEvent)
void	trackSubscriptionInitialization(SubscriptionState subscriptionState, java.lang.String cycleType, int cycleLength, java.lang.String subscriptionType, float price, long startDate, java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackSubscriptionPause(boolean canBatchThisEvent)
void	trackSubscriptionPause(java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	trackSubscriptionUnpause(boolean canBatchThisEvent)
void	trackSubscriptionUnpause(java.util.HashMap<java.lang.String,java.lang.Object> params, boolean canBatchThisEvent)
void	unregisterForInAppMessages(android.app.Activity activity)
static void	updateDeviceToken(java.lang.String deviceToken) Updates the sDeviceParams with new device token

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Blueshift getInstance(android.content.Context context)

This method return the only object of the class Blueshift

Parameters:

context - valid context object

Returns:

instance of Blueshift

setTrackingEnabled

public static void setTrackingEnabled(android.content.Context context,
                                      boolean isEnabled)

Enable/disable the event tracking done by the SDK. By default, the tracking is enabled.

When disabled, no new events will be added to the queue. Also, any unsent events (batched and realtime) will be deleted from the SDK's database immediately.

Parameters:

context - valid context object

isEnabled - the value that decides if the SDK should be enabled (true) or disabled (false)

Since:

3.1.10

setTrackingEnabled

public static void setTrackingEnabled(android.content.Context context,
                                      boolean isEnabled,
                                      boolean shouldRemoveEvents)

Enable/disable the event tracking done by the SDK. By default, the tracking is enabled.

Parameters:

context - valid context object

isEnabled - the value that decides if the SDK should be enabled (true) or disabled (false).

shouldRemoveEvents - the value that decided if the SDK should remove unsent events from it's database.

Since:

3.1.10

isTrackingEnabled

public static boolean isTrackingEnabled(android.content.Context context)

optInForInAppNotifications

public static void optInForInAppNotifications(android.content.Context context,
                                              boolean isOptedIn)

Utility method to set in-app opt-in status. This method will send an identify event with the latest information.

Parameters:

context - Valid Context object

isOptedIn - The opt-in status as boolean

optInForPushNotifications

public static void optInForPushNotifications(android.content.Context context,
                                             boolean isOptedIn)

Utility method to set push opt-in status. This method will send an identify event with the latest information.

Parameters:

context - Valid Context object

isOptedIn - The opt-in status as boolean

getBlueshiftPushListener

public static BlueshiftPushListener getBlueshiftPushListener()

getBlueshiftInAppListener

public static BlueshiftInAppListener getBlueshiftInAppListener()

setBlueshiftPushListener

public static void setBlueshiftPushListener(BlueshiftPushListener pushListener)

setBlueshiftInAppListener

public static void setBlueshiftInAppListener(BlueshiftInAppListener inAppListener)

registerForInAppMessages

public void registerForInAppMessages(android.app.Activity activity)

registerForInAppMessages

public void registerForInAppMessages(android.app.Activity activity,
                                     java.lang.String screenName)

unregisterForInAppMessages

public void unregisterForInAppMessages(android.app.Activity activity)

fetchInAppMessages

public void fetchInAppMessages(InAppApiCallback callback)

displayInAppMessages

public void displayInAppMessages()

setInAppActionCallback

public void setInAppActionCallback(InAppActionCallback callback)

handleInAppMessageAPIResponse

public void handleInAppMessageAPIResponse(android.content.Context context,
                                          java.lang.String response)

getInAppMessageAPIRequestPayload

public org.json.JSONObject getInAppMessageAPIRequestPayload(android.content.Context context)

resetDeviceId

public void resetDeviceId()

Reset uuid which is being sent as device_id for this app

updateDeviceToken

public static void updateDeviceToken(java.lang.String deviceToken)

Updates the sDeviceParams with new device token

Parameters:

deviceToken - device token for sending push message

hasPermission

public static boolean hasPermission(android.content.Context context,
                                    java.lang.String permission)

getLiveContentByEmail

public void getLiveContentByEmail(java.lang.String slot,
                                  LiveContentCallback callback)

getLiveContentByDeviceId

public void getLiveContentByDeviceId(java.lang.String slot,
                                     LiveContentCallback callback)

getLiveContentByCustomerId

public void getLiveContentByCustomerId(java.lang.String slot,
                                       LiveContentCallback callback)

getLiveContentByEmail

public void getLiveContentByEmail(java.lang.String slot,
                                  java.util.HashMap<java.lang.String,java.lang.Object> liveContentContext,
                                  LiveContentCallback callback)

getLiveContentByDeviceId

public void getLiveContentByDeviceId(java.lang.String slot,
                                     java.util.HashMap<java.lang.String,java.lang.Object> liveContentContext,
                                     LiveContentCallback callback)

getLiveContentByCustomerId

public void getLiveContentByCustomerId(java.lang.String slot,
                                       java.util.HashMap<java.lang.String,java.lang.Object> liveContentContext,
                                       LiveContentCallback callback)

initialize

public void initialize(Configuration configuration)

This method initializes the sdk with the configuration set by user

Parameters:

configuration - this object contains all the mandatory parameters like api key, deep-link pages etc.

getConfiguration

public Configuration getConfiguration()

Method to get the current configuration

Returns:

configuration

trackEvent

public void trackEvent(java.lang.String eventName,
                       java.util.HashMap<java.lang.String,java.lang.Object> params,
                       boolean canBatchThisEvent)

Method to send generic events

Parameters:

eventName - name of the event

params - hash map with valid parameters

canBatchThisEvent - flag to indicate if this event can be sent in bulk event API

trackAppInstall

public void trackAppInstall(java.lang.String referrer,
                            boolean canBatchThisEvent)

Method to track the campaign measurement

Parameters:

referrer - the referrer url sent by playstore app

canBatchThisEvent - flag to indicate if this event can be sent in bulk event API

identifyUser

public void identifyUser(java.util.HashMap<java.lang.String,java.lang.Object> details,
                         boolean canBatchThisEvent)

This method fires an identify event that fills in customer identifiers from user info and device info

Parameters:

details - optional additional parameters

canBatchThisEvent - flag to indicate if this event can be sent in bulk event API

identifyUserByCustomerId

public void identifyUserByCustomerId(java.lang.String customerId,
                                     java.util.HashMap<java.lang.String,java.lang.Object> details,
                                     boolean canBatchThisEvent)

Helps trigger identify user api call using key 'retailer_customer_id'.

Parameters:

customerId - if provided, replaces existing one (taken from UserInfo) inside request params.

details - optional additional parameters

canBatchThisEvent - flag to indicate if this event can be sent in bulk event API

identifyUserByDeviceId

public void identifyUserByDeviceId(java.lang.String androidAdId,
                                   java.util.HashMap<java.lang.String,java.lang.Object> details,
                                   boolean canBatchThisEvent)

Helps trigger identify user api call using key 'device_identifier'.

Parameters:

androidAdId - android ad id provided by host/customer app.

details - optional additional parameters

canBatchThisEvent - flag to indicate if this event can be sent in bulk event API

identifyUserByEmail

public void identifyUserByEmail(java.lang.String email,
                                java.util.HashMap<java.lang.String,java.lang.Object> details,
                                boolean canBatchThisEvent)

Helps trigger identify user api call using key 'email'.

Parameters:

email - registered email address provided by host/customer app

details - optional additional parameters

canBatchThisEvent - flag to indicate if this event can be sent in bulk event API

trackScreenView

public void trackScreenView(android.app.Activity activity,
                            boolean canBatchThisEvent)

trackScreenView

public void trackScreenView(java.lang.String screenName,
                            boolean canBatchThisEvent)

trackAppOpen

public void trackAppOpen(boolean canBatchThisEvent)

trackAppOpen

public void trackAppOpen(java.util.HashMap<java.lang.String,java.lang.Object> params,
                         boolean canBatchThisEvent)

trackProductView

public void trackProductView(java.lang.String sku,
                             boolean canBatchThisEvent)

trackProductView

public void trackProductView(java.lang.String sku,
                             java.util.HashMap<java.lang.String,java.lang.Object> params,
                             boolean canBatchThisEvent)

trackProductView

public void trackProductView(java.lang.String sku,
                             int categoryId,
                             boolean canBatchThisEvent)

trackProductView

public void trackProductView(java.lang.String sku,
                             int categoryId,
                             java.util.HashMap<java.lang.String,java.lang.Object> params,
                             boolean canBatchThisEvent)

trackAddToCart

public void trackAddToCart(java.lang.String sku,
                           int quantity,
                           boolean canBatchThisEvent)

trackAddToCart

public void trackAddToCart(java.lang.String sku,
                           int quantity,
                           java.util.HashMap<java.lang.String,java.lang.Object> params,
                           boolean canBatchThisEvent)

trackCheckoutCart

public void trackCheckoutCart(Product[] products,
                              float revenue,
                              float discount,
                              java.lang.String coupon,
                              boolean canBatchThisEvent)

trackCheckoutCart

public void trackCheckoutCart(Product[] products,
                              float revenue,
                              float discount,
                              java.lang.String coupon,
                              java.util.HashMap<java.lang.String,java.lang.Object> params,
                              boolean canBatchThisEvent)

trackProductsPurchase

public void trackProductsPurchase(java.lang.String orderId,
                                  Product[] products,
                                  float revenue,
                                  float shippingCost,
                                  float discount,
                                  java.lang.String coupon,
                                  boolean canBatchThisEvent)

trackProductsPurchase

public void trackProductsPurchase(java.lang.String orderId,
                                  Product[] products,
                                  float revenue,
                                  float shippingCost,
                                  float discount,
                                  java.lang.String coupon,
                                  java.util.HashMap<java.lang.String,java.lang.Object> params,
                                  boolean canBatchThisEvent)

trackPurchaseCancel

public void trackPurchaseCancel(java.lang.String orderId,
                                boolean canBatchThisEvent)

trackPurchaseCancel

public void trackPurchaseCancel(java.lang.String orderId,
                                java.util.HashMap<java.lang.String,java.lang.Object> params,
                                boolean canBatchThisEvent)

trackPurchaseReturn

public void trackPurchaseReturn(java.lang.String orderId,
                                Product[] products,
                                boolean canBatchThisEvent)

trackPurchaseReturn

public void trackPurchaseReturn(java.lang.String orderId,
                                Product[] products,
                                java.util.HashMap<java.lang.String,java.lang.Object> params,
                                boolean canBatchThisEvent)

trackProductSearch

public void trackProductSearch(java.lang.String[] skus,
                               int numberOfResults,
                               int pageNumber,
                               java.lang.String query,
                               boolean canBatchThisEvent)

trackProductSearch

public void trackProductSearch(java.lang.String[] skus,
                               int numberOfResults,
                               int pageNumber,
                               java.lang.String query,
                               java.util.HashMap<java.lang.String,java.lang.Object> filters,
                               boolean canBatchThisEvent)

trackProductSearch

public void trackProductSearch(java.lang.String[] skus,
                               int numberOfResults,
                               int pageNumber,
                               java.lang.String query,
                               java.util.HashMap<java.lang.String,java.lang.Object> filters,
                               java.util.HashMap<java.lang.String,java.lang.Object> params,
                               boolean canBatchThisEvent)

trackEmailListSubscription

public void trackEmailListSubscription(java.lang.String email,
                                       boolean canBatchThisEvent)

trackEmailListSubscription

public void trackEmailListSubscription(java.lang.String email,
                                       java.util.HashMap<java.lang.String,java.lang.Object> params,
                                       boolean canBatchThisEvent)

trackEmailListUnsubscription

public void trackEmailListUnsubscription(java.lang.String email,
                                         boolean canBatchThisEvent)

trackEmailListUnsubscription

public void trackEmailListUnsubscription(java.lang.String email,
                                         java.util.HashMap<java.lang.String,java.lang.Object> params,
                                         boolean canBatchThisEvent)

trackSubscriptionInitialization

public void trackSubscriptionInitialization(SubscriptionState subscriptionState,
                                            java.lang.String cycleType,
                                            int cycleLength,
                                            java.lang.String subscriptionType,
                                            float price,
                                            long startDate,
                                            boolean canBatchThisEvent)

trackSubscriptionInitialization

public void trackSubscriptionInitialization(SubscriptionState subscriptionState,
                                            java.lang.String cycleType,
                                            int cycleLength,
                                            java.lang.String subscriptionType,
                                            float price,
                                            long startDate,
                                            java.util.HashMap<java.lang.String,java.lang.Object> params,
                                            boolean canBatchThisEvent)

trackSubscriptionPause

public void trackSubscriptionPause(boolean canBatchThisEvent)

trackSubscriptionPause

public void trackSubscriptionPause(java.util.HashMap<java.lang.String,java.lang.Object> params,
                                   boolean canBatchThisEvent)

trackSubscriptionUnpause

public void trackSubscriptionUnpause(boolean canBatchThisEvent)

trackSubscriptionUnpause

public void trackSubscriptionUnpause(java.util.HashMap<java.lang.String,java.lang.Object> params,
                                     boolean canBatchThisEvent)

trackSubscriptionCancel

public void trackSubscriptionCancel(boolean canBatchThisEvent)

trackSubscriptionCancel

public void trackSubscriptionCancel(java.util.HashMap<java.lang.String,java.lang.Object> params,
                                    boolean canBatchThisEvent)

trackNotificationView

public void trackNotificationView(Message message)

trackNotificationView

public void trackNotificationView(java.lang.String notificationId)

trackNotificationView

public void trackNotificationView(java.lang.String notificationId,
                                  java.util.HashMap<java.lang.String,java.lang.Object> params)

trackNotificationClick

public void trackNotificationClick(Message message,
                                   java.util.HashMap<java.lang.String,java.lang.Object> extras)

trackNotificationClick

public void trackNotificationClick(Message message)

trackNotificationClick

public void trackNotificationClick(java.lang.String notificationId)

trackNotificationClick

public void trackNotificationClick(java.lang.String notificationId,
                                   java.util.HashMap<java.lang.String,java.lang.Object> params)

trackNotificationPageOpen

public void trackNotificationPageOpen(Message message,
                                      boolean canBatchThisEvent)

trackNotificationPageOpen

public void trackNotificationPageOpen(java.lang.String notificationId,
                                      boolean canBatchThisEvent)

trackNotificationPageOpen

public void trackNotificationPageOpen(java.lang.String notificationId,
                                      java.util.HashMap<java.lang.String,java.lang.Object> params,
                                      boolean canBatchThisEvent)

trackAlertDismiss

public void trackAlertDismiss(Message message,
                              boolean canBatchThisEvent)

trackAlertDismiss

public void trackAlertDismiss(java.lang.String notificationId,
                              boolean canBatchThisEvent)

trackAlertDismiss

public void trackAlertDismiss(java.lang.String notificationId,
                              java.util.HashMap<java.lang.String,java.lang.Object> params,
                              boolean canBatchThisEvent)

trackInAppMessageDelivered

public void trackInAppMessageDelivered(InAppMessage inAppMessage)

trackInAppMessageView

public void trackInAppMessageView(InAppMessage inAppMessage)

trackInAppMessageClick

public void trackInAppMessageClick(InAppMessage inAppMessage,
                                   org.json.JSONObject extraJson)