| Package | com.kongregate.air |
| Class | public class Settings |
| Inheritance | Settings  Object |
KongregateAPI.settings
| Property | Defined By | ||
|---|---|---|---|
| adjustAppToken : String Adjust app token | Settings | ||
| adjustEnvironment : String Adjust environment | Settings | ||
| adjustEventTokenMap : Object = null Adjust event token map | Settings | ||
| allowImmersiveMode : Boolean = false Toggle immersive mode | Settings | ||
| apiDomain : String = m.kongregate.com Domain name for API endpoint | Settings | ||
| appleId : String Apple ID | Settings | ||
| appVersion : String Application version | Settings | ||
| autoAnalyticsFilter : String Set auto analytics filter (default to none) | Settings | ||
| autoAnalyticsMode : String = ENABLE_ALL Set auto analytics mode (default to ALL) | Settings | ||
| bundleID : String Application bundle ID | Settings | ||
| customPlayerId : String If Steam is supported, set an adapter object to enable linking Steam users
to Kongregate | Settings | ||
| debug : Boolean = true Toggle debug mode | Settings | ||
| deferAnalytics : Boolean = false Toggle deferred analytics | Settings | ||
| deferGDPRAlert : Boolean = false | Settings | ||
| deltaCollectUrl : String Delta Collect URL | Settings | ||
| deltaEngageUrl : String Delta Engage URL | Settings | ||
| deltaEnvironmentKey : String Delta Environment Key | Settings | ||
| enabled : Boolean = true SDK enabled flag | Settings | ||
| externalApi : Object = null
Set the platform and client_version fields of this object to enable the
external web API. | Settings | ||
| guildChat : Boolean = false Toggle guild chat support | Settings | ||
| instance : Settings [static] [read-only]
Singleton accessor. | Settings | ||
| keenProjectId : String Keen project ID | Settings | ||
| keenWriteKey : String Keen write key | Settings | ||
| kongAnalyticsId : String Kongregate Analytics Id | Settings | ||
| kongAnalyticsKey : String Kongregate Analytics API key | Settings | ||
| manageLifecycle : Boolean = true Toggle lifecycle management | Settings | ||
| manageSharedCache : Boolean = true Toggle shared cache management | Settings | ||
| panelOrientationOverride : String Override orientation. | Settings | ||
| panelTransitionOverride : String Override panel transition. | Settings | ||
| persistentWebView : Boolean = true Toggle persistent web view (recommended to leave enabled) | Settings | ||
| showSystemUi : Boolean = false Toggle system UI | Settings | ||
| standaloneAdapter : IStandaloneAdapter = null | Settings | ||
| steamAdapter : ISteamAdapter = null | Settings | ||
| supportedPanelEvents : String Specify the list of panel events your game supports | Settings | ||
| swrveApiKey : String Swrve API Key | Settings | ||
| swrveAppId : int = 0 Swrve App ID | Settings | ||
| swrveConfig : Object = null Swrve configuration options | Settings | ||
| testGDPRAlert : Boolean = false | Settings | ||
| values : Object [read-only]
Returns an AS3 object that can be passed into the SDK with the expected keys. | Settings | ||
| Method | Defined By | ||
|---|---|---|---|
Settings()
Used internally. | Settings | ||
| adjustAppToken | property |
public var adjustAppToken:StringAdjust app token
| adjustEnvironment | property |
public var adjustEnvironment:StringAdjust environment
| adjustEventTokenMap | property |
public var adjustEventTokenMap:Object = nullAdjust event token map
| allowImmersiveMode | property |
public var allowImmersiveMode:Boolean = falseToggle immersive mode
| apiDomain | property |
public var apiDomain:String = m.kongregate.comDomain name for API endpoint
| appleId | property |
public var appleId:StringApple ID
| appVersion | property |
public var appVersion:StringApplication version
| autoAnalyticsFilter | property |
public var autoAnalyticsFilter:StringSet auto analytics filter (default to none)
| autoAnalyticsMode | property |
public var autoAnalyticsMode:String = ENABLE_ALLSet auto analytics mode (default to ALL)
| bundleID | property |
public var bundleID:StringApplication bundle ID
| customPlayerId | property |
public var customPlayerId:StringIf Steam is supported, set an adapter object to enable linking Steam users to Kongregate
| debug | property |
public var debug:Boolean = trueToggle debug mode
| deferAnalytics | property |
public var deferAnalytics:Boolean = falseToggle deferred analytics
| deferGDPRAlert | property |
public var deferGDPRAlert:Boolean = false| deltaCollectUrl | property |
public var deltaCollectUrl:StringDelta Collect URL
| deltaEngageUrl | property |
public var deltaEngageUrl:StringDelta Engage URL
| deltaEnvironmentKey | property |
public var deltaEnvironmentKey:StringDelta Environment Key
| enabled | property |
public var enabled:Boolean = trueSDK enabled flag
| externalApi | property |
public var externalApi:Object = nullSet 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"
};
| guildChat | property |
public var guildChat:Boolean = falseToggle guild chat support
| instance | property |
instance:Settings [read-only] Singleton accessor. Use KongregateAPI.settings
public static function get instance():SettingsSee also
| keenProjectId | property |
public var keenProjectId:StringKeen project ID
| keenWriteKey | property |
public var keenWriteKey:StringKeen write key
| kongAnalyticsId | property |
public var kongAnalyticsId:StringKongregate Analytics Id
| kongAnalyticsKey | property |
public var kongAnalyticsKey:StringKongregate Analytics API key
| manageLifecycle | property |
public var manageLifecycle:Boolean = trueToggle lifecycle management
| manageSharedCache | property |
public var manageSharedCache:Boolean = trueToggle shared cache management
| panelOrientationOverride | property |
public var panelOrientationOverride:StringOverride orientation. Default is to autorotate to device orientation
| panelTransitionOverride | property |
public var panelTransitionOverride:StringOverride panel transition. Default uses standard OS transition
| persistentWebView | property |
public var persistentWebView:Boolean = trueToggle persistent web view (recommended to leave enabled)
| showSystemUi | property |
public var showSystemUi:Boolean = falseToggle system UI
| standaloneAdapter | property |
public var standaloneAdapter:IStandaloneAdapter = null| steamAdapter | property |
public var steamAdapter:ISteamAdapter = null| supportedPanelEvents | property |
public var supportedPanelEvents:StringSpecify the list of panel events your game supports
| swrveApiKey | property |
public var swrveApiKey:StringSwrve API Key
| swrveAppId | property |
public var swrveAppId:int = 0Swrve App ID
| swrveConfig | property |
public var swrveConfig:Object = nullSwrve configuration options
| testGDPRAlert | property |
public var testGDPRAlert:Boolean = false| values | property |
values:Object [read-only] Returns an AS3 object that can be passed into the SDK with the expected keys.
public function get values():Object| Settings | () | Constructor |
public function Settings()Used internally. Will throw an error if invoked outside the class.