Small improvements
This commit is contained in:
+7
-5
@@ -7,24 +7,26 @@ geekdocEditPath: edit/master/docs
|
|||||||
geekdocFilePath: values.md
|
geekdocFilePath: values.md
|
||||||
---
|
---
|
||||||
|
|
||||||
A **Settings Value** is the value, an authenticated user has chosen for a specific setting, defined in a
|
A **Settings Value** is the value an authenticated user has chosen for a specific setting, defined in a
|
||||||
*settings bundle*. For choosing settings values as a user, the sole entry point is the ocis-web extension
|
*settings bundle*. For choosing settings values as a user the sole entry point is the ocis-web extension
|
||||||
provided by this service.
|
provided by this service.
|
||||||
|
|
||||||
## Identifying settings values
|
## Identifying settings values
|
||||||
|
|
||||||
A *settings value* is uniquely identified by four attributes. Three of them are coming from the setting within
|
A *settings value* is uniquely identified by four attributes. Three of them are coming from the definition of
|
||||||
it's settings bundle (see [Settings Bundles](https://owncloud.github.io/extensions/ocis_settings/bundles/) for
|
the setting within it's settings bundle (see [Settings Bundles](https://owncloud.github.io/extensions/ocis_settings/bundles/)
|
||||||
an example). The fourth identifies the user.
|
for an example). The fourth identifies the user.
|
||||||
- extension: Key of the extension that registered the settings bundle,
|
- extension: Key of the extension that registered the settings bundle,
|
||||||
- bundleKey: Key of the settings bundle,
|
- bundleKey: Key of the settings bundle,
|
||||||
- settingKey: Key of the setting as defined within the bundle,
|
- settingKey: Key of the setting as defined within the bundle,
|
||||||
- accountUuid: The UUID of the authenticated user who has saved the setting.
|
- accountUuid: The UUID of the authenticated user who has saved the setting.
|
||||||
|
|
||||||
|
{{< hint info >}}
|
||||||
When requests are going through `ocis-proxy`, the accountUuid attribute can be set to the static keyword `me`
|
When requests are going through `ocis-proxy`, the accountUuid attribute can be set to the static keyword `me`
|
||||||
instead of using a real UUID. `ocis-proxy` will take care of minting the UUID of the authenticated user into
|
instead of using a real UUID. `ocis-proxy` will take care of minting the UUID of the authenticated user into
|
||||||
a JWT, providing it in the HTTP header as `x-access-token`. That UUID is then used in this service, to replace
|
a JWT, providing it in the HTTP header as `x-access-token`. That UUID is then used in this service, to replace
|
||||||
`me` with the actual UUID of the authenticated user.
|
`me` with the actual UUID of the authenticated user.
|
||||||
|
{{< /hint >}}
|
||||||
|
|
||||||
## Example of stored settings values
|
## Example of stored settings values
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user