LiConfig Reference

Package: com.applicasa.ApplicasaManager
Declared In: com.applicasa.ApplicasaManager.LiConfig

Overview

Configurable preprocessor definitions required to get your app connected to Applicasa's remote backend and enable/disable specific features, all of which are found in LiConfig.

Tasks

Checking Application Settings

+ getApplicationId
+ getApplicationKey
+ getFbApplicationKey
+ getGoogleGCM
+ getGooglePlayPublicKey

Checking Behavior Settings

+ isPushEnabled
+ isApplicasaDebugEnabled
+ isLocationEnabled
+ isParallelActionEnabled
+ isOfflineEnabled
+ isApplicasaSandboxEnabled
+ isFacebookEnabled
+ isFbDebugEnabled
+ isIAPSandboxEnabled
+ isIAPEnabled

Checking SDK Settings

+ getSchemaDate
+ getSDKVersion
+ getFrameworkVersion
+ getSeries

Application Keys

Application-specific keys that are used to identify and connect your app with Applicasa's remote backend via the SDK & frameworks.

`APPLICATION_KEY`

The secret key provided by Applicasa for your application, provided by the Applicasa service when you download the SDK.

`APPLICATION_ID`

Your Applicasa application ID, provided by the Applicasa service when you download the SDK.

`FB_APPLICATION_KEY`

The secret key provided by Facebook for your application, available from the Facebook Developer site. You must set this value to succesfully connect with Facebook.

`GOOGLE_PLAY_PUBLIC_KEY`

Your application's public key for Google Play. You must enter this value to successfully connect with Google Play.

`GOOGLE_GCM`

Your application's Google Cloud Messaging (GCM) Sender ID value (e.g., projectId or email address). You must set this value to successfully connect with Google Cloud Messaging.

Behavior Keys

Application-specific keys that inform Applicasa of specific features that should be enabled and disabled for development and production purposes.

`ENABLE_PUSH`

Enables/disables Push functionality for your application. Default value is false. Set to true if your application requires Push notifications.

`ENABLE_APPLICASA_DEBUG`

For development purposes. Sets the Applicasa SDK to DEBUG mode, which provides helpful logging information while you build your app. Default value is false. Set to true if you wish to use Applicasa’s SDK and frameworks in DEBUG mode.

NOTE: You should ensure this value is set to false when you publish your final app.

`ENABLE_PARALLEL_ACTION`

Enables/disables running object-level Add, Update, and Delete requests in parallel. Defaults to true.

`ENABLE_FACEBOOK`

Enables/disables Applicasa’s Facebook integration. Defaults to false. Set to true if you wish to use Applicasa’s Facebook user functionality.

`ENABLE_FB_DEBUG`

Enables/disables Facebook-focused debug features. Defaults to false. Set to true if you wish to use Facebook debug features, logs, and warnings.

`ENABLE_LOCATION`

Enables/disables location-aware functionality in the Applicasa SDK & framework(s). Default value is false. Set to true if your application requires Location services.

`ENABLE_OFFLINE`

Enables/Disables offline data storage in the absence of a network connection. Defaults to true. Set to false if your application does not require offline data storage.

`ENABLE_APPLICASA_SANDBOX`

Enables/disables using the Applicasa sandbox or live environments for data and In-App Purchases. If true, Applicasa will effectively operate in development mode. You should set this value to false when publishing your application.

`ENABLE_IAP`

Enables/disables Applicasa’s In-App Purchase support. Defaults to true. Set to false if your app does not require virtual store functionality.

`ENABLE_IAP_SANDBOX`

Enables/disables whether In-App Purchase support is in sandbox-only mode, meaning purchases do not actually process for real currency. Defaults to false. Set to true when in development.

Applicasa SDK Keys

Application-specific keys that provide important information to the SDK and frameworks. Internal use only. Do not modify these values.

`SCHEMA_DATE`

Holds the latest-revision date of your application’s schema, and is used locally to determine when the SQLite database needs to be upgraded as your schema changes over time. Do not alter this value.

`SDK_VERSION`

Holds the current version number of the Applicasa SDK with which you are working. Do not alter this value.

`FRAMEWORK_VERSION`

Holds the current version number of the Applicasa framework(s) with which you are working. Do not alter this value.

`SERIES`

Holds the current SERIES number for the Applicasa SDK and framework(s). Do not alter this value.

Class Methods

`getSchemaDate`

Returns the value of SCHEMA_DATE, as defined in LiConfig.

public static int getSchemaDate()

Parameters: None

Return Value:

An integer value identifying the current version of your application’s schema.

Discussion: None

`getApplicationId`

Returns the value of APPLICATION_ID, as defined in LiConfig.

public static String getApplicationId()

Parameters: None

Return Value:

A String containing your application’s Applicasa ID.

Discussion: None

`getApplicationKey`

Returns the value of APPLICATION_KEY, as defined in LiConfig.

public static String getApplicationKey()

Parameters: None

Return Value:

A String containing your application’s Applicasa secret key.

Discussion: None

`getFbApplicationKey`

Returns the value of FB_APPLICATION_KEY, as defined in LiConfig.

public static String getFbApplicationKey()

Parameters: None

Return Value:

A String containing your application’s Applicasa secret key.

Discussion: None

`getSDKVersion`

Returns the value of SDK_VERSION, as defined in LiConfig.

public static double getSDK_VERSION()

Parameters: None

Return Value:

