Files
opencloud/services/settings
Ralf Haferkamp 2ed7f7d31e Create README for settings service
The just moves over the contents from  docs/services/settings/_index.md.
2023-05-16 10:52:53 +02:00
..
2023-02-16 13:54:41 +01:00
2023-05-16 10:52:53 +02:00
2023-02-03 10:27:05 +01:00

Settings

When using oCIS, the requirement to store settings arises. This extension provides functionality for other extensions to register new settings within oCIS. It is responsible for storing the respective settings values as well.

{{< mermaid class="text-center">}} graph TD ows ---|"listSettingsBundles(),
saveSettingsValue(value)"| os[ocis-settings] owc ---|"listSettingsValues()"| sdk[oC SDK] sdk --- sdks{ocis-settings
available?} sdks ---|"yes"| os sdks ---|"no"| defaults[Use set of
default values] oa[oCIS services
e.g. ocis-accounts] ---|"saveSettingsBundle(bundle)"| os {{< /mermaid >}}

The diagram shows how the settings service integrates into oCIS:

Settings management:

  • oCIS services can register settings bundles with the ocis-settings service.

Settings usage:

  • Extensions can query ocis-settings for settings values of a user.