Package | com.kongregate.air |
Class | public class KongregateAPI |
Inheritance | KongregateAPI flash.events.EventDispatcher |
Property | Defined By | ||
---|---|---|---|
analytics : IAnalytics [read-only]
Reference to the analytics interface. | KongregateAPI | ||
debug : IDebug [read-only]
Reference to the debug interface. | KongregateAPI | ||
mobile : IMobile [read-only]
Reference to the mobile interface. | KongregateAPI | ||
mtx : IMtx [read-only]
Reference to the mtx interface. | KongregateAPI | ||
platform : int
The PlatformType of the current device. | KongregateAPI | ||
services : IServices [read-only]
Reference to the services interface. | KongregateAPI | ||
settings : Settings [static] [read-only]
Settings for congfiguring the SDK. | KongregateAPI | ||
stats : IStats [read-only]
Reference to the stats interface. | KongregateAPI | ||
webAPI : * [read-only]
Returns a reference to the web Kongregate API object, if on the
web platform. | KongregateAPI |
Method | Defined By | ||
---|---|---|---|
KongregateAPI(enforcer:SingletonEnforcer, stage:Stage, gameId:int, apiKey:String, apiSettings:Object) | KongregateAPI | ||
initialize(stage:Stage, gameId:int, apiKey:String, apiSettings:Object = null):KongregateAPI [static]
Initializes the API
| KongregateAPI |
Constant | Defined By | ||
---|---|---|---|
ADJUST_INSTALL : String = install [static] Adjust event: install | KongregateAPI | ||
ADJUST_SALE : String = sale [static] Adjust event: sale | KongregateAPI | ||
ADJUST_SESSION : String = session [static] Adjust event: session | KongregateAPI | ||
ANALYTICS_AUTO_EVENT : String = KONGREGATE_ANALYTICS_AUTO_EVENT [static]
Broadcast when a Kongregate automatic analytics event is fired. | KongregateAPI | ||
API_EVENT : String = KONGREGATE_API_EVENT [static]
Dispatched when a Kongregate API event is fired. | KongregateAPI | ||
AUTO_ANALYTICS_MODE_CLOUD : String = CLOUD [static]
This is a special setting for games with server logic. | KongregateAPI | ||
AUTO_ANALYTICS_MODE_DISABLE_ALL : String = DISABLE_ALL [static]
This setting will disable all automatic event and properties tracking
| KongregateAPI | ||
AUTO_ANALYTICS_MODE_ENABLE_ALL : String = ENABLE_ALL [static]
This setting is the default. | KongregateAPI | ||
DELTA_BUTTON_EVENT : String = KONGREGATE_DELTA_BUTTON_EVENT [static]
Broadcast when a Delta button event is fired. | KongregateAPI | ||
DELTA_PARAMETER_EVENT : String = KONGREGATE_DELTA_PARAMETER_EVENT [static]
Broadcast when a Delta parameter event is fired. | KongregateAPI | ||
KONGREGATE_ADJUST_PREFIX : String = adjust. [static] Prefix to prepend to adjust options. | KongregateAPI | ||
KONGREGATE_EVENT_CHARACTER_TOKEN_REQUEST : String = KONG_API_EVENT_CHARACTER_TOKEN_REQUEST [static]
Broadcast when the API needs a new character token for guild chat authentication. | KongregateAPI | ||
KONGREGATE_EVENT_CLOSED : String = KONG_API_EVENT_CLOSED_KONGREGATE [static]
Broadcast when the Kongregate panel has closed
| KongregateAPI | ||
KONGREGATE_EVENT_GAME_AUTH_CHANGED : String = KONG_API_EVENT_GAME_AUTH_TOKEN_CHANGED [static]
Broadcast when the user's game authentication token has changed. | KongregateAPI | ||
KONGREGATE_EVENT_LOGIN_COMPLETE : String = KONG_API_EVENT_LOGIN_COMPLETE [static]
Broadcasts when the user has completed logging in on the panel. | KongregateAPI | ||
KONGREGATE_EVENT_NOTIFICATION_COUNT_UPDATED : String = KONG_API_EVENT_NOTIFICATION_COUNT_UPDATED [static]
Broadcast when the notification count for the current user changes
| KongregateAPI | ||
KONGREGATE_EVENT_OPEN_DEEP_LINK : String = KONG_API_EVENT_OPEN_DEEP_LINK [static]
Broadcast when the app is opened or brought to the foreground via deep link
| KongregateAPI | ||
KONGREGATE_EVENT_OPENING : String = KONG_API_EVENT_OPENING_KONGREGATE [static]
Broadcast when the Kongregate panel is about to be opened. | KongregateAPI | ||
KONGREGATE_EVENT_PARAM_AMOUNT : String = amount [static] Event parameter: amount | KongregateAPI | ||
KONGREGATE_EVENT_PARAM_CURRENCY : String = currency [static] Event parameter: currency | KongregateAPI | ||
KONGREGATE_EVENT_PARAM_INSTALL_URL : String = installUrl [static] Event parameter: installUrl | KongregateAPI | ||
KONGREGATE_EVENT_PARAM_ITEM : String = item [static] Event parameter: item | KongregateAPI | ||
KONGREGATE_EVENT_PARAM_PROMO_ID : String = promoId [static] Event parameter: promoId | KongregateAPI | ||
KONGREGATE_EVENT_PROMO_AWARD : String = KONG_API_EVENT_PROMO_AWARD [static] Event for cross promo awards. | KongregateAPI | ||
KONGREGATE_EVENT_READY : String = KONG_API_EVENT_READY [static]
Broadcast when the API is initialized and ready to use
| KongregateAPI | ||
KONGREGATE_EVENT_RECEIPT_VERIFICATION_COMPLETE : String = KONG_API_EVENT_RECEIPT_VERIFICATION_COMPLETED [static]
Broadcast when a receipt verification has completed. | KongregateAPI | ||
KONGREGATE_EVENT_SERVICE_UNAVAILABLE : String = KONG_API_EVENT_SERVICE_UNAVAILABLE [static]
Broadcast when Kongregate is unavailable. | KongregateAPI | ||
KONGREGATE_EVENT_SWRVE_RESOURCES_UPDATES : String = KONG_API_EVENT_SWRVE_RESOURCES_UPDATED [static]
Broadcast when the Swrve resources have been updated
| KongregateAPI | ||
KONGREGATE_EVENT_USER_CHANGED : String = KONG_API_EVENT_USER_CHANGED [static]
Broadcast when the user has changed. | KongregateAPI | ||
KONGREGATE_EVENT_USER_INVENTORY : String = KONG_API_EVENT_USER_INVENTORY [static]
Broadcast when the user's inventory is received
| KongregateAPI | ||
KONGREGATE_OPTION_ADJUST_APP_TOKEN : String = adjust.app_token [static] Adjust configuration option. | KongregateAPI | ||
KONGREGATE_OPTION_ADJUST_ENVIRONMENT : String = adjust.environment [static] Adjust configuration option. | KongregateAPI | ||
KONGREGATE_OPTION_ALLOW_IMMERSIVE_MODE : String = allow_immersive_mode [static]
Option to disable immersive mode on Android 4.4+ devices. | KongregateAPI | ||
KONGREGATE_OPTION_ANALYTICS_MODE : String = auto_analytics_mode [static]
Option indicating the game logic and players exist on a game server
| KongregateAPI | ||
KONGREGATE_OPTION_APP_VERSION : String = app_version [static] Application version | KongregateAPI | ||
KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER : String = auto_analytics_filter [static]
Option to filter properties or events. | KongregateAPI | ||
KONGREGATE_OPTION_BUNDLE_ID : String = bundle_id [static] Application bundle ID | KongregateAPI | ||
KONGREGATE_OPTION_CRASHLYTICS_LOGGING : String = crashlytics_logging [static]
Option to have the Kongregate SDK log to Crashlytics logging API. | KongregateAPI | ||
KONGREGATE_OPTION_CRASHLYTICS_USER_KEYS : String = crashlytics_user_keys [static]
Option to have the Kongregate SDK use the Crashlytics user keys API. | KongregateAPI | ||
KONGREGATE_OPTION_CUSTOM_PLAYER_ID : String = custom_player_id [static]
Specifies the Player ID to be sent with every event. | KongregateAPI | ||
KONGREGATE_OPTION_DEBUG : String = debug [static]
Option to control debugging/verbose logging
type: Boolean, default: Boolean.FALSE
| KongregateAPI | ||
KONGREGATE_OPTION_DEBUG_WEBVIEW : String = debug_webview [static]
Option to control KitKat WebView debugging
type: Boolean, default Boolean.FALSE
| KongregateAPI | ||
KONGREGATE_OPTION_DEFAULT_PANEL_TRANSITION : String = default_panel_transition [static]
Specify default panel transition to use when the panel is open. | KongregateAPI | ||
KONGREGATE_OPTION_DEFER_ANALYTICS : String = defer_analytics [static]
Option to defer initialization of the Analytics class. | KongregateAPI | ||
KONGREGATE_OPTION_DEFER_GDPR_ALERT : String = defer_gdpr_check [static]
Option to defer the GDPR alert dialog until { | KongregateAPI | ||
KONGREGATE_OPTION_DELTA_COLLECT_URL : String = delta_collect_url [static]
Option to specify the DELTA DNA COLLECT URL
| KongregateAPI | ||
KONGREGATE_OPTION_DELTA_ENGAGE_URL : String = delta_engage_url [static]
Option to specify the DELTA DNA ENGAGE URL
| KongregateAPI | ||
KONGREGATE_OPTION_DELTA_ENVIRONMENT_KEY : String = delta_env_key [static]
Option to specify the DELTA DNA ENVIRONMENT KEY
| KongregateAPI | ||
KONGREGATE_OPTION_DOMAIN : String = domain [static]
Option to change the back-end domain,
Type: String, default: "m.kongregate.com"
| KongregateAPI | ||
KONGREGATE_OPTION_ENABLED : String = enabled [static] Option to disable the Kongregate plugin | KongregateAPI | ||
KONGREGATE_OPTION_EXTERNAL_API : String = external_api [static]
Set the platform and client_version fields of this object to enable the
external web API. | KongregateAPI | ||
KONGREGATE_OPTION_GUILD_CHAT : String = guild_chat [static]
Enables guild chat functionality if also enabled on the server. | KongregateAPI | ||
KONGREGATE_OPTION_KEEN_PROJECT_ID : String = keen_product_id [static]
Keen options are included for legacy games. | KongregateAPI | ||
KONGREGATE_OPTION_KEEN_WRITE_KEY : String = keen_write_key [static]
Keen options are included for legacy games. | KongregateAPI | ||
KONGREGATE_OPTION_KONG_ANALYTICS_ID : String = kong_analytics_id [static]
Option to specify the Kongregate Analytics ID
| KongregateAPI | ||
KONGREGATE_OPTION_KONG_ANALYTICS_KEY : String = kong_analytics_key [static]
Option to specify the Kongregate Analytics API key
| KongregateAPI | ||
KONGREGATE_OPTION_MANAGE_LIFECYCLE : String = manage_lifecycle [static]
Option to control automatic onPause/onResume calls for API >= 14
type: Boolean, default Boolean.TRUE
| KongregateAPI | ||
KONGREGATE_OPTION_MANAGE_SHARED_CACHE : String = manage_shared_cache [static] Adjust configuration option. | KongregateAPI | ||
KONGREGATE_OPTION_PANEL_ORIENTATION_OVERRIDE : String = panel_orientation_override [static]
Option to override default panel orientation mode ("sensor"). | KongregateAPI | ||
KONGREGATE_OPTION_PERSISTENT_WEBVIEW : String = persistent_webview [static]
Enables a persistent WebView rather than creating new WebView instances. | KongregateAPI | ||
KONGREGATE_OPTION_SHOW_SYSTEM_UI : String = show_system_ui [static]
Option to show the system UI when the kongregate panel is up. | KongregateAPI | ||
KONGREGATE_OPTION_STANDALONE_ADAPTER : String = standalone_adapter [static] The steam or kartridge adapter | KongregateAPI | ||
KONGREGATE_OPTION_STEAM_ADAPTER : String = steam_adapter [static] If Steam is supported, set an ISteamAdapter object to enable linking Steam users
to Kongregate | KongregateAPI | ||
KONGREGATE_OPTION_STRICT_LIFECYCLE_MODE : String = strict_lifecycle [static]
Option to enable strict lifecyle tracking. | KongregateAPI | ||
KONGREGATE_OPTION_SUPPORTED_PANEL_EVENTS : String = supported_panel_events [static]
Provide a list of panel events your game supports. | KongregateAPI | ||
KONGREGATE_OPTION_SWRVE_API_KEY : String = swrve_api_key [static]
Option to specify the SWRVE API Key
| KongregateAPI | ||
KONGREGATE_OPTION_SWRVE_APP_ID : String = swrve_app_id [static]
Option to specify the SWRVE APP ID
| KongregateAPI | ||
KONGREGATE_OPTION_TEST_GDPR_ALERT : String = test.gdpr_alert [static]
Set this flag to force the GDPR dialog to always show every time it's checked. | KongregateAPI | ||
KONGREGATE_SWRVE_APP_STORE : String = swrve.appStore [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_APP_VERSION : String = swrve.appVersion [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_AUTO_COLLECT_DEVICE_TOKEN : String = swrve.autoCollectDeviceToken [static] Swrve iOS only option: autoCollectDeviceToken | KongregateAPI | ||
KONGREGATE_SWRVE_AUTO_DOWNLOAD : String = swrve.autoDownload [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_CACHE_DIR : String = swrve.cacheDir [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_DB_NAME : String = swrve.dbName [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_LANGUAGE : String = swrve.language [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_LINK_TOKEN : String = swrve.linkToken [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_MAX_CONCURRENT_DOWNLOADS : String = swrve.maxConcurrentDownloads [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_MAX_DB_SIZE : String = swrve.maxDbSize [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_MAX_EVENTS_PER_FLUSH : String = swrve.maxEventsPerFlush [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_PREFIX : String = swrve. [static] Prefix to prepend to Swrve options. | KongregateAPI | ||
KONGREGATE_SWRVE_PUSH_ENABLED : String = swrve.pushEnabled [static] Swrve iOS only option: pushEnabled | KongregateAPI | ||
KONGREGATE_SWRVE_PUSH_NOTIFICATION_EVENTS : String = swrve.pushNotificationEvents [static] Swrve iOS only option: pushNotificationEvents | KongregateAPI | ||
KONGREGATE_SWRVE_SENDER_ID : String = swrve.senderId [static] Swrve configuration option. | KongregateAPI | ||
KONGREGATE_SWRVE_TALK_ENABLED : String = swrve.talkEnabled [static] Swrve configuration option. | KongregateAPI | ||
ORIENTATION_LANDSCAPE : String = landscape [static]
Option for locking the Kongregate panel to landscape orientation. | KongregateAPI | ||
ORIENTATION_LANDSCAPE_SENSOR : String = landscapeSensor [static]
Option for locking the Kongregate panel to landscape/sensor orientation. | KongregateAPI | ||
ORIENTATION_PORTRAIT : String = portrait [static]
Option for locking the Kongregate panel to portrait orientation. | KongregateAPI | ||
ORIENTATION_PORTRAIT_SENSOR : String = portraitSensor [static]
Option for locking the Kongregate panel to portrait/sensor orientation. | KongregateAPI | ||
PURCHASE_FAIL : String = FAIL [static] Purchase response: purchase failed | KongregateAPI | ||
PURCHASE_RECEIPT_FAIL : String = RECEIPT_FAIL [static] Purchase response: receipt verification failed | KongregateAPI | ||
PURCHASE_SUCCESS : String = SUCCESS [static] Purchase response: purchase success | KongregateAPI | ||
RECEIPT_VERIFICATION_STATUS_INVALID : String = INVALID [static]
The transaction is invalid
| KongregateAPI | ||
RECEIPT_VERIFICATION_STATUS_PROCESSING : String = PROCESSING [static]
The transaction is still in the verification process
| KongregateAPI | ||
RECEIPT_VERIFICATION_STATUS_UNKNOWN : String = UNKNOWN [static]
The transaction id status requested is unknown, it has possibly not been requested yet
| KongregateAPI | ||
RECEIPT_VERIFICATION_STATUS_VALID : String = VALID [static]
The transaction is valid
| KongregateAPI | ||
SWRVE_BUTTON_EVENT : String = KONGREGATE_SWRVE_BUTTON_EVENT [static]
Broadcast when a Swrve button event is fired. | KongregateAPI |
analytics | property |
analytics:IAnalytics
[read-only] Reference to the analytics interface.
public function get analytics():IAnalytics
See also
debug | property |
debug:IDebug
[read-only] Reference to the debug interface.
public function get debug():IDebug
See also
mobile | property |
mobile:IMobile
[read-only] Reference to the mobile interface.
public function get mobile():IMobile
See also
mtx | property |
mtx:IMtx
[read-only] Reference to the mtx interface.
public function get mtx():IMtx
See also
platform | property |
services | property |
services:IServices
[read-only] Reference to the services interface.
public function get services():IServices
See also
settings | property |
settings:Settings
[read-only] Settings for congfiguring the SDK. Use settings.values to instantiate the SDK.
public static function get settings():Settings
See also
stats | property |
stats:IStats
[read-only] Reference to the stats interface.
public function get stats():IStats
See also
webAPI | property |
webAPI:*
[read-only] Returns a reference to the web Kongregate API object, if on the web platform.
public function get webAPI():*
KongregateAPI | () | Constructor |
public function KongregateAPI(enforcer:SingletonEnforcer, stage:Stage, gameId:int, apiKey:String, apiSettings:Object)
enforcer:SingletonEnforcer | |
stage:Stage | |
gameId:int | |
apiKey:String | |
apiSettings:Object |
initialize | () | method |
public static function initialize(stage:Stage, gameId:int, apiKey:String, apiSettings:Object = null):KongregateAPI
Initializes the API
Parameters
stage:Stage — A reference to the stage
| |
gameId:int — Your game id
| |
apiKey:String — Your mobile API key
| |
apiSettings:Object (default = null ) — An object containing API settings where the keys are the KONGREGATE_OPTION_constants.
|
KongregateAPI |
KongregateAPI.settings.swrveAppId = KongregateConstants.swrveAppId; KongregateAPI.settings.swrveApiKey = KongregateConstants.swrveApiKey; mKongregate = KongregateAPI.initialize( root.stage, KongregateConstants.gameId, KongregateConstants.apiKey );
ADJUST_INSTALL | Constant |
public static const ADJUST_INSTALL:String = install
Adjust event: install
ADJUST_SALE | Constant |
public static const ADJUST_SALE:String = sale
Adjust event: sale
ADJUST_SESSION | Constant |
public static const ADJUST_SESSION:String = session
Adjust event: session
ANALYTICS_AUTO_EVENT | Constant |
public static const ANALYTICS_AUTO_EVENT:String = KONGREGATE_ANALYTICS_AUTO_EVENT
Broadcast when a Kongregate automatic analytics event is fired.
API_EVENT | Constant |
public static const API_EVENT:String = KONGREGATE_API_EVENT
Dispatched when a Kongregate API event is fired.
AUTO_ANALYTICS_MODE_CLOUD | Constant |
public static const AUTO_ANALYTICS_MODE_CLOUD:String = CLOUD
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.
AUTO_ANALYTICS_MODE_DISABLE_ALL | Constant |
public static const AUTO_ANALYTICS_MODE_DISABLE_ALL:String = DISABLE_ALL
This setting will disable all automatic event and properties tracking
AUTO_ANALYTICS_MODE_ENABLE_ALL | Constant |
public static const AUTO_ANALYTICS_MODE_ENABLE_ALL:String = ENABLE_ALL
This setting is the default. The SDK will track the full suite of automatic events and fields.
DELTA_BUTTON_EVENT | Constant |
public static const DELTA_BUTTON_EVENT:String = KONGREGATE_DELTA_BUTTON_EVENT
Broadcast when a Delta button event is fired.
DELTA_PARAMETER_EVENT | Constant |
public static const DELTA_PARAMETER_EVENT:String = KONGREGATE_DELTA_PARAMETER_EVENT
Broadcast when a Delta parameter event is fired.
KONGREGATE_ADJUST_PREFIX | Constant |
public static const KONGREGATE_ADJUST_PREFIX:String = adjust.
Prefix to prepend to adjust options.
KONGREGATE_EVENT_CHARACTER_TOKEN_REQUEST | Constant |
public static const KONGREGATE_EVENT_CHARACTER_TOKEN_REQUEST:String = KONG_API_EVENT_CHARACTER_TOKEN_REQUEST
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.
KONGREGATE_EVENT_CLOSED | Constant |
public static const KONGREGATE_EVENT_CLOSED:String = KONG_API_EVENT_CLOSED_KONGREGATE
Broadcast when the Kongregate panel has closed
KONGREGATE_EVENT_GAME_AUTH_CHANGED | Constant |
public static const KONGREGATE_EVENT_GAME_AUTH_CHANGED:String = KONG_API_EVENT_GAME_AUTH_TOKEN_CHANGED
Broadcast when the user's game authentication token has changed.
KONGREGATE_EVENT_LOGIN_COMPLETE | Constant |
public static const KONGREGATE_EVENT_LOGIN_COMPLETE:String = KONG_API_EVENT_LOGIN_COMPLETE
Broadcasts when the user has completed logging in on the panel.
KONGREGATE_EVENT_NOTIFICATION_COUNT_UPDATED | Constant |
public static const KONGREGATE_EVENT_NOTIFICATION_COUNT_UPDATED:String = KONG_API_EVENT_NOTIFICATION_COUNT_UPDATED
Broadcast when the notification count for the current user changes
KONGREGATE_EVENT_OPEN_DEEP_LINK | Constant |
public static const KONGREGATE_EVENT_OPEN_DEEP_LINK:String = KONG_API_EVENT_OPEN_DEEP_LINK
Broadcast when the app is opened or brought to the foreground via deep link
KONGREGATE_EVENT_OPENING | Constant |
public static const KONGREGATE_EVENT_OPENING:String = KONG_API_EVENT_OPENING_KONGREGATE
Broadcast when the Kongregate panel is about to be opened.
KONGREGATE_EVENT_PARAM_AMOUNT | Constant |
public static const KONGREGATE_EVENT_PARAM_AMOUNT:String = amount
Event parameter: amount
KONGREGATE_EVENT_PARAM_CURRENCY | Constant |
public static const KONGREGATE_EVENT_PARAM_CURRENCY:String = currency
Event parameter: currency
KONGREGATE_EVENT_PARAM_INSTALL_URL | Constant |
public static const KONGREGATE_EVENT_PARAM_INSTALL_URL:String = installUrl
Event parameter: installUrl
KONGREGATE_EVENT_PARAM_ITEM | Constant |
public static const KONGREGATE_EVENT_PARAM_ITEM:String = item
Event parameter: item
KONGREGATE_EVENT_PARAM_PROMO_ID | Constant |
public static const KONGREGATE_EVENT_PARAM_PROMO_ID:String = promoId
Event parameter: promoId
KONGREGATE_EVENT_PROMO_AWARD | Constant |
public static const KONGREGATE_EVENT_PROMO_AWARD:String = KONG_API_EVENT_PROMO_AWARD
Event for cross promo awards.
KONGREGATE_EVENT_READY | Constant |
public static const KONGREGATE_EVENT_READY:String = KONG_API_EVENT_READY
Broadcast when the API is initialized and ready to use
KONGREGATE_EVENT_RECEIPT_VERIFICATION_COMPLETE | Constant |
public static const KONGREGATE_EVENT_RECEIPT_VERIFICATION_COMPLETE:String = KONG_API_EVENT_RECEIPT_VERIFICATION_COMPLETED
Broadcast when a receipt verification has completed.
KONGREGATE_EVENT_SERVICE_UNAVAILABLE | Constant |
public static const KONGREGATE_EVENT_SERVICE_UNAVAILABLE:String = KONG_API_EVENT_SERVICE_UNAVAILABLE
Broadcast when Kongregate is unavailable. This may be due to network connectivity or Kongregate may be down for maintence.
KONGREGATE_EVENT_SWRVE_RESOURCES_UPDATES | Constant |
public static const KONGREGATE_EVENT_SWRVE_RESOURCES_UPDATES:String = KONG_API_EVENT_SWRVE_RESOURCES_UPDATED
Broadcast when the Swrve resources have been updated
KONGREGATE_EVENT_USER_CHANGED | Constant |
public static const KONGREGATE_EVENT_USER_CHANGED:String = KONG_API_EVENT_USER_CHANGED
Broadcast when the user has changed.
KONGREGATE_EVENT_USER_INVENTORY | Constant |
public static const KONGREGATE_EVENT_USER_INVENTORY:String = KONG_API_EVENT_USER_INVENTORY
Broadcast when the user's inventory is received
KONGREGATE_OPTION_ADJUST_APP_TOKEN | Constant |
public static const KONGREGATE_OPTION_ADJUST_APP_TOKEN:String = adjust.app_token
Adjust configuration option.
KONGREGATE_OPTION_ADJUST_ENVIRONMENT | Constant |
public static const KONGREGATE_OPTION_ADJUST_ENVIRONMENT:String = adjust.environment
Adjust configuration option.
KONGREGATE_OPTION_ALLOW_IMMERSIVE_MODE | Constant |
public static const KONGREGATE_OPTION_ALLOW_IMMERSIVE_MODE:String = 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
KONGREGATE_OPTION_ANALYTICS_MODE | Constant |
public static const KONGREGATE_OPTION_ANALYTICS_MODE:String = auto_analytics_mode
Option indicating the game logic and players exist on a game server
KONGREGATE_OPTION_APP_VERSION | Constant |
public static const KONGREGATE_OPTION_APP_VERSION:String = app_version
Application version
KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER | Constant |
public static const KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER:String = auto_analytics_filter
Option to filter properties or events. A comma delimeted list of field and event names.
KONGREGATE_OPTION_BUNDLE_ID | Constant |
public static const KONGREGATE_OPTION_BUNDLE_ID:String = bundle_id
Application bundle ID
KONGREGATE_OPTION_CRASHLYTICS_LOGGING | Constant |
public static const KONGREGATE_OPTION_CRASHLYTICS_LOGGING:String = crashlytics_logging
Option to have the Kongregate SDK log to Crashlytics logging API. Crashlytics must be integrated to use this option. Default if false.
KONGREGATE_OPTION_CRASHLYTICS_USER_KEYS | Constant |
public static const KONGREGATE_OPTION_CRASHLYTICS_USER_KEYS:String = 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.
KONGREGATE_OPTION_CUSTOM_PLAYER_ID | Constant |
public static const KONGREGATE_OPTION_CUSTOM_PLAYER_ID:String = 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_DEBUG | Constant |
public static const KONGREGATE_OPTION_DEBUG:String = debug
Option to control debugging/verbose logging type: Boolean, default: Boolean.FALSE
KONGREGATE_OPTION_DEBUG_WEBVIEW | Constant |
public static const KONGREGATE_OPTION_DEBUG_WEBVIEW:String = debug_webview
Option to control KitKat WebView debugging type: Boolean, default Boolean.FALSE
KONGREGATE_OPTION_DEFAULT_PANEL_TRANSITION | Constant |
public static const KONGREGATE_OPTION_DEFAULT_PANEL_TRANSITION:String = 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 transitions may be found in Mobile (e.g. Mobile.PANEL_TRANSITION_SLIDE_FROM_LEFT)
KONGREGATE_OPTION_DEFER_ANALYTICS | Constant |
public static const KONGREGATE_OPTION_DEFER_ANALYTICS:String = 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 {
KONGREGATE_OPTION_DEFER_GDPR_ALERT | Constant |
public static const KONGREGATE_OPTION_DEFER_GDPR_ALERT:String = defer_gdpr_check
Option to defer the GDPR alert dialog until {
KONGREGATE_OPTION_DELTA_COLLECT_URL | Constant |
public static const KONGREGATE_OPTION_DELTA_COLLECT_URL:String = delta_collect_url
Option to specify the DELTA DNA COLLECT URL
KONGREGATE_OPTION_DELTA_ENGAGE_URL | Constant |
public static const KONGREGATE_OPTION_DELTA_ENGAGE_URL:String = delta_engage_url
Option to specify the DELTA DNA ENGAGE URL
KONGREGATE_OPTION_DELTA_ENVIRONMENT_KEY | Constant |
public static const KONGREGATE_OPTION_DELTA_ENVIRONMENT_KEY:String = delta_env_key
Option to specify the DELTA DNA ENVIRONMENT KEY
KONGREGATE_OPTION_DOMAIN | Constant |
public static const KONGREGATE_OPTION_DOMAIN:String = domain
Option to change the back-end domain, Type: String, default: "m.kongregate.com"
KONGREGATE_OPTION_ENABLED | Constant |
public static const KONGREGATE_OPTION_ENABLED:String = enabled
Option to disable the Kongregate plugin
KONGREGATE_OPTION_EXTERNAL_API | Constant |
public static const KONGREGATE_OPTION_EXTERNAL_API:String = external_api
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" };
KONGREGATE_OPTION_GUILD_CHAT | Constant |
public static const KONGREGATE_OPTION_GUILD_CHAT:String = 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
KONGREGATE_OPTION_KEEN_PROJECT_ID | Constant |
public static const KONGREGATE_OPTION_KEEN_PROJECT_ID:String = keen_product_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 | Constant |
public static const KONGREGATE_OPTION_KEEN_WRITE_KEY:String = 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_KONG_ANALYTICS_ID | Constant |
public static const KONGREGATE_OPTION_KONG_ANALYTICS_ID:String = kong_analytics_id
Option to specify the Kongregate Analytics ID
KONGREGATE_OPTION_KONG_ANALYTICS_KEY | Constant |
public static const KONGREGATE_OPTION_KONG_ANALYTICS_KEY:String = kong_analytics_key
Option to specify the Kongregate Analytics API key
KONGREGATE_OPTION_MANAGE_LIFECYCLE | Constant |
public static const KONGREGATE_OPTION_MANAGE_LIFECYCLE:String = manage_lifecycle
Option to control automatic onPause/onResume calls for API >= 14 type: Boolean, default Boolean.TRUE
KONGREGATE_OPTION_MANAGE_SHARED_CACHE | Constant |
public static const KONGREGATE_OPTION_MANAGE_SHARED_CACHE:String = manage_shared_cache
Adjust configuration option.
KONGREGATE_OPTION_PANEL_ORIENTATION_OVERRIDE | Constant |
public static const KONGREGATE_OPTION_PANEL_ORIENTATION_OVERRIDE:String = panel_orientation_override
Option to override default panel orientation mode ("sensor").
KONGREGATE_OPTION_PERSISTENT_WEBVIEW | Constant |
public static const KONGREGATE_OPTION_PERSISTENT_WEBVIEW:String = 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
KONGREGATE_OPTION_SHOW_SYSTEM_UI | Constant |
public static const KONGREGATE_OPTION_SHOW_SYSTEM_UI:String = 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
KONGREGATE_OPTION_STANDALONE_ADAPTER | Constant |
public static const KONGREGATE_OPTION_STANDALONE_ADAPTER:String = standalone_adapter
The steam or kartridge adapter
KONGREGATE_OPTION_STEAM_ADAPTER | Constant |
public static const KONGREGATE_OPTION_STEAM_ADAPTER:String = steam_adapter
If Steam is supported, set an ISteamAdapter object to enable linking Steam users to Kongregate
KONGREGATE_OPTION_STRICT_LIFECYCLE_MODE | Constant |
public static const KONGREGATE_OPTION_STRICT_LIFECYCLE_MODE:String = strict_lifecycle
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.
KONGREGATE_OPTION_SUPPORTED_PANEL_EVENTS | Constant |
public static const KONGREGATE_OPTION_SUPPORTED_PANEL_EVENTS:String = 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 {
KONGREGATE_OPTION_SWRVE_API_KEY | Constant |
public static const KONGREGATE_OPTION_SWRVE_API_KEY:String = swrve_api_key
Option to specify the SWRVE API Key
KONGREGATE_OPTION_SWRVE_APP_ID | Constant |
public static const KONGREGATE_OPTION_SWRVE_APP_ID:String = swrve_app_id
Option to specify the SWRVE APP ID
KONGREGATE_OPTION_TEST_GDPR_ALERT | Constant |
public static const KONGREGATE_OPTION_TEST_GDPR_ALERT:String = test.gdpr_alert
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 {
KONGREGATE_SWRVE_APP_STORE | Constant |
public static const KONGREGATE_SWRVE_APP_STORE:String = swrve.appStore
Swrve configuration option.
KONGREGATE_SWRVE_APP_VERSION | Constant |
public static const KONGREGATE_SWRVE_APP_VERSION:String = swrve.appVersion
Swrve configuration option.
KONGREGATE_SWRVE_AUTO_COLLECT_DEVICE_TOKEN | Constant |
public static const KONGREGATE_SWRVE_AUTO_COLLECT_DEVICE_TOKEN:String = swrve.autoCollectDeviceToken
Swrve iOS only option: autoCollectDeviceToken
KONGREGATE_SWRVE_AUTO_DOWNLOAD | Constant |
public static const KONGREGATE_SWRVE_AUTO_DOWNLOAD:String = swrve.autoDownload
Swrve configuration option.
KONGREGATE_SWRVE_CACHE_DIR | Constant |
public static const KONGREGATE_SWRVE_CACHE_DIR:String = swrve.cacheDir
Swrve configuration option.
KONGREGATE_SWRVE_DB_NAME | Constant |
public static const KONGREGATE_SWRVE_DB_NAME:String = swrve.dbName
Swrve configuration option.
KONGREGATE_SWRVE_LANGUAGE | Constant |
public static const KONGREGATE_SWRVE_LANGUAGE:String = swrve.language
Swrve configuration option.
KONGREGATE_SWRVE_LINK_TOKEN | Constant |
public static const KONGREGATE_SWRVE_LINK_TOKEN:String = swrve.linkToken
Swrve configuration option.
KONGREGATE_SWRVE_MAX_CONCURRENT_DOWNLOADS | Constant |
public static const KONGREGATE_SWRVE_MAX_CONCURRENT_DOWNLOADS:String = swrve.maxConcurrentDownloads
Swrve configuration option.
KONGREGATE_SWRVE_MAX_DB_SIZE | Constant |
public static const KONGREGATE_SWRVE_MAX_DB_SIZE:String = swrve.maxDbSize
Swrve configuration option.
KONGREGATE_SWRVE_MAX_EVENTS_PER_FLUSH | Constant |
public static const KONGREGATE_SWRVE_MAX_EVENTS_PER_FLUSH:String = swrve.maxEventsPerFlush
Swrve configuration option.
KONGREGATE_SWRVE_PREFIX | Constant |
public static const KONGREGATE_SWRVE_PREFIX:String = swrve.
Prefix to prepend to Swrve options.
KONGREGATE_SWRVE_PUSH_ENABLED | Constant |
public static const KONGREGATE_SWRVE_PUSH_ENABLED:String = swrve.pushEnabled
Swrve iOS only option: pushEnabled
KONGREGATE_SWRVE_PUSH_NOTIFICATION_EVENTS | Constant |
public static const KONGREGATE_SWRVE_PUSH_NOTIFICATION_EVENTS:String = swrve.pushNotificationEvents
Swrve iOS only option: pushNotificationEvents
KONGREGATE_SWRVE_SENDER_ID | Constant |
public static const KONGREGATE_SWRVE_SENDER_ID:String = swrve.senderId
Swrve configuration option.
KONGREGATE_SWRVE_TALK_ENABLED | Constant |
public static const KONGREGATE_SWRVE_TALK_ENABLED:String = swrve.talkEnabled
Swrve configuration option.
ORIENTATION_LANDSCAPE | Constant |
public static const ORIENTATION_LANDSCAPE:String = landscape
Option for locking the Kongregate panel to landscape orientation. Default is to autorotate to all orientations.
ORIENTATION_LANDSCAPE_SENSOR | Constant |
public static const ORIENTATION_LANDSCAPE_SENSOR:String = landscapeSensor
Option for locking the Kongregate panel to landscape/sensor orientation. Default is to autorotate to all orientations.
ORIENTATION_PORTRAIT | Constant |
public static const ORIENTATION_PORTRAIT:String = portrait
Option for locking the Kongregate panel to portrait orientation. Default is to autorotate to all orientations.
ORIENTATION_PORTRAIT_SENSOR | Constant |
public static const ORIENTATION_PORTRAIT_SENSOR:String = portraitSensor
Option for locking the Kongregate panel to portrait/sensor orientation. Default is to autorotate to all orientations.
PURCHASE_FAIL | Constant |
public static const PURCHASE_FAIL:String = FAIL
Purchase response: purchase failed
PURCHASE_RECEIPT_FAIL | Constant |
public static const PURCHASE_RECEIPT_FAIL:String = RECEIPT_FAIL
Purchase response: receipt verification failed
PURCHASE_SUCCESS | Constant |
public static const PURCHASE_SUCCESS:String = SUCCESS
Purchase response: purchase success
RECEIPT_VERIFICATION_STATUS_INVALID | Constant |
public static const RECEIPT_VERIFICATION_STATUS_INVALID:String = INVALID
The transaction is invalid
RECEIPT_VERIFICATION_STATUS_PROCESSING | Constant |
public static const RECEIPT_VERIFICATION_STATUS_PROCESSING:String = PROCESSING
The transaction is still in the verification process
RECEIPT_VERIFICATION_STATUS_UNKNOWN | Constant |
public static const RECEIPT_VERIFICATION_STATUS_UNKNOWN:String = UNKNOWN
The transaction id status requested is unknown, it has possibly not been requested yet
RECEIPT_VERIFICATION_STATUS_VALID | Constant |
public static const RECEIPT_VERIFICATION_STATUS_VALID:String = VALID
The transaction is valid
SWRVE_BUTTON_EVENT | Constant |
public static const SWRVE_BUTTON_EVENT:String = KONGREGATE_SWRVE_BUTTON_EVENT
Broadcast when a Swrve button event is fired.