io.fi0x.javalogger.mixpanel

Class MixpanelHandler

java.lang.Object

io.fi0x.javalogger.mixpanel.MixpanelHandler

public class MixpanelHandler
extends Object

Method Summary

Modifier and Type	Method and Description
static boolean	addDefaultProperty(String propertyName, String propertyValue) Properties that are added with this method will be appended to all future messages that are sent to Mixpanel.
static boolean	addMessage(String eventName, Map<String,String> properties) Add a new message to the Mixpanel delivery queue.
static boolean	sendMessages() Send all collected messages to Mixpanel.
static void	setProject(String mixpanelProjectToken) Set the project-token that can be obtained from Mixpanel.
static void	setUniqueID(String distinctMixpanelID) Set a distinct ID for all Mixpanel messages sent from this application-instance.
static boolean	startAutoUploader(long messageDelayMillis) Start a background Thread that will send all messages in the queue every x seconds.
static boolean	stopAutoUploader(boolean force) Interrupt the background Thread that sends messages automatically.

Methods inherited from class java.lang.Object

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

Method Detail

startAutoUploader

public static boolean startAutoUploader(long messageDelayMillis)

Start a background Thread that will send all messages in the queue every x seconds.

Parameters:

messageDelayMillis - The delay in milliseconds between each send-operation. Using a longer delay will make the Thread less responsive when stopping it again. The delay can't be set below 1000. Smaller delays will increase network-load.

Returns:

True if the Thread was started successfully, False if the Thread was already running.

stopAutoUploader

public static boolean stopAutoUploader(@Deprecated
                                       boolean force)

Interrupt the background Thread that sends messages automatically.

Parameters:

force - Will force a Thread.stop() command. This should only be used if the messageDelay for the Thread was very high.

Returns:

True if the Thread was interrupted, False if the Thread was not running.

sendMessages

public static boolean sendMessages()

Send all collected messages to Mixpanel.

Returns:

True if delivery was successful, False if there is no delivery or another problem occured.

addMessage

public static boolean addMessage(String eventName,
                                 Map<String,String> properties)

Add a new message to the Mixpanel delivery queue. Adding a message requires the uniqueID and projectToken to be set.

Parameters:

eventName - The name of the event. This will also be visible on Mixpanel. This must not be null.

properties - The properties for this message. These will be visible and filterable on Mixpanel.

Returns:

True if the message was successfully added to the queue, False if some information was missing.

addDefaultProperty

public static boolean addDefaultProperty(String propertyName,
                                         String propertyValue)

Properties that are added with this method will be appended to all future messages that are sent to Mixpanel. This is useful for version information and other things that do not change on runtime.

Parameters:

propertyName - The name of the property that will be visible on Mixpanel.

propertyValue - The value of the property.

Returns:

True if the property was added, False if a property with this name already exists.

setProject

public static void setProject(String mixpanelProjectToken)

Set the project-token that can be obtained from Mixpanel. This is required to successfully send messages to Mixpanel.

Parameters:

mixpanelProjectToken - The token of you Mixpanel project.

setUniqueID

public static void setUniqueID(String distinctMixpanelID)

Set a distinct ID for all Mixpanel messages sent from this application-instance. You can use a username or UUID to identify users and track them on Mixpanel.

Parameters:

distinctMixpanelID - The distinctID that is added to each Mixpanel message.