Managing Configurations
This section provides an overview of managing configurations using the Qelos SDK. Configurations in Qelos allow you to store and retrieve application settings and metadata. The SDK provides methods for both regular users and administrators to work with configurations.
App Configurations
The SDK provides the appConfigurations
module for working with application configurations. This module allows you to retrieve and update application configuration metadata.
Getting App Configuration
To retrieve the current application configuration:
const appConfig = await sdk.appConfigurations.getAppConfiguration();
// appConfig.metadata contains the configuration data
Updating App Configuration
To update the application configuration:
const updatedConfig = await sdk.appConfigurations.update({
theme: 'dark',
logo: 'https://example.com/logo.png',
features: {
enableComments: true,
enableSharing: false
}
});
The update
method accepts a partial configuration object and returns the updated configuration.
Admin Configuration Management
Creating a Configuration
As an administrator, you can create new configurations using the admin SDK:
await sdkAdmin.manageConfigurations.create({
key: 'configKey',
public: true,
description: 'Configuration description',
metadata: { setting: 'value' }
});
Updating a Configuration
To update an existing configuration's information, use the following code:
await sdkAdmin.manageConfigurations.update('configKey', { public: false });
Removing a Configuration
To remove a configuration, use the following code:
await sdkAdmin.manageConfigurations.remove('configKey');
Getting List of Configurations
To get a list of all configurations, use the following code:
const configurations = await sdkAdmin.manageConfigurations.getList('configKey');
Management of Custom Configurations
The Qelos SDK also allows managing custom configurations. Here are examples demonstrating how to get, create, update, and remove custom configurations.
Creating of Custom Configurations
To create a new configuration, use the following code:
await sdkAdmin.manageConfigurations.create({
key: 'configKey',
public: true,
metadata: { some: 'data' }
});
Other Operations with Custom Configurations
For updating, removing, and retrieving custom configurations, refer to the regular configuration management methods as they follow the same process:
- Updating a Custom Configuration: Use the same code as updating a regular configuration.
- Removing a Custom Configuration: Use the same code as removing a regular configuration.
- Getting List of Custom Configurations: Use the same code as getting a list of regular configurations.
- Getting a Specific Custom Configuration: Use the same code as getting a specific regular configuration.