com.adobe.mobile

Class Target

java.lang.Object

com.adobe.mobile.Target

public final class Target
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Target.TargetCallback<T>

Constructor Summary

Constructors

Constructor and Description
Target()

Method Summary

Modifier and Type	Method and Description
static void	clearCookies()
static void	clearPrefetchCache() Clears all the data cached by Target Prefetch
static TargetLocationRequest	createOrderConfirmRequest(java.lang.String name, java.lang.String orderId, java.lang.String orderTotal, java.lang.String productPurchasedId, java.util.Map<java.lang.String,java.lang.Object> parameters)
static TargetLocationRequest	createRequest(java.lang.String name, java.lang.String defaultContent, java.util.Map<java.lang.String,java.lang.Object> parameters)
static TargetPrefetchObject	createTargetPrefetchObject(java.lang.String mboxName, java.util.Map<java.lang.String,java.lang.Object> mboxParams) Creates and returns an instance of TargetPrefetchObject with the provided data.
static TargetPrefetchObject	createTargetPrefetchObject(java.lang.String mboxName, java.util.Map<java.lang.String,java.lang.Object> mboxParams, java.util.Map<java.lang.String,java.lang.Object> orderParams, java.util.Map<java.lang.String,java.lang.Object> productParams) Creates and returns an instance of TargetPrefetchObject with the provided data.
static TargetRequestObject	createTargetRequestObject(java.lang.String mboxName, java.lang.String defaultContent, java.util.Map<java.lang.String,java.lang.Object> mboxParams, java.util.Map<java.lang.String,java.lang.Object> orderParams, java.util.Map<java.lang.String,java.lang.Object> productParams, Target.TargetCallback<java.lang.String> callback) Creates and returns an instance of TargetRequestObject with the provided data.
static TargetRequestObject	createTargetRequestObject(java.lang.String mboxName, java.lang.String defaultContent, java.util.Map<java.lang.String,java.lang.Object> mboxParams, Target.TargetCallback<java.lang.String> callback) Creates and returns an instance of TargetRequestObject with the provided data.
static java.lang.String	getPcID()
static java.lang.String	getSessionID()
static java.lang.String	getThirdPartyID()
static void	loadRequest(java.lang.String name, java.lang.String defaultContent, java.util.Map<java.lang.String,java.lang.Object> profileParameters, java.util.Map<java.lang.String,java.lang.Object> orderParameters, java.util.Map<java.lang.String,java.lang.Object> mboxParameters, java.util.Map<java.lang.String,java.lang.Object> requestLocationParameters, Target.TargetCallback<java.lang.String> callback)
static void	loadRequest(java.lang.String name, java.lang.String defaultContent, java.util.Map<java.lang.String,java.lang.Object> profileParameters, java.util.Map<java.lang.String,java.lang.Object> orderParameters, java.util.Map<java.lang.String,java.lang.Object> mboxParameters, Target.TargetCallback<java.lang.String> callback)
static void	loadRequest(TargetLocationRequest request, Target.TargetCallback<java.lang.String> callback)
static void	loadRequests(java.util.List<TargetRequestObject> requestArray, java.util.Map<java.lang.String,java.lang.Object> profileParameters) Request multiple Target mboxes in a single network call.
static void	locationClicked(java.lang.String mboxName, java.util.Map<java.lang.String,java.lang.Object> mboxParameters, java.util.Map<java.lang.String,java.lang.Object> orderParameters, java.util.Map<java.lang.String,java.lang.Object> productParameters, java.util.Map<java.lang.String,java.lang.Object> profileParameters) Sends a click notification to Target if click metrics are enabled for the provided location name.
static void	prefetchContent(java.util.List<TargetPrefetchObject> targetPrefetchArray, java.util.Map<java.lang.String,java.lang.Object> profileParameters, Target.TargetCallback<java.lang.Boolean> callback) Prefetch multiple Target mboxes in a single network call.
static void	setPreviewRestartDeeplink(java.lang.String deeplink)
static void	setThirdPartyID(java.lang.String thirdPartyId)

Methods inherited from class java.lang.Object

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

Constructor Detail

Target

public Target()

Method Detail

loadRequest

public static void loadRequest(TargetLocationRequest request,
                               Target.TargetCallback<java.lang.String> callback)

loadRequest

public static void loadRequest(java.lang.String name,
                               java.lang.String defaultContent,
                               java.util.Map<java.lang.String,java.lang.Object> profileParameters,
                               java.util.Map<java.lang.String,java.lang.Object> orderParameters,
                               java.util.Map<java.lang.String,java.lang.Object> mboxParameters,
                               Target.TargetCallback<java.lang.String> callback)

loadRequest

public static void loadRequest(java.lang.String name,
                               java.lang.String defaultContent,
                               java.util.Map<java.lang.String,java.lang.Object> profileParameters,
                               java.util.Map<java.lang.String,java.lang.Object> orderParameters,
                               java.util.Map<java.lang.String,java.lang.Object> mboxParameters,
                               java.util.Map<java.lang.String,java.lang.Object> requestLocationParameters,
                               Target.TargetCallback<java.lang.String> callback)

createRequest

public static TargetLocationRequest createRequest(java.lang.String name,
                                                  java.lang.String defaultContent,
                                                  java.util.Map<java.lang.String,java.lang.Object> parameters)

createOrderConfirmRequest

public static TargetLocationRequest createOrderConfirmRequest(java.lang.String name,
                                                              java.lang.String orderId,
                                                              java.lang.String orderTotal,
                                                              java.lang.String productPurchasedId,
                                                              java.util.Map<java.lang.String,java.lang.Object> parameters)

