< Back to Package Overview
Settings and Configuration
Overview
Depending on your deployment model, the Vantage platform receives environment
configuration from multiple sources.
More specifically, the platform may receive 46xx formatted configuration from:
* Web utility server / file server
* AADS configuration server
* DHCP server
* PPM server
The Vantage platform shares the portion of the configuration data relevant to
your application by sending the CONFIG_CHANGED intent to the application, which
is handled inside the desk phone services package.
You can learn more about the interaction with the platform via intents at:
Platform Interaction Via Intents.
Support for Configuration in the Desk Phone Services Package
The desk phone services package receives CONFIG_CHANGED intent from the platform.
The desk phone services reads the configuration data from the platform in the form of 46XX
configuration string.
Desk phone services package notifies application about configuration event via the
DeskPhoneEventListener interface. The application
provides its implementation of this interface as a parameter when initializing
the DeskPhoneService at startup.
When CONFIG_CHANGED intent is received and configuration payload is read from platform, the
onConfigurationChange(String configurationString,CompletionHandler configurationCompletionHandler)
method is invoked on the listener.
Sometimes there may be multiple CONFIG_CHANGED intents received from platform in overlapped / back
to back manner.
Desk phone services package handles overlapping configuration change requests from platform. No
application layer handling required for overlapping configuration change requests from platform.
Desk phone services package never interrupts application with onConfigurationChange() while
application has not invoked configurationCompletionHandler.onFinish()
Application Requirements for Configuration processing
Application to declare the broadcast receiver in manifest file to receive CONFIG_CHANGE intent from
platform. Only active phone application receives this intent from platform.
Application implements DeskPhoneEventListener interface
Process the configuration change in
onConfigurationChange(String configurationString,CompletionHandler configurationCompletionHandler)
Application to use communication package's SettingsFileParser
object to parse received configuration.
Application should indicate completion of configuration processing by invoking
configurationCompletionHandler.onFinish(). This is important and failure to notify about completion
would block subsequent configuration changes coming from desk phone services package.
Application to use the configuration data received to configure communication package.
