userkit.sdk

Class UserKit

java.lang.Object

userkit.sdk.UserKit

public class UserKit
extends java.lang.Object

Created by khangnt on 8/15/16. Email: khang.neon.1997@gmail.com

Method Summary

Modifier and Type	Method and Description
void	alias(java.lang.String aliasProfileID, OnProfileEditCallback defaultCallback) Alias profile ID.
static UserKit	getInstance() * Get UserKit singleton instance.
java.lang.String	getProfileId() Get current profile ID.
ProfileManager	getProfileManager() Get ProfileManager instance.
boolean	hasProfile() Check if current profile ID is null or not.
void	identify(java.lang.String profileId) Replace current profile ID with new one (in local), all analytic events and profile updating will use this identified ID.
static void	init(android.content.Context context) Initialization UserKit instance, your api token must be placed in AndroidManifest.xml inside application tag.
static void	init(android.content.Context context, java.lang.String apiToken) Initialization UserKit instance with an api token.
boolean	postGcmToken(java.lang.String deviceToken) Register GCM (device) token to CMS synchronously, don't run this method in main thread.
void	timeEvent(java.lang.String eventName) Start tracking duration of a timing event.
void	track(java.lang.String eventName, org.json.JSONObject properties) Tracking event.
void	track(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> props) Tracking event.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static UserKit getInstance()

* Get UserKit singleton instance.

Returns:

UserKit single instance

Throws:

java.lang.IllegalStateException - if UserKit has not been initialized.

init

public static void init(android.content.Context context)

Initialization UserKit instance, your api token must be placed in AndroidManifest.xml inside application tag.

 
 <meta-data android:name="USER_KIT_API_TOKEN" android:value="your_api_token_here" />
 
 

Parameters:

context - application context.

See Also:

init(Context, String)

init

public static void init(android.content.Context context,
                        java.lang.String apiToken)

Initialization UserKit instance with an api token.

Parameters:

context - application context

apiToken - userkit api token

identify

public void identify(java.lang.String profileId)

Replace current profile ID with new one (in local), all analytic events and profile updating will use this identified ID.

Parameters:

profileId - new profile ID.

See Also:

getProfileId(), ProfileManager.getProfileId()

getProfileManager

public ProfileManager getProfileManager()

Get ProfileManager instance.

Returns:

ProfileManager instance.

See Also:

ProfileManager

hasProfile

public boolean hasProfile()

Check if current profile ID is null or not.

Returns:

true if current profile ID is not null, otherwise return false.

getProfileId

public java.lang.String getProfileId()

Get current profile ID.

Returns:

current profile ID.

postGcmToken

@WorkerThread
public boolean postGcmToken(java.lang.String deviceToken)
                                   throws java.io.IOException

Register GCM (device) token to CMS synchronously, don't run this method in main thread.
Normally, SDK will handle this stuff, developer needn't care about this. Whenever GCM token was refreshed or profile ID was updated, an OneoffTask will be scheduled to update token in CMS.

Parameters:

deviceToken - GCM token of current device.

Returns:

true if process was success, otherwise return false.

Throws:

java.io.IOException

alias

public void alias(java.lang.String aliasProfileID,
                  OnProfileEditCallback defaultCallback)

Alias profile ID.

Parameters:

aliasProfileID - alias profile ID.

defaultCallback - OnProfileEditCallback

timeEvent

public void timeEvent(java.lang.String eventName)

Start tracking duration of a timing event.

Parameters:

eventName - The event name, must be consistent with argument `eventName` on track(String, JSONObject)

track

public void track(java.lang.String eventName,
                  java.util.Map<java.lang.String,java.lang.Object> props)

Tracking event.

Parameters:

eventName - The event name.

props - properties of this event.

track

public void track(java.lang.String eventName,
                  org.json.JSONObject properties)

Tracking event.

Parameters:

eventName - the event name.

properties - properties of this event.