KongregateAPI

```
public interface KongregateAPI
```
Main Kongregate API object which can be used to access various services such as KongregateServices or StatServices

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLOUD_GAME` track the subset of analytic data automatically for games with server logic
`static java.lang.String`	`DISABLE_ALL` disables all automatic analyitcs collection
`static java.lang.String`	`ENABLE_ALL` the default enable automatic analytics
`static java.lang.String`	`GUEST_GAME_AUTH_TOKEN` Game auth for a guest
`static long`	`GUEST_USER_ID` User ID for a guest
`static java.lang.String`	`GUEST_USERNAME` Username for a guest
`static java.lang.String`	`KONGREGATE_ADJUST_INSTALL_EVENT_TOKEN`
`static java.lang.String`	`KONGREGATE_ADJUST_PREFIX`
`static java.lang.String`	`KONGREGATE_ADJUST_SALE_EVENT_TOKEN`
`static java.lang.String`	`KONGREGATE_ADJUST_SESSION_EVENT_TOKEN`
`static java.lang.String`	`KONGREGATE_API_VERSION` Client API version
`static java.lang.String`	`KONGREGATE_OPTION_ADJUST_APP_TOKEN` Adjust Options
`static java.lang.String`	`KONGREGATE_OPTION_ADJUST_ENVIRONMENT`
`static java.lang.String`	`KONGREGATE_OPTION_ADX_ENABLED` Deprecated.
`static java.lang.String`	`KONGREGATE_OPTION_ADX_UPGRADE` Deprecated.
`static java.lang.String`	`KONGREGATE_OPTION_ALLOW_IMMERSIVE_MODE` Option to disable immersive mode on Android 4.4+ devices.
`static java.lang.String`	`KONGREGATE_OPTION_ANALYTICS_DOMAIN` Option to override the Kong Analytics domain
`static java.lang.String`	`KONGREGATE_OPTION_ANALYTICS_MODE` Option indicating the game logic and players exist on a game server
`static java.lang.String`	`KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER` Option to filter properties or events.
`static java.lang.String`	`KONGREGATE_OPTION_AUTO_PROCESS_DEEP_LINKS` Option to automatically parse deep links and notify adjust re-attributions when activities are launched with `Intent.ACTION_VIEW` action and contain URI data.
`static java.lang.String`	`KONGREGATE_OPTION_AUTO_REPOSITION` Unity only option.
`static java.lang.String`	`KONGREGATE_OPTION_CRASHLYTICS_LOGGING` Option to have the Kongregate SDK log to Crashlytics logging API.
`static java.lang.String`	`KONGREGATE_OPTION_CRASHLYTICS_USER_KEYS` Option to have the Kongregate SDK use the Crashlytics user keys API.
`static java.lang.String`	`KONGREGATE_OPTION_CUSTOM_PLAYER_ID` Specifies the Player ID to be sent with every event.
`static java.lang.String`	`KONGREGATE_OPTION_DEBUG` Option to control debugging/verbose logging type: Boolean, default: Boolean.FALSE
`static java.lang.String`	`KONGREGATE_OPTION_DEBUG_WEBVIEW` Option to control KitKat WebView debugging type: Boolean, default Boolean.FALSE
`static java.lang.String`	`KONGREGATE_OPTION_DEFAULT_PANEL_TRANSITION` Specify default panel transition to use when the panel is open.
`static java.lang.String`	`KONGREGATE_OPTION_DEFER_ANALYTICS` Option to defer initialization of the Analytics class.
`static java.lang.String`	`KONGREGATE_OPTION_DEFER_GDPR_ALERT` Option to defer the GDPR alert dialog until `MobileServices.GDPR_ALERT_TRIGGER` is triggered (`MobileServices.trigger(String)` (String)})
`static java.lang.String`	`KONGREGATE_OPTION_DELTA_COLLECT_URL` Option to specify the DeltaDNA Collect URL
`static java.lang.String`	`KONGREGATE_OPTION_DELTA_ENGAGE_URL` Option to specify the DeltaDNA Engage URL
`static java.lang.String`	`KONGREGATE_OPTION_DELTA_ENVIRONMENT_KEY` Option to specify the DeltaDNA Environment key
`static java.lang.String`	`KONGREGATE_OPTION_DOMAIN` Option to change the back-end domain, Type: String, default: "m.kongregate.com"
`static java.lang.String`	`KONGREGATE_OPTION_GUILD_CHAT` Enables guild chat functionality if also enabled on the server.
`static java.lang.String`	`KONGREGATE_OPTION_KEEN_PROJECT_ID` Keen options are included for legacy games.
`static java.lang.String`	`KONGREGATE_OPTION_KEEN_WRITE_KEY` Keen options are included for legacy games.
`static java.lang.String`	`KONGREGATE_OPTION_KONG_ANALYTICS_ID` Option to specify the Kongregate Analytics application ID
`static java.lang.String`	`KONGREGATE_OPTION_KONG_ANALYTICS_KEY` Option to specify the Kong Analytics API key
`static java.lang.String`	`KONGREGATE_OPTION_MANAGE_LIFECYCLE` Option to control automatic onPause/onResume calls for API >= 14 type: Boolean, default Boolean.TRUE
`static java.lang.String`	`KONGREGATE_OPTION_PANEL_ORIENTATION_OVERRIDE` Option to override default panel orientation mode ("sensor").
`static java.lang.String`	`KONGREGATE_OPTION_PERSISTENT_WEBVIEW` Enables a persistent WebView rather than creating new WebView instances.
`static java.lang.String`	`KONGREGATE_OPTION_SHOW_SYSTEM_UI` Option to show the system UI when the kongregate panel is up.
`static java.lang.String`	`KONGREGATE_OPTION_STRICT_LIFECYCLE_MODE` Option to enable strict lifecyle tracking.
`static java.lang.String`	`KONGREGATE_OPTION_SUPPORTED_PANEL_EVENTS` Provide a list of panel events your game supports.
`static java.lang.String`	`KONGREGATE_OPTION_SWRVE_API_KEY` Option to specify the SWRVE API key
`static java.lang.String`	`KONGREGATE_OPTION_SWRVE_APP_ID` Option to specify the SWRVE APP ID
`static java.lang.String`	`KONGREGATE_OPTION_TEST_GDPR_ALERT` Set this flag to force the GDPR dialog to always show every time it's checked.
`static java.lang.String`	`KONGREGATE_SWRVE_APP_STORE`
`static java.lang.String`	`KONGREGATE_SWRVE_APP_VERSION`
`static java.lang.String`	`KONGREGATE_SWRVE_AUTO_DOWNLOAD`
`static java.lang.String`	`KONGREGATE_SWRVE_CACHE_DIR`
`static java.lang.String`	`KONGREGATE_SWRVE_DB_NAME`
`static java.lang.String`	`KONGREGATE_SWRVE_LANGUAGE`
`static java.lang.String`	`KONGREGATE_SWRVE_LINK_TOKEN`
`static java.lang.String`	`KONGREGATE_SWRVE_MAX_DB_SIZE`
`static java.lang.String`	`KONGREGATE_SWRVE_MAX_EVENTS_PER_FLUSH`
`static java.lang.String`	`KONGREGATE_SWRVE_PREFIX` SWRVE Options
`static java.lang.String`	`KONGREGATE_SWRVE_SENDER_ID`
`static java.lang.String`	`KONGREGATE_SWRVE_TALK_ENABLED`
`static java.lang.String`	`ORIENTATION_LANDSCAPE`
`static java.lang.String`	`ORIENTATION_LANDSCAPE_SENSOR`
`static java.lang.String`	`ORIENTATION_PORTRAIT` Panel orientation options.
`static java.lang.String`	`ORIENTATION_PORTRAIT_SENSOR`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addEventBundleListener(KongregateEventBundleListener listener)` Adds a KongregateEventBundleListener.
`void`	`addEventListener(KongregateEventListener listener)` Adds an event listener.
`AnalyticsServices`	`analytics()`
`java.lang.String`	`getApiKey()`
`android.content.Context`	`getApplicationContext()`
`long`	`getApplicationId()`
`boolean`	`isReady()`
`MobileServices`	`mobile()`
`MicrotransactionServices`	`mtx()`
`void`	`onCreate(android.app.Activity activity, android.os.Bundle savedInstanceState)` Invoke when activity in game that uses the Kongregate API is created
`void`	`onDestroy(android.app.Activity activity)` Invoke when activity in game that uses the Kongregate API is destroyed
`void`	`onLowMemory()` Invoke when activity in game that uses the Kongregate API gets a low memory warning
`void`	`onPause(android.app.Activity context)` Invoke when an activity in game that uses the Native API is paused
`void`	`onPause(android.app.Activity context, java.util.Map<java.lang.String,java.lang.Object> commonProperties)` Invoke when an activity in game that uses the Native API is paused
`void`	`onPause(android.app.Activity context, java.lang.String commonPropsJson)` Invoke when an activity in game that uses the Native API is paused
`void`	`onResume(android.app.Activity context)` Invoke when activity in game that uses the Native API resumes
`void`	`onResume(android.app.Activity context, java.util.Map<java.lang.String,java.lang.Object> commonProperties)` Invoke when an activity in game that uses the Native API is paused
`void`	`onResume(android.app.Activity context, java.lang.String commonPropsJson)` Invoke when activity in game that uses the Native API resumes
`java.util.List<KongregateEventBundle>`	`pollEventBundles()` Polls for KongregateEventsBundles.
`java.util.List<java.lang.String>`	`pollEvents()` Call to poll for events instead of using a listener.
`void`	`removeEventBundleListener(KongregateEventBundleListener listener)` Remove a KongregateEventBundleListener.
`void`	`removeEventListener(KongregateEventListener listener)` Removes an event listener
`KongregateServices`	`services()`
`StatServices`	`stats()`
`void`	`willOpenUrl(android.net.Uri uri)` Invoke when your app is being launched using a deep link and `KONGREGATE_OPTION_AUTO_PROCESS_DEEP_LINKS` is false (default for Native API).

