public class

CustomEvent

extends Event
java.lang.Object
   ↳ com.urbanairship.analytics.Event
     ↳ com.urbanairship.analytics.CustomEvent

Class Overview

A class that represents a custom event for the application.

Summary

Nested Classes
class CustomEvent.Builder Builder class for CustomEvent Objects. 
Constants
String CONVERSION_SEND_ID Hard conversion send id key.
String EVENT_NAME The event name key.
String EVENT_VALUE The event value key.
String INTERACTION_ID The interaction ID key.
String INTERACTION_TYPE The interaction type key.
String LAST_RECEIVED_SEND_ID Last send id key.
int MAX_CHARACTER_LENGTH The max size for any String event value.
int MAX_PROPERTIES The max number of custom properties.
int MAX_PROPERTY_COLLECTION_SIZE The max size of a collection that is allowed in a custom property.
String MCRAP_TRANSACTION_TYPE Rich Push Message interaction type.
String PROPERTIES The custom properties key.
String TRANSACTION_ID The event transaction id key.
[Expand]
Inherited Constants
From class com.urbanairship.analytics.Event
Public Methods
final String getType()
The event type.
boolean isValid()
Validates the Event.
Protected Methods
final JSONObject getEventData()
Create the event data.
[Expand]
Inherited Methods
From class com.urbanairship.analytics.Event
From class java.lang.Object

Constants

public static final String CONVERSION_SEND_ID

Hard conversion send id key.

Constant Value: "conversion_send_id"

public static final String EVENT_NAME

The event name key.

Constant Value: "event_name"

public static final String EVENT_VALUE

The event value key.

Constant Value: "event_value"

public static final String INTERACTION_ID

The interaction ID key.

Constant Value: "interaction_id"

public static final String INTERACTION_TYPE

The interaction type key.

Constant Value: "interaction_type"

public static final String LAST_RECEIVED_SEND_ID

Last send id key.

Constant Value: "last_received_send_id"

public static final int MAX_CHARACTER_LENGTH

The max size for any String event value.

Constant Value: 255 (0x000000ff)

public static final int MAX_PROPERTIES

The max number of custom properties.

Constant Value: 20 (0x00000014)

public static final int MAX_PROPERTY_COLLECTION_SIZE

The max size of a collection that is allowed in a custom property.

Constant Value: 20 (0x00000014)

public static final String MCRAP_TRANSACTION_TYPE

Rich Push Message interaction type.

Constant Value: "ua_mcrap"

public static final String PROPERTIES

The custom properties key.

Constant Value: "properties"

public static final String TRANSACTION_ID

The event transaction id key.

Constant Value: "transaction_id"

Public Methods

public final String getType ()

The event type.

Returns
  • The event type.

public boolean isValid ()

Validates the Event.

Returns
  • True if valid, false otherwise.

Protected Methods

protected final JSONObject getEventData ()

Create the event data.

Returns
  • The event data.