com.urbanairship.api.customevents.model

Class CustomEventBody

java.lang.Object

com.urbanairship.api.customevents.model.CustomEventBody

public class CustomEventBody
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomEventBody.Builder CustomEventBody Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	getInteractionId() Get the interactionId.
java.util.Optional<java.lang.String>	getInteractionType() Get the interactionType.
java.lang.String	getName() Set the name of a description of what happened.
java.util.Optional<<any>>	getProperties() Get all property entries.
java.util.Optional<java.lang.String>	getSessionId() Get the sessionID.
java.util.Optional<java.lang.String>	getTransaction() Get the transaction.
java.util.Optional<java.math.BigDecimal>	getValue() Get the value.
int	hashCode()
static CustomEventBody.Builder	newBuilder() New CustomEventBody Builder

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static CustomEventBody.Builder newBuilder()

New CustomEventBody Builder

Returns:

Builder

getName

public java.lang.String getName()

Set the name of a description of what happened. Urban Airship’s analytics systems will roll up events with the same name, providing counts and total value associated with the event.

Returns:

String

getValue

public java.util.Optional<java.math.BigDecimal> getValue()

Get the value. If the event is associated with a count or amount, the value field carries that information. Our system will treat this field as though it were money—mathematical operations will use fixed precision representations of the field. We will respect up to six digits of precision to the right of the decimal point. This field is optional; if it is absent its value will default to zero.

Returns:

Optional BigDecimal

getTransaction

public java.util.Optional<java.lang.String> getTransaction()

Get the transaction. Optional. If the event is one in a series representing a single transaction, use the transaction field to tie them together.

Returns:

Optional String

getInteractionId

public java.util.Optional<java.lang.String> getInteractionId()

Get the interactionId. Optional. The identifier defining where the event occurred. In a traditional website, this would be the path and query string portion of the URL. In a single page app that uses hash routing, it would be the path, query string, and fragment identifier.

Returns:

Optional String

getInteractionType

public java.util.Optional<java.lang.String> getInteractionType()

Get the interactionType. String describing the type of interaction that led to the firing of the custom event, e.g., url, social, email.

Returns:

Optional String

getProperties

public java.util.Optional<<any>> getProperties()

Get all property entries. Object supporting key/value pairs that describe event custom properties. Events are limited to 100 properties. Maximum 255 character string length.

Returns:

Optional ImmutableMap of Strings

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getSessionId

public java.util.Optional<java.lang.String> getSessionId()

Get the sessionID. The user session during which the event occurred. You must supply and maintain session identifiers.

Returns:

Optional String