- Field Detail
  - KONGREGATE_API_VERSION
```
static final java.lang.String KONGREGATE_API_VERSION
```
    Client API version
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DOMAIN
```
static final java.lang.String KONGREGATE_OPTION_DOMAIN
```
    Option to change the back-end domain, Type: String, default: "m.kongregate.com"
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DEBUG
```
static final java.lang.String KONGREGATE_OPTION_DEBUG
```
    Option to control debugging/verbose logging type: Boolean, default: Boolean.FALSE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DEBUG_WEBVIEW
```
static final java.lang.String KONGREGATE_OPTION_DEBUG_WEBVIEW
```
    Option to control KitKat WebView debugging type: Boolean, default Boolean.FALSE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_MANAGE_LIFECYCLE
```
static final java.lang.String KONGREGATE_OPTION_MANAGE_LIFECYCLE
```
    Option to control automatic onPause/onResume calls for API >= 14 type: Boolean, default Boolean.TRUE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_SHOW_SYSTEM_UI
```
static final java.lang.String KONGREGATE_OPTION_SHOW_SYSTEM_UI
```
    Option to show the system UI when the kongregate panel is up. See http://developer.android.com/reference/android/view/View.html#setSystemUiVisibility(int) Type: Boolean, default: Boolean.FALSE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_ALLOW_IMMERSIVE_MODE
