ai.lilystyle.analytics_android

Class LilyAi

java.lang.Object

ai.lilystyle.analytics_android.LilyAi

public final class LilyAi
extends java.lang.Object

Core class for integrating Lily.Ai analytics.

First obtain api-key and token to access Lily.Ai analytics.

Place the obtained api-key and token in meta-data tags in your AndroidManifest.xml inside application tag:

 
 <application ...>
     <meta-data android:name="ai.lily.analytics.api_token" android:value="PLACE_YOUR_API_TOKEN_HERE" />
     <meta-data android:name="ai.lily.analytics.api_key" android:value="PLACE_YOUR_API_KEY_HERE" />
     <meta-data android:name="ai.lily.analytics.endpoint" android:value="PLACE_YOUR_ENDPOINT_HERE" />
 </application>
 
 

Now you can call getInstance(Context) to obtain LilyAi instance

You might want to keep your api-key and token more secure. In this case obfuscate those as you please and to obtain LilyAi instance use getInstance(Context, String) with your token or getInstance(Context, String, String, String) with both.

When initiated LilyAi tries to restore a unique id (UUID or lpid) of the user from it's shared preferences or generates a new one, if not present, and stores it. You can override this by calling setUUID(String) with your own id for the user. Also you can use getUUID() to check what UUID is currently used by LilyAi or call resetUUID() to drop the stored UUID value and generate a new random UUID.

Once you obtained an instance of LilyAi and done with setting up the UUID you can call either of track(JSONObject) or track(JSONObject, LilyAiListener) methods to send your data.

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value)
static LilyAi	getInstance(android.content.Context context) Get instance of LilyAI.
static LilyAi	getInstance(android.content.Context context, java.lang.String token) Get instance of LilyAI.
static LilyAi	getInstance(android.content.Context context, java.lang.String baseUrl, java.lang.String token, java.lang.String apiKey) Get instance of LilyAI.
java.lang.String	getUUID() Get current UUID value stored by LilyAI.
void	resetUUID() Reset the stored UUID to a new random value.
void	setAnalyticsProviderID(java.lang.String aid)
void	setAnalyticsSessionID(java.lang.String sid)
void	setExperimentId(java.lang.String expid)
void	setHashedUserEmail(java.lang.String uem)
void	setReferer(java.lang.String src, java.lang.String mdm, java.lang.String pgpath, java.lang.String pgcat, java.lang.String pgtype)
void	setSessionDuration(long sessionDuration) Set session duration time.
void	setUserID(java.lang.String uid)
void	setUserSourceIP(java.lang.String sip)
void	setUUID(java.lang.String uuid) Set a new custom UUID value.
void	setVisitorId(java.lang.String vid)
void	track(org.json.JSONObject data) Send your data to LilyAI.
void	track(org.json.JSONObject data, LilyAiListener listener) Send your data to LilyAI.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static LilyAi getInstance(android.content.Context context)

Get instance of LilyAI.

To use this method you should provide api-key and token in meta-data tags in your AndroidManifest.xml inside application tag:

 
 <application ...>
     <meta-data android:name="ai.lily.analytics.api_token" android:value="PLACE_YOUR_API_TOKEN_HERE" />
     <meta-data android:name="ai.lily.analytics.api_key" android:value="PLACE_YOUR_API_KEY_HERE" />
     <meta-data android:name="ai.lily.analytics.endpoint" android:value="PLACE_YOUR_ENDPOINT_HERE" />
 </application>
 
 

Parameters:

context - The application context.

Returns:

an instance of LilyAI associated with provided token and api-key.

getInstance

public static LilyAi getInstance(android.content.Context context,
                                 java.lang.String token)

Get instance of LilyAI.

To use this method you should provide api-key in meta-data tag in your AndroidManifest.xml inside application tag:

 
 <application ...>
     <meta-data android:name="ai.lily.analytics.api_key" android:value="PLACE_YOUR_API_KEY_HERE" />
     <meta-data android:name="ai.lily.analytics.endpoint" android:value="PLACE_YOUR_ENDPOINT_HERE" />
 </application>
 
 

Parameters:

context - The application context.

token - Your api token string.

Returns:

an instance of LilyAI associated with provided token and api-key.

getInstance

public static LilyAi getInstance(android.content.Context context,
                                 java.lang.String baseUrl,
                                 java.lang.String token,
                                 java.lang.String apiKey)

Get instance of LilyAI.

Parameters:

context - The application context.

token - Your api token string.

apiKey - Your api-key string.

Returns:

an instance of LilyAI associated with provided token and api-key.

resetUUID

public void resetUUID()

Reset the stored UUID to a new random value.

setUUID

public void setUUID(java.lang.String uuid)

Set a new custom UUID value.

Parameters:

uuid - New UUID value to store and use. Can't be null or empty string.

getUUID

public java.lang.String getUUID()

Get current UUID value stored by LilyAI.

Returns:

UUID string

setSessionDuration

public void setSessionDuration(long sessionDuration)

Set session duration time.

Parameters:

sessionDuration - max session duration time (millis)

track

public void track(org.json.JSONObject data)

Send your data to LilyAI. Data is sent asynchronously. Same as track(JSONObject, LilyAiListener) with listener set to null.

Parameters:

data - Your JSON data.

track

public void track(org.json.JSONObject data,
                  LilyAiListener listener)

Send your data to LilyAI. Data is sent asynchronously. Methods of LilyAiListener will be called on the MainLooper.

Parameters:

data - Your JSON data. If data is null LilyAiListener.onError(String) will be called with message "JSON data is null".

listener - Callbacks for data send success or error. Can be null.

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

setUserID

public void setUserID(java.lang.String uid)

setAnalyticsProviderID

public void setAnalyticsProviderID(java.lang.String aid)

setAnalyticsSessionID

public void setAnalyticsSessionID(java.lang.String sid)

setHashedUserEmail

public void setHashedUserEmail(java.lang.String uem)

setReferer

public void setReferer(java.lang.String src,
                       java.lang.String mdm,
                       java.lang.String pgpath,
                       java.lang.String pgcat,
                       java.lang.String pgtype)

setExperimentId

public void setExperimentId(java.lang.String expid)

setUserSourceIP

public void setUserSourceIP(java.lang.String sip)

setVisitorId

public void setVisitorId(java.lang.String vid)