Files
opencloud/docs/services/settings/_index.md
Martin 9a5714a26f [docs-only] Replace the legacy Extensions with Services (#5518)
* Replace the legacy Extensions with Services

* Update docs/ocis/_index.md

Co-authored-by: Michael Barz <mbarz@owncloud.com>

---------

Co-authored-by: Michael Barz <mbarz@owncloud.com>
2023-02-07 11:21:00 +01:00

1.1 KiB

title, date, weight, geekdocRepo, geekdocEditPath, geekdocFilePath, geekdocCollapseSection
title date weight geekdocRepo geekdocEditPath geekdocFilePath geekdocCollapseSection
Settings 2018-05-02T00:00:00+00:00 20 https://github.com/owncloud/ocis edit/master/docs/services/settings _index.md true

Abstract

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.

Table of Contents

{{< toc-tree >}}