```
static final java.lang.String KONGREGATE_OPTION_ALLOW_IMMERSIVE_MODE
```
    Option to disable immersive mode on Android 4.4+ devices. By default, the SDK will attempt to enter immersive mode when it is initialized, or when the onResume method is called with a valid Activity. Type: Boolean, default: Boolean.TRUE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_KEEN_PROJECT_ID
```
static final java.lang.String KONGREGATE_OPTION_KEEN_PROJECT_ID
```
    Keen options are included for legacy games. New games should use Swrve.
    Option to set a Keen project ID. Used for tracking analytics. Must also specify KONGREGATE_OPTION_KEEN_WRITE_KEY
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_KEEN_WRITE_KEY
```
static final java.lang.String KONGREGATE_OPTION_KEEN_WRITE_KEY
```
    Keen options are included for legacy games. New games should use Swrve.
    Option to set a Keen write key. To be used with KONGREGATE_OPTION_KEEN_PROJECT_ID
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_ANALYTICS_MODE
```
static final java.lang.String KONGREGATE_OPTION_ANALYTICS_MODE
```
    Option indicating the game logic and players exist on a game server
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DEFER_ANALYTICS
```
static final java.lang.String KONGREGATE_OPTION_DEFER_ANALYTICS
```
    Option to defer initialization of the Analytics class. Use this if you need to collect data before sending initial events, or if you initialize the Kongregate API when your game is started via a Service, BroadcastReceiver, Alarm, etc.
    If you use enable this flag, you should manually initialize the Analytics class when appropriate. For example, when your main Activity is created. You can initialize the Analytics system using AnalyticsServices.start(Activity)
    Type: Boolean, default: Boolean.FALSE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_PERSISTENT_WEBVIEW
