Reference to the analytics interface.

See also

Reference to the debug interface.

See also

Reference to the mobile interface.

See also

Reference to the mtx interface.

See also

The PlatformType of the current device.

See also

Reference to the services interface.

See also

Settings for congfiguring the SDK. Use settings.values to instantiate the SDK.

See also

Reference to the stats interface.

See also

Returns a reference to the web Kongregate API object, if on the web platform.

Initializes the API

Parameters

    KongregateAPI.settings.swrveAppId = KongregateConstants.swrveAppId;
    KongregateAPI.settings.swrveApiKey = KongregateConstants.swrveApiKey;
    mKongregate = KongregateAPI.initialize(
      root.stage,
      KongregateConstants.gameId,
      KongregateConstants.apiKey
    );
    

Adjust event: install

Adjust event: sale

Adjust event: session

Broadcast when a Kongregate automatic analytics event is fired.

Dispatched when a Kongregate API event is fired.

This is a special setting for games with server logic. Set this if your game will track player_creations events and the player_id field.

This setting will disable all automatic event and properties tracking

This setting is the default. The SDK will track the full suite of automatic events and fields.

Broadcast when a Delta button event is fired.

Broadcast when a Delta parameter event is fired.

Prefix to prepend to adjust options.

Broadcast when the API needs a new character token for guild chat authentication. This generally happens when a previously valid character token expires. If you receive this event repeatedly after generating a new token you may need to double check your JWT implementation and ensure you are using the proper server API key to sign the token.

Broadcast when the Kongregate panel has closed

Broadcast when the user's game authentication token has changed.

Broadcasts when the user has completed logging in on the panel.

Broadcast when the notification count for the current user changes

Broadcast when the app is opened or brought to the foreground via deep link

Broadcast when the Kongregate panel is about to be opened.

Event parameter: amount

Event parameter: currency

Event parameter: installUrl

Event parameter: item

Event parameter: promoId

Event for cross promo awards.

Broadcast when the API is initialized and ready to use

Broadcast when a receipt verification has completed.

Broadcast when Kongregate is unavailable. This may be due to network connectivity or Kongregate may be down for maintence.

Broadcast when the Swrve resources have been updated

Broadcast when the user has changed.

Broadcast when the user's inventory is received

Adjust configuration option.

Adjust configuration option.

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

Option indicating the game logic and players exist on a game server

Application version

Option to filter properties or events. A comma delimeted list of field and event names.

Application bundle ID

Option to have the Kongregate SDK log to Crashlytics logging API. Crashlytics must be integrated to use this option. Default if false.

Option to have the Kongregate SDK use the Crashlytics user keys API. Crashlytics must be integrated to use this option. Default is false.

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 {

Option to control debugging/verbose logging type: Boolean, default: Boolean.FALSE

Option to control KitKat WebView debugging type: Boolean, default Boolean.FALSE

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 transitions may be found in Mobile (e.g. Mobile.PANEL_TRANSITION_SLIDE_FROM_LEFT)

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 {

Option to defer the GDPR alert dialog until {

Option to specify the DELTA DNA COLLECT URL

Option to specify the DELTA DNA ENGAGE URL

Option to specify the DELTA DNA ENVIRONMENT KEY

Option to change the back-end domain, Type: String, default: "m.kongregate.com"

Option to disable the Kongregate plugin

Set the platform and client_version fields of this object to enable the external web API. You should only set this for builds that will be hosted off of Kongregate.

     KongregateAPI.settings.externalApi = {
       platform: "armorgames",
       client_version: "1.3.0"
     };
     

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

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 {

Keen options are included for legacy games. New games should use Swrve. Option to set a Keen write key. To be used with {

Option to specify the Kongregate Analytics ID

Option to specify the Kongregate Analytics API key

Option to control automatic onPause/onResume calls for API >= 14 type: Boolean, default Boolean.TRUE

Adjust configuration option.

Option to override default panel orientation mode ("sensor").

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

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

The steam or kartridge adapter

If Steam is supported, set an ISteamAdapter object to enable linking Steam users to Kongregate

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.

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 {

Option to specify the SWRVE API Key

Option to specify the SWRVE APP ID

Set this flag to force the GDPR dialog to always show every time it's checked. This option should nlybe used while testing your integration to verify the alert does not adversely affect your game. To control when the GDPR alert can appear, use {

Swrve configuration option.

Swrve configuration option.

Swrve iOS only option: autoCollectDeviceToken

Swrve configuration option.

Swrve configuration option.

Swrve configuration option.

Swrve configuration option.

Swrve configuration option.

Swrve configuration option.

Swrve configuration option.

Swrve configuration option.

Prefix to prepend to Swrve options.

Swrve iOS only option: pushEnabled

Swrve iOS only option: pushNotificationEvents

Swrve configuration option.

Swrve configuration option.

Option for locking the Kongregate panel to landscape orientation. Default is to autorotate to all orientations.

Option for locking the Kongregate panel to landscape/sensor orientation. Default is to autorotate to all orientations.

Option for locking the Kongregate panel to portrait orientation. Default is to autorotate to all orientations.

Option for locking the Kongregate panel to portrait/sensor orientation. Default is to autorotate to all orientations.

Purchase response: purchase failed

Purchase response: receipt verification failed

Purchase response: purchase success

The transaction is invalid

The transaction is still in the verification process

The transaction id status requested is unknown, it has possibly not been requested yet

The transaction is valid

Broadcast when a Swrve button event is fired.