com.blueshift.inappmessage

Class InAppManager

java.lang.Object

com.blueshift.inappmessage.InAppManager

public class InAppManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
InAppManager()

Method Summary

Modifier and Type	Method and Description
static void	fetchInAppFromServer(android.content.Context context, InAppApiCallback callback)
static org.json.JSONObject	generateInAppMessageAPIRequestPayload(android.content.Context context) This method is a helper for getting the request body expected by the in-app API end-point on Blueshift server-side.
static InAppActionCallback	getActionCallback()
static void	handleInAppMessageAPIResponse(android.content.Context context, java.lang.String apiResponse) This method can accept the in-app API response (JSON) and decode in-app messages from it.
static void	invokeTriggers()
static void	invokeTriggerWithinSdk() This method checks if the dev has enabled the manual triggering of in-app and then decides if we should call the invokeTrigger or not based on that
static void	onInAppMessageReceived(android.content.Context context, InAppMessage inAppMessage) This method accepts one in-app message instance from the host app for storing.
static void	registerForInAppMessages(android.app.Activity activity) Calling this method makes the activity eligible for displaying InAppMessage
static void	registerForInAppMessages(android.app.Activity activity, java.lang.String screenName) Calling this method makes the activity eligible for displaying InAppMessage.
static void	setActionCallback(InAppActionCallback callback)
static void	unregisterForInAppMessages(android.app.Activity activity) Calling this method will clean up the memory to avoid memory leak.

Methods inherited from class java.lang.Object

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

Constructor Detail

InAppManager

public InAppManager()

Method Detail

registerForInAppMessages

public static void registerForInAppMessages(android.app.Activity activity)

Calling this method makes the activity eligible for displaying InAppMessage

Parameters:

activity - Valid Activity object.

registerForInAppMessages

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

Calling this method makes the activity eligible for displaying InAppMessage. It also takes in a unique screen name to be used instead of the activity class name.

Parameters:

activity - Valid Activity object.

screenName - The screen name in which the in-app should be displayed

unregisterForInAppMessages

public static void unregisterForInAppMessages(android.app.Activity activity)

Calling this method will clean up the memory to avoid memory leak.

Parameters:

activity - valid Activity object.

getActionCallback

public static InAppActionCallback getActionCallback()

setActionCallback

public static void setActionCallback(InAppActionCallback callback)

fetchInAppFromServer

public static void fetchInAppFromServer(android.content.Context context,
                                        InAppApiCallback callback)

generateInAppMessageAPIRequestPayload

public static org.json.JSONObject generateInAppMessageAPIRequestPayload(android.content.Context context)

This method is a helper for getting the request body expected by the in-app API end-point on Blueshift server-side.

The host app should call this method from a worker thread as this method involves db access and advertising id requests (depending on device_id source).

Parameters:

context - a valid context object

Returns:

valid JSONObject filled with params, null if any error happens in getting params.

handleInAppMessageAPIResponse

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

This method can accept the in-app API response (JSON) and decode in-app messages from it. The decoded in-app messages will be inserted into the database and displayed to the user.

Parameters:

context - valid context object

apiResponse - valid API response in JSON format

onInAppMessageReceived

public static void onInAppMessageReceived(android.content.Context context,
                                          InAppMessage inAppMessage)

This method accepts one in-app message instance from the host app for storing.

Parameters:

context - valid context object

inAppMessage - valid inAppMessage object

invokeTriggerWithinSdk

public static void invokeTriggerWithinSdk()

This method checks if the dev has enabled the manual triggering of in-app and then decides if we should call the invokeTrigger or not based on that

invokeTriggers

public static void invokeTriggers()