public class KiiAnalytics
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
KiiAnalytics.Site |
Modifier and Type | Method and Description |
---|---|
static KiiEvent |
event(java.lang.String type)
Instantiate new event.
|
static GroupedResult |
getResult(java.lang.String ruleId,
ResultQuery query)
Get analytics result in Grouped format.
|
static void |
getResult(java.lang.String ruleId,
ResultQuery query,
KiiResultCallback callback)
Asynchronous version of
getResult(String, ResultQuery)
NOTE: this api should be called from UI/Main thread. |
static java.lang.String |
getSDKVersion()
Returns KiiAnalytics SDK Version Number.
|
static void |
initialize(android.content.Context context,
java.lang.String appId,
java.lang.String appKey,
KiiAnalytics.Site site)
Initialize KiiAnalytics SDK.
|
static void |
initialize(android.content.Context context,
java.lang.String appId,
java.lang.String appKey,
java.lang.String serverUrl)
Initialize KiiAnalytics SDK.
|
public static void initialize(android.content.Context context, java.lang.String appId, java.lang.String appKey, java.lang.String serverUrl)
appId
- id of the application. Must not be null or empty.appKey
- key of the application. Must not be null or empty.serverUrl
- server manages analytics. Must not be null or empty.java.lang.IllegalArgumentException
- If context is null or appId, appKey or serverUrl is invalid.public static void initialize(android.content.Context context, java.lang.String appId, java.lang.String appKey, KiiAnalytics.Site site)
appId
- id of the application. Must not be null or empty.appKey
- key of the application. Must not be null or empty. site
- KiiAnalytics.Site
to use. Must not be null. java.lang.IllegalArgumentException
- If context is null or appId, appKey, site is invalid.public static KiiEvent event(java.lang.String type)
type
- of event. Since this field is mandatory for analytics, null or empty is NOT acceptable.KiiAnalyticsFormatException
- when type is not acceptable format.
for details refer to KiiEvent.isValidType(String)
or
KiiEvent.validateType(String)
KiiEvent.isValidType(String)
,
KiiEvent.validateType(String)
public static GroupedResult getResult(java.lang.String ruleId, ResultQuery query) throws KiiAnalyticsException
ruleId
- aggregation rule id published on creating aggregation rule.query
- query parameters.If the query is null, result will
be re-aggregated with group named "DEFAULT" and also will not
be filtered by filter-key and date range.java.lang.IllegalArgumentException
- If ruleId is null or empty.java.lang.IllegalStateException
- If SDK is not initialized.KiiAnalyticsException
public static void getResult(java.lang.String ruleId, ResultQuery query, KiiResultCallback callback)
getResult(String, ResultQuery)
WrongThreadException
will be thrown when this api called from
sub thread.ruleId
- aggregation rule id published on creating aggregation rule.query
- query parameterscallback
- notifies event, result.
callback methods will be executed on UI/Main thread.public static java.lang.String getSDKVersion()
Copyright 2014 Kii Corporation. All rights reserved. (Last updated on 2015-05-26 10:13 UTC)