```
public class BranchEvent

                    
```
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	Description
`private final String`	`eventName`

Constructor Summary

Constructors
Constructor	Description
`BranchEvent(BRANCH_STANDARD_EVENT branchStandardEvent)`	Constructor.
`BranchEvent(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.

Method Summary

Modifier and Type	Method	Description
`String`	`getEventName()`
`BranchEvent`	`setCustomerEventAlias(String customerEventAlias)`	Set the Event Alias associated with the event.
`BranchEvent`	`setAdType(AdType adType)`	Set the Ad Type associated with the event.
`BranchEvent`	`setTransactionID(String transactionID)`	Set the transaction id associated with this event if there in any
`BranchEvent`	`setCurrency(CurrencyType currency)`	Set the currency related with this transaction event
`BranchEvent`	`setRevenue(double revenue)`	Set the revenue value related with this transaction 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`	`setCoupon(String coupon)`	Set any coupons associated with this transaction event
`BranchEvent`	`setAffiliation(String affiliation)`	Set any affiliation for this transaction event
`BranchEvent`	`setDescription(String description)`	Set description for this transaction event
`BranchEvent`	`setSearchQuery(String searchQuery)`	Set any search query associated with the event
`BranchEvent`	`addCustomDataProperty(String propertyName, String propertyValue)`	Adds a custom data property associated with this Branch Event
`BranchEvent`	`addContentItems(Array<BranchUniversalObject> contentItems)`	Use this method to add any BranchUniversalObject associated with this event.
`BranchEvent`	`addContentItems(List<BranchUniversalObject> contentItems)`	Use this method to add any BranchUniversalObject associated with this event.
`boolean`	`logEvent(Context context)`	Logs this BranchEvent to Branch for tracking and analytics

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BranchEvent
```
BranchEvent(BRANCH_STANDARD_EVENT branchStandardEvent)
```
    Constructor.
    
    Parameters:
    
    branchStandardEvent - Branch Standard Event
  - BranchEvent
```
BranchEvent(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
  - getEventName
```
 String getEventName()
```
  - setCustomerEventAlias
```
 BranchEvent setCustomerEventAlias(String customerEventAlias)
```
    Set the Event Alias associated with the event.
    
    Parameters:
    
    customerEventAlias - customerEventAlias
  - setAdType
```
 BranchEvent setAdType(AdType adType)
```
    Set the Ad Type associated with the event.
    
    Parameters:
    
    adType - AdType Ad Type value
  - setTransactionID
```
 BranchEvent setTransactionID(String transactionID)
```
    Set the transaction id associated with this event if there in any
    
    Parameters:
    
    transactionID - transactionID
  - setCurrency
```
 BranchEvent setCurrency(CurrencyType currency)
```
    Set the currency related with this transaction event
    
    Parameters:
    
    currency - iso4217Code for currency.
  - setRevenue
```
 BranchEvent setRevenue(double revenue)
```
    Set the revenue value related with this transaction event
    
    Parameters:
    
    revenue - revenue value
  - setShipping
```
 BranchEvent setShipping(double shipping)
```
    Set the shipping value related with this transaction event
    
    Parameters:
    
    shipping - shipping value
  - setTax
```
 BranchEvent setTax(double tax)
```
    Set the tax value related with this transaction event
    
    Parameters:
    
    tax - tax value
  - setCoupon
```
 BranchEvent setCoupon(String coupon)
```
    Set any coupons associated with this transaction event
    
    Parameters:
    
    coupon - String with any coupon value
  - setAffiliation
```
 BranchEvent setAffiliation(String affiliation)
```
    Set any affiliation for this transaction event
    
    Parameters:
    
    affiliation - String any affiliation value
  - setDescription
```
 BranchEvent setDescription(String description)
```
    Set description for this transaction event
    
    Parameters:
    
    description - String transaction description
  - setSearchQuery
```
 BranchEvent setSearchQuery(String searchQuery)
```
    Set any search query associated with the event
    
    Parameters:
    
    searchQuery - String Search Query value
  - addCustomDataProperty
```
 BranchEvent addCustomDataProperty(String propertyName, 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
  - addContentItems
```
 BranchEvent addContentItems(Array<BranchUniversalObject> contentItems)
```
    Use this method to add any BranchUniversalObject associated with this event.
    
    Parameters:
    
    contentItems - BranchUniversalObjects associated with this event
  - addContentItems
```
 BranchEvent addContentItems(List<BranchUniversalObject> contentItems)
```
    Use this method to add any BranchUniversalObject associated with this event.
    
    Parameters:
    
    contentItems - A list of BranchUniversalObjects associated with this event
  - logEvent
```
 boolean logEvent(Context context)
```
    Logs this BranchEvent to Branch for tracking and analytics
    
    Parameters:
    
    context - Current context

Class BranchEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BranchEvent

BranchEvent

Method Detail

getEventName

setCustomerEventAlias

setAdType

setTransactionID

setCurrency

setRevenue

setShipping

setTax

setCoupon

setAffiliation

setDescription

setSearchQuery

addCustomDataProperty

addContentItems

addContentItems

logEvent