Interface ConfigAdminService

Service used to change a component configuration of an app programmatically. The service is available via interface name ct.framework.api.ConfigurationAdmin.

interface ConfigAdminService {
    createFactoryConfiguration(
        factoryPersistentIdentifier: string,
    ): Configuration;
    getConfiguration(persistentIdentifier: string): Configuration;
    getFactoryConfigurations(
        factoryPersistentIdentifier: string,
    ): Configuration[];
    save(): Promise<void>;
}

Index

Methods

createFactoryConfiguration getConfiguration getFactoryConfigurations save

Methods

createFactoryConfiguration

createFactoryConfiguration(factoryPersistentIdentifier: string): Configuration
Creates a configuration for a factory component.
Parameters
- factoryPersistentIdentifier: string
  Identifier for the factory component.
Returns Configuration
- Defined in apprt/api/index.ts:2308

getConfiguration

getConfiguration(persistentIdentifier: string): Configuration
Get the current configuration of component.
Parameters
- persistentIdentifier: string
  Identifier for the component.
Returns Configuration
- Defined in apprt/api/index.ts:2298

getFactoryConfigurations

getFactoryConfigurations(factoryPersistentIdentifier: string): Configuration[]
Reads all factory configuration instance entries.
Parameters
- factoryPersistentIdentifier: string
  Identifier for the factory component.
Returns Configuration[]
- Defined in apprt/api/index.ts:2303

save

save(): Promise<void>
Permanently store configuration changes with the app configuration.

Returns Promise<void>
- Defined in apprt/api/index.ts:2313