cordova-plugin-AppConfig 1.1.3

This plugin defines a global cordova.plugins.AppConfig object, which provides information on EMM application configuration (or managed app configuration). Although the object is in the global scope, it is not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(cordova.plugins.AppConfig.getValue("serverURL"));
}

Installation

cordova plugin add cordova-plugin-appconfig

Methods

getValue
registerChangedListener

getValue

Get value from the application configuration.

Note that even though some EMM vendors may allow date and/or binary data to be specified in application configuration, date and binary data types are not supported by this plugin due to limitation on passing these types of data to Javascript. To work around this limitation, date and binary data can be encoded and specified as strings in the application configuration. The application can then decode them accordingly.

Parameter:

configKey: Key of the value to get, or null to get all the values as an object.

registerChangedListener

Information about what has changed is not available. The listener should call getValue to get the current values and decide how to handle any change. It is also possible that the same change will invoke the listener more than once.

On Android, application configuration is stored as restrictions. On iOS, application configuration is stored in standardUserDefaults. Any change to those storage areas will invoke the listener, even if the change is not within application configuration.

Parameter:

listener: The function that will be invoked when the application configuration is changed.

Supported Platforms

Android
iOS

More Info

For information on how each OS supports managed app configuration:

Android Developer Guide on Managed Configurations

iOS Developer Guide on Managed App Configuration

For information on implementing various EMM features, including managed app configuration:

AppConfig Community

Contributing

This is an open source project maintained by audioeng. Pull Requests are currently being accepted. See CONTRIBUTING for details.

License

Based on work by Oracle, updated and adapted by Joshua Clark.