io.branch.referral.util

Class BranchEvent

java.lang.Object

io.branch.referral.util.BranchEvent

public class BranchEvent
extends java.lang.Object

Class for creating Branch events for tracking and analytical purpose. This class represent a standard or custom BranchEvents. Standard Branch events are defined with BRANCH_STANDARD_EVENT. Please use #logEvent() method to log the events for tracking.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_TO_CART Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead
static java.lang.String	ADD_TO_WISH_LIST Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead
static java.lang.String	CANONICAL_ID_LIST Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead
static java.lang.String	PURCHASE_STARTED Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead
static java.lang.String	PURCHASED Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead
static java.lang.String	SHARE_COMPLETED Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead
static java.lang.String	SHARE_STARTED Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead
static java.lang.String	VIEW Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

Constructor Summary

Constructors

Constructor and Description
BranchEvent(BRANCH_STANDARD_EVENT branchStandardEvent) Constructor.
BranchEvent(java.lang.String eventName) Constructor.

Method Summary

Modifier and Type	Method and Description
BranchEvent	addContentItems(BranchUniversalObject... contentItems) Use this method to add any BranchUniversalObject associated with this event.
BranchEvent	addContentItems(java.util.List<BranchUniversalObject> contentItems) Use this method to add any BranchUniversalObject associated with this event.
BranchEvent	addCustomDataProperty(java.lang.String propertyName, java.lang.String propertyValue) Adds a custom data property associated with this Branch Event
java.lang.String	getEventName()
boolean	logEvent(android.content.Context context) Logs this BranchEvent to Branch for tracking and analytics
BranchEvent	setAdType(AdType adType) Set the Ad Type associated with the event.
BranchEvent	setAffiliation(java.lang.String affiliation) Set any affiliation for this transaction event
BranchEvent	setCoupon(java.lang.String coupon) Set any coupons associated with this transaction event
BranchEvent	setCurrency(CurrencyType currency) Set the currency related with this transaction event
BranchEvent	setDescription(java.lang.String description) Set description for this transaction event
BranchEvent	setRevenue(double revenue) Set the revenue value related with this transaction event
BranchEvent	setSearchQuery(java.lang.String searchQuery) Set any search query associated with the event
BranchEvent	setShipping(double shipping) Set the shipping value related with this transaction event
BranchEvent	setTax(double tax) Set the tax value related with this transaction event
BranchEvent	setTransactionID(java.lang.String transactionID) Set the transaction id associated with this event if there in any

Methods inherited from class java.lang.Object

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

Field Detail

VIEW

public static final java.lang.String VIEW

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

ADD_TO_WISH_LIST

public static final java.lang.String ADD_TO_WISH_LIST

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

ADD_TO_CART

public static final java.lang.String ADD_TO_CART

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

PURCHASE_STARTED

public static final java.lang.String PURCHASE_STARTED

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

PURCHASED

public static final java.lang.String PURCHASED

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

SHARE_STARTED

public static final java.lang.String SHARE_STARTED

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

SHARE_COMPLETED

public static final java.lang.String SHARE_COMPLETED

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

CANONICAL_ID_LIST

public static final java.lang.String CANONICAL_ID_LIST

Deprecated. Please use #BranchEvent(BRANCH_STANDARD_EVENT) instead

See Also:

Constant Field Values

Constructor Detail

BranchEvent

public BranchEvent(BRANCH_STANDARD_EVENT branchStandardEvent)

Constructor.

Parameters:

branchStandardEvent - Branch Standard Event

BranchEvent

public BranchEvent(java.lang.String eventName)

Constructor. This constructor can be used for free-form Events or Branch Standard Events. Event names that match Standard Events will be treated as Standard Events.

Parameters:

eventName - Event Name.

Method Detail

setAdType

public BranchEvent setAdType(AdType adType)

Set the Ad Type associated with the event.

Parameters:

adType - AdType Ad Type value

Returns:

this object for chaining builder methods

setTransactionID

public BranchEvent setTransactionID(java.lang.String transactionID)

Set the transaction id associated with this event if there in any

Parameters:

transactionID - transactionID

setCurrency

public BranchEvent setCurrency(CurrencyType currency)

Set the currency related with this transaction event

Parameters:

currency - iso4217Code for currency. Defined in CurrencyType

Returns:

This object for chaining builder methods

setRevenue

public BranchEvent setRevenue(double revenue)

Set the revenue value related with this transaction event

Parameters:

revenue - double revenue value

Returns:

This object for chaining builder methods

setShipping

public BranchEvent setShipping(double shipping)

Set the shipping value related with this transaction event

Parameters:

shipping - double shipping value

Returns:

This object for chaining builder methods

setTax

public BranchEvent setTax(double tax)

Set the tax value related with this transaction event

Parameters:

tax - double tax value

Returns:

This object for chaining builder methods

setCoupon

public BranchEvent setCoupon(java.lang.String coupon)

Set any coupons associated with this transaction event

Parameters:

coupon - String with any coupon value

Returns:

This object for chaining builder methods

setAffiliation

public BranchEvent setAffiliation(java.lang.String affiliation)

Set any affiliation for this transaction event

Parameters:

affiliation - String any affiliation value

Returns:

This object for chaining builder methods

setDescription

public BranchEvent setDescription(java.lang.String description)

Set description for this transaction event

Parameters:

description - String transaction description

Returns:

This object for chaining builder methods

setSearchQuery

public BranchEvent setSearchQuery(java.lang.String searchQuery)

Set any search query associated with the event

Parameters:

searchQuery - String Search Query value

Returns:

This object for chaining builder methods

addCustomDataProperty

public BranchEvent addCustomDataProperty(java.lang.String propertyName,
                                         java.lang.String propertyValue)

Adds a custom data property associated with this Branch Event

Parameters:

propertyName - String Name of the custom property

propertyValue - String Value of the custom property

Returns:

This object for chaining builder methods

addContentItems

public BranchEvent addContentItems(BranchUniversalObject... contentItems)

Use this method to add any BranchUniversalObject associated with this event.

Parameters:

contentItems - BranchUniversalObjects associated with this event

Returns:

his object for chaining builder methods NOTE : Use this method when the event is a BRANCH_STANDARD_EVENT. BranchUniversalObjects will be ignored otherwise

addContentItems

public BranchEvent addContentItems(java.util.List<BranchUniversalObject> contentItems)

Use this method to add any BranchUniversalObject associated with this event.

Parameters:

contentItems - A list of BranchUniversalObjects associated with this event

Returns:

his object for chaining builder methods NOTE : Use this method when the event is a BRANCH_STANDARD_EVENT. BranchUniversalObjects will be ignored otherwise

getEventName

public java.lang.String getEventName()

logEvent

public boolean logEvent(android.content.Context context)

Logs this BranchEvent to Branch for tracking and analytics

Parameters:

context - Current context

Returns:

true if the event is logged to Branch