com.urbanairship.api.customevents.model

Class CustomEventBody.Builder

java.lang.Object

com.urbanairship.api.customevents.model.CustomEventBody.Builder

Enclosing class:

CustomEventBody

public static class CustomEventBody.Builder
extends java.lang.Object

CustomEventBody Builder

Method Summary

Modifier and Type	Method and Description
CustomEventBody.Builder	addAllPropertyEntries(java.util.Map<java.lang.String,CustomEventPropertyValue> entries) Add all property entries.
CustomEventBody.Builder	addPropertiesEntry(java.lang.String key, CustomEventPropertyValue value) Add a properties entry.
CustomEventBody	build()
CustomEventBody.Builder	setInteractionId(java.lang.String interactionId) Set the interactionId.
CustomEventBody.Builder	setInteractionType(java.lang.String interactionType) Set the interactionType.
CustomEventBody.Builder	setName(java.lang.String name) Set the name of a description of what happened.
CustomEventBody.Builder	setSessionId(java.lang.String sessionId) Set the sessionID.
CustomEventBody.Builder	setTransaction(java.lang.String transaction) Set the transaction.
CustomEventBody.Builder	setValue(java.math.BigDecimal value) Set the value.

Methods inherited from class java.lang.Object

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

Method Detail

setName

public CustomEventBody.Builder setName(java.lang.String name)

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.

Parameters:

name - String

Returns:

CustomEventBody Builder

setValue

public CustomEventBody.Builder setValue(java.math.BigDecimal value)

Set 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.

Parameters:

value - BigDecimal

Returns:

CustomEventBody Builder

setTransaction

public CustomEventBody.Builder setTransaction(java.lang.String transaction)

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

Parameters:

transaction - String

Returns:

CustomEventBody Builder

setInteractionId

public CustomEventBody.Builder setInteractionId(java.lang.String interactionId)

Set 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.

Parameters:

interactionId - String

Returns:

CustomEventBody Builder

setInteractionType

public CustomEventBody.Builder setInteractionType(java.lang.String interactionType)

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

Parameters:

interactionType - String

Returns:

CustomEventBody Builder

addPropertiesEntry

public CustomEventBody.Builder addPropertiesEntry(java.lang.String key,
                                                  CustomEventPropertyValue value)

Add a properties entry. Object supporting key/value pairs that describe event custom properties. Events are limited to 100 properties. Maximum 255 character string length.

Parameters:

key - String

value - CustomEventPropertyValue

Returns:

CustomEventBody Builder

addAllPropertyEntries

public CustomEventBody.Builder addAllPropertyEntries(java.util.Map<java.lang.String,CustomEventPropertyValue> entries)

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

Parameters:

entries - A Map of Strings

Returns:

CustomEventBody Builder

setSessionId

public CustomEventBody.Builder setSessionId(java.lang.String sessionId)

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

Parameters:

sessionId - String

Returns:

CustomEventBody Builder

build

public CustomEventBody build()