```
static final java.lang.String KONGREGATE_OPTION_PERSISTENT_WEBVIEW
```
    Enables a persistent WebView rather than creating new WebView instances. This makes memory usage more stable, and it is recommended you set this value to true for better panel performance. You should only disable this if you are running into problems.
    Type: Boolean, default: Boolean.TRUE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_GUILD_CHAT
```
static final java.lang.String KONGREGATE_OPTION_GUILD_CHAT
```
    Enables guild chat functionality if also enabled on the server. This flag can be used for testing guild chat before rolling it out in a live release.
    Type: Boolean, default: Boolean.FALSE
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER
```
static final java.lang.String KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER
```
    Option to filter properties or events. A comma delimeted list of field and event names.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_ADX_ENABLED
```
@Deprecated
static final java.lang.String KONGREGATE_OPTION_ADX_ENABLED
```
    Deprecated.
    
    AD-X is no longer included with the SDK
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_ADX_UPGRADE
```
@Deprecated
static final java.lang.String KONGREGATE_OPTION_ADX_UPGRADE
```
    Deprecated.
    
    AD-X is no longer included with the SDK
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_SWRVE_APP_ID
```
static final java.lang.String KONGREGATE_OPTION_SWRVE_APP_ID
```
    Option to specify the SWRVE APP ID
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_SWRVE_API_KEY
```
static final java.lang.String KONGREGATE_OPTION_SWRVE_API_KEY
```
    Option to specify the SWRVE API key
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DELTA_ENVIRONMENT_KEY
```
static final java.lang.String KONGREGATE_OPTION_DELTA_ENVIRONMENT_KEY
```
    Option to specify the DeltaDNA Environment key
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DELTA_COLLECT_URL
```
static final java.lang.String KONGREGATE_OPTION_DELTA_COLLECT_URL
```
    Option to specify the DeltaDNA Collect URL
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DELTA_ENGAGE_URL
```
static final java.lang.String KONGREGATE_OPTION_DELTA_ENGAGE_URL
```
    Option to specify the DeltaDNA Engage URL
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_KONG_ANALYTICS_ID
```
static final java.lang.String KONGREGATE_OPTION_KONG_ANALYTICS_ID
```
    Option to specify the Kongregate Analytics application ID
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_KONG_ANALYTICS_KEY
```
static final java.lang.String KONGREGATE_OPTION_KONG_ANALYTICS_KEY
```
    Option to specify the Kong Analytics API key
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_ANALYTICS_DOMAIN
```
static final java.lang.String KONGREGATE_OPTION_ANALYTICS_DOMAIN
```
    Option to override the Kong Analytics domain
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_PANEL_ORIENTATION_OVERRIDE
```
static final java.lang.String KONGREGATE_OPTION_PANEL_ORIENTATION_OVERRIDE
```
    Option to override default panel orientation mode ("sensor").
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DEFAULT_PANEL_TRANSITION
```
static final java.lang.String KONGREGATE_OPTION_DEFAULT_PANEL_TRANSITION
```
    Specify default panel transition to use when the panel is open. This will be used in the place of the OS's default animation. The list of supported custom panel tranitions may be found in MobileServices ) (e.g. MobileServices.PANEL_TRANSITION_SLIDE_FROM_LEFT)
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_CRASHLYTICS_LOGGING
```
static final java.lang.String KONGREGATE_OPTION_CRASHLYTICS_LOGGING
```
    Option to have the Kongregate SDK log to Crashlytics logging API. Crashlytics must be integrated to use this option. Default if false.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_CRASHLYTICS_USER_KEYS
