com.feedad.android

Class CustomEvent

java.lang.Object

com.feedad.android.CustomEvent

public final class CustomEvent
extends java.lang.Object

This event can be used to track a custom user action.
You can specify a revenue to an event to track actions like In-App-Purchases.

Constructor Summary

Constructors

Constructor and Description
CustomEvent(java.lang.String label) Create a custom event without a specific revenue.
CustomEvent(java.lang.String label, long revenue, java.lang.String currency) Create a custom event with a specific revenue value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrency() Returns the currency of the event's revenue.
java.lang.String	getLabel() Returns the name of the event
long	getRevenue() Returns the revenue value of the event

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomEvent

public CustomEvent(@NonNull
                   java.lang.String label)

Create a custom event without a specific revenue.

Parameters:

label - the name of the event. The maximum allowed length is 256 characters

Throws:

java.lang.NullPointerException - when the label is null

java.lang.IllegalArgumentException - when the label is empty or exceeds the maximum allowed length

CustomEvent

public CustomEvent(@NonNull
                   java.lang.String label,
                   long revenue,
                   @NonNull
                   java.lang.String currency)

Create a custom event with a specific revenue value.

Parameters:

label - the name of the event. The maximum allowed length is 256 characters

revenue - the revenue value in milli-units. (e.g.: 1 EUR = 1000; 0,79 EUR = 799)

currency - the ISO 4217 currency code of the revenue's currency

Throws:

java.lang.NullPointerException - when the label is null

java.lang.IllegalArgumentException - when the label is empty or exceeds the maximum allowed length

java.lang.NullPointerException - when the currency string is empty

java.lang.IllegalArgumentException - when the currency string is not a valid ISO 4217 code

Method Detail

getLabel

@NonNull
public java.lang.String getLabel()

Returns the name of the event

Returns:

the name string

getRevenue

public long getRevenue()

Returns the revenue value of the event

Returns:

the revenue in milli-units

getCurrency

@Nullable
public java.lang.String getCurrency()

Returns the currency of the event's revenue.

Returns:

the ISO 4217 currency code or null if no revenue is set