io.branch.adobe.extension

Class AdobeBranch

java.lang.Object

io.branch.adobe.extension.AdobeBranch

public class AdobeBranch
extends java.lang.Object

AdobeBranch Extension.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdobeBranch.EventTypeSource Pair for holding an Event Type and Event Source.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_AFFILIATION
static java.lang.String	KEY_COUPON
static java.lang.String	KEY_CURRENCY
static java.lang.String	KEY_DESCRIPTION
static java.lang.String	KEY_REVENUE
static java.lang.String	KEY_SEARCH_QUERY
static java.lang.String	KEY_SHIPPING
static java.lang.String	KEY_TAX
static java.lang.String	KEY_TRANSACTION_ID

Constructor Summary

Constructors

Constructor and Description
AdobeBranch()

Method Summary

Modifier and Type	Method and Description
static Branch	getAutoInstance(android.content.Context context) Singleton method to return the pre-initialized, or newly initialize and return, a singleton object of the type Branch.
static boolean	initSession(Branch.BranchReferralInitListener callback, android.net.Uri data, android.app.Activity activity) Initializes Branch session after the default 750 millisecond delay needed to collect Adobe IDs.
static boolean	initSession(Branch.BranchReferralInitListener callback, android.net.Uri data, android.app.Activity activity, int delay) Initializes Branch session after the chosen delay in milliseconds (needed to collect Adobe IDs).
static boolean	registerAdobeBranchEvents(java.util.List<AdobeBranch.EventTypeSource> additionalEvents) Register a whitelist of Event Types and Event Sources to send to Branch.
static boolean	reInitSession(android.app.Activity activity, Branch.BranchReferralInitListener callback) ReInitialize session.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_AFFILIATION

public static final java.lang.String KEY_AFFILIATION

See Also:

Constant Field Values

KEY_COUPON

public static final java.lang.String KEY_COUPON

See Also:

Constant Field Values

KEY_CURRENCY

public static final java.lang.String KEY_CURRENCY

See Also:

Constant Field Values

KEY_DESCRIPTION

public static final java.lang.String KEY_DESCRIPTION

See Also:

Constant Field Values

KEY_REVENUE

public static final java.lang.String KEY_REVENUE

See Also:

Constant Field Values

KEY_SEARCH_QUERY

public static final java.lang.String KEY_SEARCH_QUERY

See Also:

Constant Field Values

KEY_SHIPPING

public static final java.lang.String KEY_SHIPPING

See Also:

Constant Field Values

KEY_TAX

public static final java.lang.String KEY_TAX

See Also:

Constant Field Values

KEY_TRANSACTION_ID

public static final java.lang.String KEY_TRANSACTION_ID

See Also:

Constant Field Values

Constructor Detail

AdobeBranch

public AdobeBranch()

Method Detail

getAutoInstance

public static Branch getAutoInstance(android.content.Context context)

Singleton method to return the pre-initialized, or newly initialize and return, a singleton object of the type Branch.

Parameters:

context - A Context from which this call was made.

Returns:

An initialized Branch object

initSession

public static boolean initSession(Branch.BranchReferralInitListener callback,
                                  android.net.Uri data,
                                  android.app.Activity activity)

Initializes Branch session after the default 750 millisecond delay needed to collect Adobe IDs. To initialize without delay, use initSession(callback, data, activity, delay) passing in 0 as the delay parameter.

Parameters:

callback - A listener that will be called following successful (or unsuccessful) initialization of the session with the Branch API.

data - A Uri variable containing the details of the source link that led to this initialization action.

activity - The calling Activity for context.

Returns:

A Boolean value that will return false if the supplied data parameter cannot be handled successfully - i.e. is not of a valid URI format.

initSession

public static boolean initSession(Branch.BranchReferralInitListener callback,
                                  android.net.Uri data,
                                  android.app.Activity activity,
                                  int delay)

Initializes Branch session after the chosen delay in milliseconds (needed to collect Adobe IDs). To initialize without delay pass 0 as the delay parameter.

Parameters:

callback - A listener that will be called following successful (or unsuccessful) initialization of the session with the Branch API.

data - A Uri variable containing the details of the source link that led to this initialization action.

activity - The calling Activity for context.

delay - An Integer to set session initialization delay in millis (delay is needed to collect Adobe IDs).

Returns:

A Boolean value that will return false if the supplied data parameter cannot be handled successfully - i.e. is not of a valid URI format.

reInitSession

public static boolean reInitSession(android.app.Activity activity,
                                    Branch.BranchReferralInitListener callback)

ReInitialize session. Called from onNewIntent, will only reInitialize if the intent contains a boolean extra "branch_force_new_session"=true

registerAdobeBranchEvents

public static boolean registerAdobeBranchEvents(java.util.List<AdobeBranch.EventTypeSource> additionalEvents)

Register a whitelist of Event Types and Event Sources to send to Branch.

Parameters:

additionalEvents - Additional events to listen for. If empty, this extension will not listen for any events. If null, this extension will default to listen for all Adobe events. If non-empty, will listen for only those events that are in the list.

Returns:

true if the configuration was successful