```
static final java.lang.String KONGREGATE_OPTION_CRASHLYTICS_USER_KEYS
```
    Option to have the Kongregate SDK use the Crashlytics user keys API. Crashlytics must be integrated to use this option. Default is false.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_STRICT_LIFECYCLE_MODE
```
static final java.lang.String KONGREGATE_OPTION_STRICT_LIFECYCLE_MODE
```
    Option to enable strict lifecyle tracking. When enabled, the Kongregate API must be initialized in your activity's onCreate() method and your onResume()/onPause() methods must invoke the corresponding SDK onResume()/onPause() methods. The default is off for convenience, since many development tools (i.e. Unity) do not provide direct access to activity lifecycle methods. This setting may need to be on for games with complex activity structures, in which multiple activities may be visible at the same time, for session tracking to work properly.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_AUTO_REPOSITION
```
static final java.lang.String KONGREGATE_OPTION_AUTO_REPOSITION
```
    Unity only option. Has no effect on native SDK
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_AUTO_PROCESS_DEEP_LINKS
```
static final java.lang.String KONGREGATE_OPTION_AUTO_PROCESS_DEEP_LINKS
```
    Option to automatically parse deep links and notify adjust re-attributions when activities are launched with Intent.ACTION_VIEW action and contain URI data. Default is OFF for Native API. Unity plugin sets this to TRUE. You may wish to set this to true if you are implementing a plugin. For Native Apps or Apps composed of many activities, you probably want to leave this false and invoke willOpenUrl(android.net.Uri) directly when using deep links.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_SUPPORTED_PANEL_EVENTS
```
static final java.lang.String KONGREGATE_OPTION_SUPPORTED_PANEL_EVENTS
```
    Provide a list of panel events your game supports. The panel may dynamically adjust it's UI based on the events your game supports. The list of panel events that may be fired can be found in MobileServices (e.g. MobileServices.PANEL_EVENT_GO_TO_GUILDS.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_CUSTOM_PLAYER_ID
```
static final java.lang.String KONGREGATE_OPTION_CUSTOM_PLAYER_ID
```
    Specifies the Player ID to be sent with every event. This value will also be used for the SWRVE User ID. In general this value should not be specified. When not specified, the SDK will generate a UUID to use as the Player ID. For special cases, such as for QA builds, it is sometimes useful to use this option to manually set the Player ID/SWRVE User ID.
    This option is only read when the app is first launched. The player ID can not change for a specific install, once it's been set.
    This option has no effect if the KONGREGATE_OPTION_ANALYTICS_MODE is set to CLOUD_GAME.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_DEFER_GDPR_ALERT
