Interface: ConfigApi
ConfigApi.ConfigApi
Description
Contains APIs to set and retrieve the application configuration
Properties
Properties
getConfig
• getConfig: () => ConfigSettings
Type declaration
▸ (): ConfigSettings
Description
Allows the developer to get the configuration settings for the application
Returns
An object of configuration settings
onConfigLoaded
• onConfigLoaded: (handler: EventHandlerFunction) => void
Type declaration
▸ (handler): void
Description
Allows the developer to register a callback to be triggered when all configurations have been consolidated
Parameters
| Name | Type |
|---|---|
handler
|
EventHandlerFunction
|
Returns
void
setConfig
• setConfig: (config: ConfigSettings) => void
Type declaration
▸ (config): void
Description
Allows the developer to set a configuration setting for the application
Parameters
| Name | Type | Description |
|---|---|---|
config
|
ConfigSettings
|
An object of configuration settings to be set |
Returns
void