A double value identifying the current version of your application’s SDK.

Discussion: None

`getFrameworkVersion`

Returns the value of FRAMEWORK_VERSION, as defined in LiConfig.

public static double getFrameworkVersion()

Parameters: None

Return Value:

A double value identifying the current version of your application’s LiCore.framework.

Discussion: None

`getSeries`

Returns the value of SERIES, as defined in LiConfig.

public static int getSeries()

Parameters: None

Return Value:

An integer value identifying the current version of your application’s schema.

Discussion: None

`isPushEnabled`

Returns the value of ENABLE_PUSH as defined in LiConfig.

public static boolean isPushEnabled()

Parameters: None

Return Value:

A boolean value indicating whether Push is enabled or disabled in your application.

Discussion:

Indicates whether your application has enabled/disabled Push notifications.

`isApplicasaDebugEnabled`

Returns the value of ENABLE_APPLICASA_DEBUG as defined in LiConfig.

public static boolean isApplicasaDebugEnabled()

Parameters: None

Return Value:

A boolean value indicating whether the Applicasa SDK's DEBUG mode is enabled or disabled in your application.

Discussion:

Indicates whether your application has enabled/disabled the DEBUG environment. Should be set to true during development, and false when app is published.

`isLocationEnabled`

Returns the value of ENABLE_LOCATION as defined in LiConfig.

public static boolean isLocationEnabled()

Parameters: None

Return Value:

A boolean value indicating whether location services are enabled or disabled.

Discussion:

Returns the value of ENABLE_LOCATION as defined in LiConfig, indicating whether location services are enabled or disabled.

`isParallelActionEnabled`

Returns the value of ENABLE_PARALLEL_ACTION as defined in LiConfig.

public static boolean isParallelActionEnabled()

Parameters: None

Return Value:

A boolean value indicating whether parallel action is enabled or disabled.

Discussion:

Returns the value of ENABLE_PARALLEL_ACTION as defined in LiConfig, indicating whether parallel action is enabled or disabled.

`isOfflineEnabled`

Returns the value of ENABLE_OFFLINE as defined in LiConfig.

public static boolean isOfflineEnabled()

Parameters: None

Return Value:

A boolean value indicating whether your application has enabled/disabled the offline database functionality.

Discussion:

Indicates whether your application has enabled/disabled the offline database functionality. Should be set to true if you want the local sqlite datastore, and false otherwise.

`isApplicasaSandboxEnabled`

Returns the value of ENABLE_APPLICASA_SANDBOX as defined in LiConfig.

public static boolean isApplicasaSandboxEnabled()

Parameters: None

Return Value:

A boolean value indicating whether the Applicasa SDK's sandbox is enabled or disabled in your application

Discussion:

Indicates whether your application has enabled/disabled the sandbox environment. Should be set to true during development, and false when app is published.

NOTE: If you publish your app with ENABLE_APPLICASA_SANDBOX still set to true, your published application will be interacting with your development datastore. Be sure to alter this value when you submit your apps.

`isFacebookEnabled`

Returns the value of ENABLE_FACEBOOK as defined in LiConfig.

public static boolean isFacebookEnabled()

Parameters: None

Return Value:

A boolean value indicating whether Applicasa's Facebook features are enabled or disabled.

Discussion:

Returns the value of ENABLE_FACEBOOK as defined in LiConfig, indicating whether Applicasa's Facebook features are enabled or disabled.

`isFbDebugEnabled`

Returns the value of ENABLE_FB_DEBUG as defined in LiConfig.

public static boolean isFbDebugEnabled()

Parameters: None

Return Value:

A boolean value indicating whether the Applicasa SDK's Facebook DEBUG mode is enabled or disabled in your application.

Discussion:

Indicates whether your application has enabled/disabled the Facebook DEBUG environment. Should be set to true during development, and false when app is published.

`getGoogleGCM`

Returns the value of GOOGLE_GCM as defined in LiConfig.

public static String getGoogleGCM()

Parameters: None

Return Value:

A String indicating your application's Google GCM Sender ID value.

Discussion:

Returns your application's Google Cloud Messaging Sender ID value. You must enter the GOOGLE_GCM key to successfully connect with Google Cloud Messaging.

`getGooglePlayPublicKey`

Returns the value of GOOGLE_PLAY_PUBLIC_KEY as defined in LiConfig.

public static String getGooglePlayPublickKey()

Parameters: None

Return Value:

A String value inidcating your application's Google Play public key.

Discussion:

Returns your application's Google Play public key. You must provide this value to the GOOGLE_PLAY_PUBLIC_KEY constant in LiConfig.

`isIAPSandboxEnabled`

Returns the value of ENABLE_IAP_SANDBOX as defined in LiConfig.

public static boolean isIAPSandboxEnabled()

Parameters: None

Return Value:

A boolean value indicating whether your application is in IAP sandbox mode.

Discussion:

During development, you should set the ENABLE_IAP_SANDBOX key to true, and only set the value to false when your application goes into production use.

`isIAPEnabled`

Returns the value of ENABLE_IAP as defined in LiConfig.

public static boolean isIAPEnabled()

Parameters: None

Return Value:

A boolean value indicating whether your application has enabled/disabled IAP support.

Discussion:

If you plan to use Applicasa's IAP functionality in your app, you should set ENABLE_IAP to true, and this method should always return the same value. If you're not using Applicasa's IAP features, set ENABLE_IAP to false.