```
static final java.lang.String KONGREGATE_OPTION_DEFER_GDPR_ALERT
```
    Option to defer the GDPR alert dialog until MobileServices.GDPR_ALERT_TRIGGER is triggered (MobileServices.trigger(String) (String)})
    By default the GDPR Alert dialog will be shown as soon as the SDK detects the user needs to accept the privacy policy. This is typically shortly after the game is launched or returns to the foreground. Use this option to control the moment when the alert dialog may be shown.
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_TEST_GDPR_ALERT
```
static final java.lang.String KONGREGATE_OPTION_TEST_GDPR_ALERT
```
    Set this flag to force the GDPR dialog to always show every time it's checked. This option should only be used while testing your integration to verify the alert does not adversely affect your game. To control when the GDPR alert can appear, use KONGREGATE_OPTION_DEFER_GDPR_ALERT
    Be sure to remove this option from production builds
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_PREFIX
```
static final java.lang.String KONGREGATE_SWRVE_PREFIX
```
    SWRVE Options
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_AUTO_DOWNLOAD
```
static final java.lang.String KONGREGATE_SWRVE_AUTO_DOWNLOAD
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_LANGUAGE
```
static final java.lang.String KONGREGATE_SWRVE_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_LINK_TOKEN
```
static final java.lang.String KONGREGATE_SWRVE_LINK_TOKEN
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_APP_VERSION
```
static final java.lang.String KONGREGATE_SWRVE_APP_VERSION
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_TALK_ENABLED
```
static final java.lang.String KONGREGATE_SWRVE_TALK_ENABLED
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_APP_STORE
```
static final java.lang.String KONGREGATE_SWRVE_APP_STORE
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_SENDER_ID
```
static final java.lang.String KONGREGATE_SWRVE_SENDER_ID
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_MAX_DB_SIZE
```
static final java.lang.String KONGREGATE_SWRVE_MAX_DB_SIZE
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_DB_NAME
```
static final java.lang.String KONGREGATE_SWRVE_DB_NAME
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_MAX_EVENTS_PER_FLUSH
```
static final java.lang.String KONGREGATE_SWRVE_MAX_EVENTS_PER_FLUSH
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_SWRVE_CACHE_DIR
```
static final java.lang.String KONGREGATE_SWRVE_CACHE_DIR
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_ADJUST_APP_TOKEN
```
static final java.lang.String KONGREGATE_OPTION_ADJUST_APP_TOKEN
```
    Adjust Options
    
    See Also:
    
    Constant Field Values
  - KONGREGATE_OPTION_ADJUST_ENVIRONMENT
```
static final java.lang.String KONGREGATE_OPTION_ADJUST_ENVIRONMENT
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_ADJUST_PREFIX
```
static final java.lang.String KONGREGATE_ADJUST_PREFIX
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_ADJUST_SALE_EVENT_TOKEN
```
static final java.lang.String KONGREGATE_ADJUST_SALE_EVENT_TOKEN
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_ADJUST_SESSION_EVENT_TOKEN
```
static final java.lang.String KONGREGATE_ADJUST_SESSION_EVENT_TOKEN
```
    See Also:
    
    Constant Field Values
  - KONGREGATE_ADJUST_INSTALL_EVENT_TOKEN
```
static final java.lang.String KONGREGATE_ADJUST_INSTALL_EVENT_TOKEN
```
    See Also:
    
    Constant Field Values
  - ENABLE_ALL
```
static final java.lang.String ENABLE_ALL
```
    the default enable automatic analytics
    
    See Also:
    
    Constant Field Values
  - DISABLE_ALL
```
static final java.lang.String DISABLE_ALL
```
    disables all automatic analyitcs collection
    
    See Also:
    
    Constant Field Values
  - CLOUD_GAME
```
static final java.lang.String CLOUD_GAME
```
    track the subset of analytic data automatically for games with server logic
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_PORTRAIT
```
static final java.lang.String ORIENTATION_PORTRAIT
```
    Panel orientation options. If not specified, use "sensor"
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_PORTRAIT_SENSOR
```
static final java.lang.String ORIENTATION_PORTRAIT_SENSOR
```
    See Also:
    
    Constant Field Values
  - ORIENTATION_LANDSCAPE
```
static final java.lang.String ORIENTATION_LANDSCAPE
```
    See Also:
    
    Constant Field Values
  - ORIENTATION_LANDSCAPE_SENSOR
```
static final java.lang.String ORIENTATION_LANDSCAPE_SENSOR
```
    See Also:
    
    Constant Field Values
  - GUEST_USER_ID
```
static final long GUEST_USER_ID
```
    User ID for a guest
    
    See Also:
    
    Constant Field Values
  - GUEST_USERNAME
```
static final java.lang.String GUEST_USERNAME
```
    Username for a guest
    
    See Also:
    
    Constant Field Values
  - GUEST_GAME_AUTH_TOKEN
```
static final java.lang.String GUEST_GAME_AUTH_TOKEN
```
    Game auth for a guest
    
    See Also:
    
    Constant Field Values
- Method Detail
  - services
```
KongregateServices services()
```
    Returns:
    
    The KongregateServices implementation, or null if not yet initialized.
  - stats
```
StatServices stats()
```
    Returns:
    
    The StatServices implementation, or null if not yet initialized.
  - mtx
```
MicrotransactionServices mtx()
```
    Returns:
    
    The MicrotransactionServices implementation, or null if not yet initialized
  - mobile
```
MobileServices mobile()
```
    Returns:
    
    The MobileServices implementation, or null if not yet initialized.
  - analytics
```
AnalyticsServices analytics()
```
    Returns:
    
    the AnalyticsServices implementation, or null if not yet initialized.
  - isReady
