com.indicative.client.java

Class Indicative.Event

java.lang.Object

com.indicative.client.java.Indicative.Event

Enclosing class:

Indicative

public static class Indicative.Event
extends Object

A class representing the Event to be recorded.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Indicative.Event(String eventName) A constructor that sets the initial values for the Event object's apiKey, eventName, and eventTime fields.
protected	Indicative.Event(String eventName, String apiKey) A constructor that sets the initial values for the Event object's apiKey, eventName, and eventTime fields.

Method Summary

Methods

Modifier and Type	Method and Description
Indicative.Event	addEventTime(long eventTime) Sets the Event object's eventTime field.
Indicative.Event	addProperties(Map<String,String> propertyMap) Adds a Map of property name/value pairs to the Event object's Map of properties.
Indicative.Event	addProperty(String name, boolean value) Adds a property name/value pair to the Event object's Map of properties.
Indicative.Event	addProperty(String name, double value) Adds a property name/value pair to the Event object's Map of properties.
Indicative.Event	addProperty(String name, float value) Adds a property name/value pair to the Event object's Map of properties.
Indicative.Event	addProperty(String name, int value) Adds a property name/value pair to the Event object's Map of properties.
Indicative.Event	addProperty(String name, long value) Adds a property name/value pair to the Event object's Map of properties.
Indicative.Event	addProperty(String name, String value) Adds a property name/value pair to the Event object's Map of properties.
void	done() Creates a new Thread to asynchronously post the event.
String	toJson() Serializes the event to a JSON String.
Indicative.Event	uniqueId(String eventUniqueId) Adds the user's unique identifier to the Event object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Indicative.Event

protected Indicative.Event(String eventName)

A constructor that sets the initial values for the Event object's apiKey, eventName, and eventTime fields.

Parameters:

eventName - The name of your event.

Indicative.Event

protected Indicative.Event(String eventName,
                String apiKey)

A constructor that sets the initial values for the Event object's apiKey, eventName, and eventTime fields.

Parameters:

eventName - The name of your event.

apiKey - The apiKey you want to use

Method Detail

done

public void done()

Creates a new Thread to asynchronously post the event. This MUST be called once you're done building the event. Otherwise, the event will not be submitted to the API.

addEventTime

public Indicative.Event addEventTime(long eventTime)

Sets the Event object's eventTime field.

Parameters:

eventTime - The UNIX timestamp (in milliseconds) when your event occurred.

Returns:

The modified Event object.

addProperty

public Indicative.Event addProperty(String name,
                           String value)

Adds a property name/value pair to the Event object's Map of properties.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The modified Event object.

addProperty

public Indicative.Event addProperty(String name,
                           int value)

Adds a property name/value pair to the Event object's Map of properties.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The modified Event object.

addProperty

public Indicative.Event addProperty(String name,
                           long value)

Adds a property name/value pair to the Event object's Map of properties.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The modified Event object.

addProperty

public Indicative.Event addProperty(String name,
                           float value)

Adds a property name/value pair to the Event object's Map of properties.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The modified Event object.

addProperty

public Indicative.Event addProperty(String name,
                           double value)

Adds a property name/value pair to the Event object's Map of properties.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The modified Event object.

addProperty

public Indicative.Event addProperty(String name,
                           boolean value)

Adds a property name/value pair to the Event object's Map of properties.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

The modified Event object.

addProperties

public Indicative.Event addProperties(Map<String,String> propertyMap)

Adds a Map of property name/value pairs to the Event object's Map of properties.

Parameters:

propertyMap - A map of Strings representing property names and values.

Returns:

The modified Event object.

uniqueId

public Indicative.Event uniqueId(String eventUniqueId)

Adds the user's unique identifier to the Event object.

Parameters:

eventUniqueId - The unique identifier for the user associated with the event.

Returns:

The modified Event object.

toJson

public String toJson()

Serializes the event to a JSON String.

Returns:

The JSON representation of the event.