com.indicative.client.java

Class Indicative

java.lang.Object

com.indicative.client.java.Indicative

public class Indicative
extends Object

A REST client for posting events to the Indicative Endpoint. Usage: Indicative.apiKey("Your-Api-Key-Goes-Here"); Indicative.event("Registration").uniqueId("user47").addProperty("name","value").done(); Note: You MUST call done() at the end...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Indicative.Event A class representing the Event to be recorded.

Constructor Summary

Constructors

Constructor and Description
Indicative()

Method Summary

Methods

Modifier and Type	Method and Description
static void	apiKey(String apiKey) Sets the static apiKey value.
static String	escape(String s) Escapes special characters in a String with a backslash character for use in the JSON representation of an event.
static Indicative.Event	event(String eventName) Instantiates a new Event object and initializes it with the name of your event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Indicative

public Indicative()

Method Detail

apiKey

public static void apiKey(String apiKey)

Sets the static apiKey value. You should call this once before recording any events.

Parameters:

apiKey - The API key for your project. You can find this on your Project Settings page.

event

public static Indicative.Event event(String eventName)

Instantiates a new Event object and initializes it with the name of your event.

Parameters:

eventName - The name of your event.

Returns:

The newly created Event object.

escape

public static String escape(String s)

Escapes special characters in a String with a backslash character for use in the JSON representation of an event. For example: the character " becomes \" and \ becomes \\

Parameters:

s - The original String.

Returns:

The String with its special characters escaped.