```
boolean isReady()
```
    Returns:
    
    True if the API is ready to use
  - addEventBundleListener
```
void addEventBundleListener(KongregateEventBundleListener listener)
```
    Adds a KongregateEventBundleListener. This version of Kongregate event listener includes JSON payloads along with the event. The old method addEventListener(KongregateEventListener) still works but only receives the event name.
    
    Parameters:
    
    listener - the listener to add
  - removeEventBundleListener
```
void removeEventBundleListener(KongregateEventBundleListener listener)
```
    Remove a KongregateEventBundleListener.
    
    Parameters:
    
    listener - the listener to remove
  - pollEventBundles
```
java.util.List<KongregateEventBundle> pollEventBundles()
```
    Polls for KongregateEventsBundles. This is a new version of Kongregate event includes an event name and JSON payload. The old method pollEvents() still works, but only includes event names.
    After this or pollEvents() is invoked, the event queue will be cleared out.
    
    Returns:
    
    A list of pending KongregateEventBundles.
  - addEventListener
```
void addEventListener(KongregateEventListener listener)
```
    Adds an event listener. This event listener will receive just the event name. If you need access to the JSON payload sometimes includes with the event, use the new addEventBundleListener(KongregateEventBundleListener) method.
    
    Parameters:
    
    listener - The listener
  - removeEventListener
```
void removeEventListener(KongregateEventListener listener)
```
    Removes an event listener
    
    Parameters:
    
    listener - The listener to remove
  - pollEvents
```
java.util.List<java.lang.String> pollEvents()
```
    Call to poll for events instead of using a listener. This will return just the event names. If you need access to the JSON payload sometimes included with the event, use the new pollEventBundles() method.
    
    Returns:
    
    List of events since the last poll
  - getApplicationContext
```
android.content.Context getApplicationContext()
```
    Returns:
    
    The application context
  - onPause
```
void onPause(android.app.Activity context)
```
    Invoke when an activity in game that uses the Native API is paused
    
    Parameters:
    
    context - The context
  - onPause
```
void onPause(android.app.Activity context,
             java.lang.String commonPropsJson)
```
    Invoke when an activity in game that uses the Native API is paused
    
    Parameters:
    
    context - The context
    
    commonPropsJson - JSON string containing common properties to update before pausing
  - onPause
```
void onPause(android.app.Activity context,
             java.util.Map<java.lang.String,java.lang.Object> commonProperties)
```
    Invoke when an activity in game that uses the Native API is paused
    
    Parameters:
    
    context - The context
    
    commonProperties - Map containing common properties to update before pausing
  - onResume
```
void onResume(android.app.Activity context)
```
    Invoke when activity in game that uses the Native API resumes
    
    Parameters:
    
    context - The context
  - onResume
```
void onResume(android.app.Activity context,
              java.lang.String commonPropsJson)
```
    Invoke when activity in game that uses the Native API resumes
    
    Parameters:
    
    context - The context
    
    commonPropsJson - JSON string containing common properties to update before resuming
  - onResume
```
void onResume(android.app.Activity context,
              java.util.Map<java.lang.String,java.lang.Object> commonProperties)
```
    Invoke when an activity in game that uses the Native API is paused
    
    Parameters:
    
    context - The context
    
    commonProperties - Map containing common properties to update before resuming
  - onCreate
```
void onCreate(android.app.Activity activity,
              android.os.Bundle savedInstanceState)
```
    Invoke when activity in game that uses the Kongregate API is created
    
    Parameters:
    
    savedInstanceState -
  - willOpenUrl
```
void willOpenUrl(android.net.Uri uri)
```
    Invoke when your app is being launched using a deep link and KONGREGATE_OPTION_AUTO_PROCESS_DEEP_LINKS is false (default for Native API).
    
    Parameters:
    
    uri - the URL of the deep link that will open the app
  - onDestroy
```
void onDestroy(android.app.Activity activity)
```
    Invoke when activity in game that uses the Kongregate API is destroyed
  - onLowMemory
```
void onLowMemory()
```
    Invoke when activity in game that uses the Kongregate API gets a low memory warning
  - getApiKey
```
java.lang.String getApiKey()
```
    Returns:
    
    the ApiKey used to initialize the API
  - getApplicationId
