com.blueshift.util

Class BlueshiftUtils

java.lang.Object

com.blueshift.util.BlueshiftUtils

public class BlueshiftUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BlueshiftUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.String>	buildTrackApiAttributesFromPayload(java.util.Map<java.lang.String,java.lang.Object> inputMap, android.content.Context context) This method is responsible for building the attributes for calling the track API.
static boolean	canAutomaticAppOpenBeSentNow(android.content.Context context) Checks if we can send an app_open now.
static java.lang.String	getApiKey(android.content.Context context) This method checks if a non-empty API key is supplied to the SDK while initialization and returns the same if available.
static Configuration	getConfiguration(android.content.Context context) Checks if a not-null Configuration object is supplied during the SDK initialization and returns the same if available.
static boolean	isAutomaticAppOpenFiringEnabled(android.content.Context context) Checks the config object provided during SDK initialisation to see automatic app_open event firing is enabled.
static boolean	isBlueshiftPushMessage(android.content.Intent intent) Checks the payload received and looks for bsft_message_uuid in it to confirm if the push message belongs to Blueshift.
static boolean	isBlueshiftPushMessage(RemoteMessage remoteMessage) Checks the payload received and looks for bsft_message_uuid in it to confirm if the push message belongs to Blueshift.
static boolean	isInAppEnabled(android.content.Context context) Checks the config object provided during SDK initialisation to see if in-app is enabled.
static boolean	isOptedInForInAppMessages(android.content.Context context) Checks both config and app preferences to see if the user has opted in for in-app messages.
static boolean	isOptedInForPushNotification(android.content.Context context) Checks both system settings and app preferences to see if the user has opted in for push notifications.
static boolean	isPushEnabled(android.content.Context context) Checks the config object provided during SDK initialisation to see if push is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlueshiftUtils

public BlueshiftUtils()

Method Detail

getApiKey

public static java.lang.String getApiKey(android.content.Context context)

This method checks if a non-empty API key is supplied to the SDK while initialization and returns the same if available.

Parameters:

context - Context object to get the Blueshift instance.

Returns:

API Key, if present. Else null.

getConfiguration

public static Configuration getConfiguration(android.content.Context context)

Checks if a not-null Configuration object is supplied during the SDK initialization and returns the same if available.

Parameters:

context - Context object to get the Blueshift instance.

Returns:

Valid Configuration object, if found. Else null.

isAutomaticAppOpenFiringEnabled

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

Checks the config object provided during SDK initialisation to see automatic app_open event firing is enabled.

Parameters:

context - valid Context object

Returns:

true if automatic app_open is enabled in configuration, else false

canAutomaticAppOpenBeSentNow

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

Checks if we can send an app_open now. This checks the interval specified by the host app and takes decision. If nothing is set, falls back into the default interval of 24h.

This method is used internally by the SDK to throttle automatic app_open events.

Parameters:

context - valid Context object

Returns:

true if we can fire app_open, else false

isInAppEnabled

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

Checks the config object provided during SDK initialisation to see if in-app is enabled.

Parameters:

context - valid Context object

Returns:

true if in-app enabled in configuration, else false

isPushEnabled

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

Checks the config object provided during SDK initialisation to see if push is enabled.

Parameters:

context - valid Context object

Returns:

true if push enabled in configuration, else false

isOptedInForInAppMessages

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

Checks both config and app preferences to see if the user has opted in for in-app messages. Both the flags should be enabled to opt in for in-app messages.

Parameters:

context - valid Context object

Returns:

true if in-app is ON in both app preferences and config object

isOptedInForPushNotification

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

Checks both system settings and app preferences to see if the user has opted in for push notifications. Both the flags should be enabled to opt in for push notification.

Parameters:

context - valid Context object

Returns:

true if push is ON in both app preferences and system settings, else false

isBlueshiftPushMessage

public static boolean isBlueshiftPushMessage(android.content.Intent intent)

Checks the payload received and looks for bsft_message_uuid in it to confirm if the push message belongs to Blueshift.

Parameters:

intent - from push message receiver

Returns:

true if push belongs to Blueshift, else false

isBlueshiftPushMessage

public static boolean isBlueshiftPushMessage(RemoteMessage remoteMessage)

Checks the payload received and looks for bsft_message_uuid in it to confirm if the push message belongs to Blueshift.

Parameters:

remoteMessage - from push message receiver

Returns:

true if push belongs to Blueshift, else false

buildTrackApiAttributesFromPayload

public static java.util.Map<java.lang.String,java.lang.String> buildTrackApiAttributesFromPayload(java.util.Map<java.lang.String,java.lang.Object> inputMap,
                                                                                                  android.content.Context context)

This method is responsible for building the attributes for calling the track API.

Note: This method must be called from a non UI thread if the deviceIdSource is set to ADVERTISING_ID.

Parameters:

inputMap - in-app or push payload with additional tracking info.

context - valid Context object.

Returns:

Map of attributes with appropriate keys required to call the track API.