com.kii.cloud.analytics

Class KiiEvent

java.lang.Object

com.kii.cloud.analytics.KiiEvent

public final class KiiEvent
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.json.JSONObject	mJSON

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String key) Returns boolean value corresponding to the key.
float	getFloat(java.lang.String key) Returns float value corresponding to the key.
float[]	getFloatArray(java.lang.String key) Get float array.
int	getInt(java.lang.String key) Returns integer value corresponding to the key.
int[]	getIntArray(java.lang.String key) Get int array.
protected org.json.JSONArray	getJSONArray(java.lang.String key) Returns JSONArray value corresponding to the key.
protected org.json.JSONObject	getJSONObject(java.lang.String key) Returns JSONObject value corresponding to the key.
long	getLong(java.lang.String key) Returns long value corresponding to the key.
long[]	getLongArray(java.lang.String key) Get long array.
java.lang.String	getString(java.lang.String key) Returns String value corresponding to the key.
java.lang.String[]	getStringArray(java.lang.String key) Get String array.
boolean	has(java.lang.String key) Checks has value corresponding to the key.
static boolean	isValidKey(java.lang.String key) Check whether the key is valid or not.
static boolean	isValidType(java.lang.String type) Check whether the type is valid or not.
boolean	optBoolean(java.lang.String key, boolean defaultValue) Returns boolean value corresponding to the key.
float	optFloat(java.lang.String key, float defaultValue) Returns float value corresponding to the key.
float[]	optFloatArray(java.lang.String key) Returns float array corresponding to the key.
int	optInt(java.lang.String key, int defaultValue) Returns integer value corresponding to the key.
int[]	optIntArray(java.lang.String key) Returns int array corresponding to the key.
protected org.json.JSONArray	optJSONArray(java.lang.String key) Returns JSONObject value mapped by the key. If mapping does not exists or value is not JSONArray, returns null.
protected org.json.JSONObject	optJSONObject(java.lang.String key) Returns JSONObject value mapped by the key. If mapping does not exists or value is not JSONObject, returns null.
long	optLong(java.lang.String key, long defaultValue) Returns long value corresponding to the key.
long[]	optLongArray(java.lang.String key) Returns long array corresponding to the key.
java.lang.String	optString(java.lang.String key, java.lang.String defaultValue) Returns String value corresponding to the key.
java.lang.String[]	optStringArray(java.lang.String key) Returns String array corresponding to the key.
void	push() Event will be cached in persistent storage and uploaded by batch. Upload will be done automatically in a fixed interval. So no need to care about the upload after you pushed in the queue by calling this method.
void	push(KiiEventCallback callback) Asynchronous version of push() NOTE: this api should be called from UI/Main thread.
void	remove(java.lang.String key) Remove the value corresponding to the key.
void	set(java.lang.String key, boolean value) Set the boolean value.
void	set(java.lang.String key, float value) Set the float value.
void	set(java.lang.String key, int value) Set the integer value.
protected void	set(java.lang.String key, org.json.JSONArray value) Set the JSONArray value.
protected void	set(java.lang.String key, org.json.JSONObject value) Set the JSONObject value.
void	set(java.lang.String key, long value) Set the long value.
void	set(java.lang.String key, java.lang.String value) Set the string value.
void	setFloatArray(java.lang.String key, float... values) Set the float array.
void	setIntArray(java.lang.String key, int... values) Set the int array.
void	setLongArray(java.lang.String key, long... values) Set the long array.
void	setStringArray(java.lang.String key, java.lang.String... values) Set the String array.
org.json.JSONObject	toJson() Return JSON representation of the event.
void	upload() Deprecated. Use push(KiiEventCallback) instead. Upload this event to server. Event will be analyzed by defined rule on server by batch.
void	upload(KiiEventCallback callback) Deprecated. Use push(KiiEventCallback) instead. Asynchronous version of upload() NOTE: this api should be called from UI/Main thread. WrongThreadException will be thrown when this api called from sub thread.
static void	validateKey(java.lang.String key) Validate Key.
static void	validateType(java.lang.String type) Validate type Must matches with the pattern ^\\S.* Length must be less than or equals 128bytes in UTF-8

Methods inherited from class java.lang.Object

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

Field Detail

mJSON

protected org.json.JSONObject mJSON

Method Detail

push

public void push(KiiEventCallback callback)

Asynchronous version of push()
NOTE: this api should be called from UI/Main thread. WrongThreadException will be thrown when this api called from sub thread.

Parameters:

callback - Notifies completion of the push. callback methods will be executed on UI/Main thread.

push

public void push()
          throws java.io.IOException

Event will be cached in persistent storage and uploaded by batch.
Upload will be done automatically in a fixed interval.
So no need to care about the upload after you pushed in the queue by calling this method.

Throws:

java.io.IOException - thrown when failed to store event on persistent storage.

java.lang.IllegalStateException - If SDK is not initialized.

toJson

public org.json.JSONObject toJson()

Return JSON representation of the event.

upload

public void upload()
            throws KiiAnalyticsException

Deprecated. Use push(KiiEventCallback) instead. Upload this event to server. Event will be analyzed by defined rule on server by batch.

Throws:

KiiAnalyticsException

java.lang.IllegalStateException - If SDK is not initialized.

upload

public void upload(KiiEventCallback callback)

Deprecated. Use push(KiiEventCallback) instead. Asynchronous version of upload()
NOTE: this api should be called from UI/Main thread. WrongThreadException will be thrown when this api called from sub thread.

Parameters:

callback - notifies event. callback methods will be executed on UI/Main thread.

validateKey

public static void validateKey(java.lang.String key)
                        throws KiiAnalyticsFormatException

Validate Key.

Parameters:

key -

Throws:

KiiAnalyticsFormatException - when key is invalid. Key validation rules:

Key must not be null/empty.

Key must match with pattern ^[a-zA-Z][a-zA-Z0-9_]{0,63}$

isValidKey

public static boolean isValidKey(java.lang.String key)

Check whether the key is valid or not.

Parameters:

key -

Returns:

false if key is invalid, otherwise true. Key validation rules:

Key must not be null/empty.

Key must match with pattern ^[a-zA-Z][a-zA-Z0-9_]{0,63}$

validateType

public static void validateType(java.lang.String type)
                         throws KiiAnalyticsFormatException

Validate type

Must matches with the pattern ^\\S.* Length must be less than or equals 128bytes in UTF-8

Parameters:

type - to validate

Throws:

KiiAnalyticsFormatException - when type is not acceptable format.

isValidType

public static boolean isValidType(java.lang.String type)

Check whether the type is valid or not.

Must matches with the pattern ^\\S.* Length must be less than or equals 128bytes in UTF-8