getPcID

public static java.lang.String getPcID()

getSessionID

public static java.lang.String getSessionID()

getThirdPartyID

public static java.lang.String getThirdPartyID()

setThirdPartyID

public static void setThirdPartyID(java.lang.String thirdPartyId)

clearCookies

public static void clearCookies()

setPreviewRestartDeeplink

public static void setPreviewRestartDeeplink(java.lang.String deeplink)

prefetchContent

public static void prefetchContent(java.util.List<TargetPrefetchObject> targetPrefetchArray,
                                   java.util.Map<java.lang.String,java.lang.Object> profileParameters,
                                   Target.TargetCallback<java.lang.Boolean> callback)

Prefetch multiple Target mboxes in a single network call. The content will be cached locally and returned immediately if any prefetched mbox is requested though a loadRequest call.

Parameters:

targetPrefetchArray - an array of TargetPrefetchObject representing the desired mboxes to prefetch

profileParameters - a dictionary of key-value pairs used as profile parameters for all prefetch requests

callback - the target callback which will be called after the prefetch is complete; the callback will be called with true if the prefetch completed successfully, false otherwise

See Also:

TargetPrefetchObject

clearPrefetchCache

public static void clearPrefetchCache()

Clears all the data cached by Target Prefetch

loadRequests

public static void loadRequests(java.util.List<TargetRequestObject> requestArray,
                                java.util.Map<java.lang.String,java.lang.Object> profileParameters)

Request multiple Target mboxes in a single network call.

Parameters:

requestArray - an array of TargetRequestObject representing the desired mboxes to prefetch

profileParameters - a dictionary of key-value pairs used as profile parameters for all mBox requests

See Also:

TargetRequestObject

createTargetRequestObject

public static TargetRequestObject createTargetRequestObject(java.lang.String mboxName,
                                                            java.lang.String defaultContent,
                                                            java.util.Map<java.lang.String,java.lang.Object> mboxParams,
                                                            java.util.Map<java.lang.String,java.lang.Object> orderParams,
                                                            java.util.Map<java.lang.String,java.lang.Object> productParams,
                                                            Target.TargetCallback<java.lang.String> callback)

Creates and returns an instance of TargetRequestObject with the provided data.

Parameters:

mboxName - required parameter, represents the location name

defaultContent - required parameter, this content will be returned in the provided callback if the SDK is unable to retrieve content from Target servers

mboxParams - optional parameter, will be sent in the location request

orderParams - optional parameter, will be send in the location request. Accepted keys: id, total and purchasedProductIds

productParams - optional parameter, will be sent in the location request. Accepted keys: id, categoryId

callback - optional parameter, used to receive content value

See Also:

TargetRequestObject

createTargetRequestObject

public static TargetRequestObject createTargetRequestObject(java.lang.String mboxName,
                                                            java.lang.String defaultContent,
                                                            java.util.Map<java.lang.String,java.lang.Object> mboxParams,
                                                            Target.TargetCallback<java.lang.String> callback)

Creates and returns an instance of TargetRequestObject with the provided data.

Parameters:

mboxName - required parameter, represents the location name

defaultContent - required parameter, this content will be returned in the provided callback if the SDK is unable to retrieve content from Target servers

mboxParams - optional parameter, will be sent in the location request

callback - optional parameter, used to receive content value

See Also:

TargetRequestObject

createTargetPrefetchObject

public static TargetPrefetchObject createTargetPrefetchObject(java.lang.String mboxName,
                                                              java.util.Map<java.lang.String,java.lang.Object> mboxParams,
                                                              java.util.Map<java.lang.String,java.lang.Object> orderParams,
                                                              java.util.Map<java.lang.String,java.lang.Object> productParams)

Creates and returns an instance of TargetPrefetchObject with the provided data.

Parameters:

mboxName - required parameter, represents the location name

mboxParams - optional parameter, will be sent in the prefetch request

orderParams - optional parameter, will be send in the prefetch request. Accepted keys: id, total and purchasedProductIds

productParams - optional parameter, will be sent in the prefetch request. Accepted keys: id, categoryId

See Also:

TargetPrefetchObject

createTargetPrefetchObject

public static TargetPrefetchObject createTargetPrefetchObject(java.lang.String mboxName,
                                                              java.util.Map<java.lang.String,java.lang.Object> mboxParams)

Creates and returns an instance of TargetPrefetchObject with the provided data.

Parameters:

mboxName - required parameter, represents the location name

mboxParams - optional parameter, will be sent in the prefetch request

See Also:

TargetPrefetchObject

locationClicked

public static void locationClicked(java.lang.String mboxName,
                                   java.util.Map<java.lang.String,java.lang.Object> mboxParameters,
                                   java.util.Map<java.lang.String,java.lang.Object> orderParameters,
                                   java.util.Map<java.lang.String,java.lang.Object> productParameters,
                                   java.util.Map<java.lang.String,java.lang.Object> profileParameters)

Sends a click notification to Target if click metrics are enabled for the provided location name.

Parameters:

mboxName - required parameter, represents the location name

mboxParameters - a Map<String,Object> containing the mboxParameters for the location clicked

orderParameters - a Map<String,Object> containing the orderParameters for the location clicked

productParameters - a Map<String,Object> containing the productParameters for the location clicked

profileParameters - a Map<String, Object> containing profiles parameters for all mboxes in the requests list