```
long getApplicationId()
```
    Returns:
    
    the application Id used to initialize the API

Interface KongregateAPI

Field Summary

Method Summary

Field Detail

KONGREGATE_API_VERSION

KONGREGATE_OPTION_DOMAIN

KONGREGATE_OPTION_DEBUG

KONGREGATE_OPTION_DEBUG_WEBVIEW

KONGREGATE_OPTION_MANAGE_LIFECYCLE

KONGREGATE_OPTION_SHOW_SYSTEM_UI

KONGREGATE_OPTION_ALLOW_IMMERSIVE_MODE

KONGREGATE_OPTION_KEEN_PROJECT_ID

KONGREGATE_OPTION_KEEN_WRITE_KEY

KONGREGATE_OPTION_ANALYTICS_MODE

KONGREGATE_OPTION_DEFER_ANALYTICS

KONGREGATE_OPTION_PERSISTENT_WEBVIEW

KONGREGATE_OPTION_GUILD_CHAT

KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER

KONGREGATE_OPTION_ADX_ENABLED

KONGREGATE_OPTION_ADX_UPGRADE

KONGREGATE_OPTION_SWRVE_APP_ID

KONGREGATE_OPTION_SWRVE_API_KEY

KONGREGATE_OPTION_DELTA_ENVIRONMENT_KEY

KONGREGATE_OPTION_DELTA_COLLECT_URL

KONGREGATE_OPTION_DELTA_ENGAGE_URL

KONGREGATE_OPTION_KONG_ANALYTICS_ID

KONGREGATE_OPTION_KONG_ANALYTICS_KEY

KONGREGATE_OPTION_ANALYTICS_DOMAIN

KONGREGATE_OPTION_PANEL_ORIENTATION_OVERRIDE

KONGREGATE_OPTION_DEFAULT_PANEL_TRANSITION

KONGREGATE_OPTION_CRASHLYTICS_LOGGING

KONGREGATE_OPTION_CRASHLYTICS_USER_KEYS

KONGREGATE_OPTION_STRICT_LIFECYCLE_MODE

KONGREGATE_OPTION_AUTO_REPOSITION

KONGREGATE_OPTION_AUTO_PROCESS_DEEP_LINKS

KONGREGATE_OPTION_SUPPORTED_PANEL_EVENTS

KONGREGATE_OPTION_CUSTOM_PLAYER_ID

KONGREGATE_OPTION_DEFER_GDPR_ALERT

KONGREGATE_OPTION_TEST_GDPR_ALERT

KONGREGATE_SWRVE_PREFIX

KONGREGATE_SWRVE_AUTO_DOWNLOAD

KONGREGATE_SWRVE_LANGUAGE

KONGREGATE_SWRVE_LINK_TOKEN

KONGREGATE_SWRVE_APP_VERSION

KONGREGATE_SWRVE_TALK_ENABLED

KONGREGATE_SWRVE_APP_STORE

KONGREGATE_SWRVE_SENDER_ID

KONGREGATE_SWRVE_MAX_DB_SIZE

KONGREGATE_SWRVE_DB_NAME

KONGREGATE_SWRVE_MAX_EVENTS_PER_FLUSH

KONGREGATE_SWRVE_CACHE_DIR

KONGREGATE_OPTION_ADJUST_APP_TOKEN

KONGREGATE_OPTION_ADJUST_ENVIRONMENT

KONGREGATE_ADJUST_PREFIX

KONGREGATE_ADJUST_SALE_EVENT_TOKEN

KONGREGATE_ADJUST_SESSION_EVENT_TOKEN

KONGREGATE_ADJUST_INSTALL_EVENT_TOKEN

ENABLE_ALL

DISABLE_ALL

CLOUD_GAME

ORIENTATION_PORTRAIT

ORIENTATION_PORTRAIT_SENSOR

ORIENTATION_LANDSCAPE

ORIENTATION_LANDSCAPE_SENSOR

GUEST_USER_ID

GUEST_USERNAME

GUEST_GAME_AUTH_TOKEN

Method Detail

services

stats

mtx

mobile

analytics

isReady

addEventBundleListener

removeEventBundleListener

pollEventBundles

addEventListener

removeEventListener

pollEvents