Skip to content

Configurations service ​

TIP

Available as a global and a contextual service

WARNING

From the client side, even though most methods are available, we highly recommend using the helper functions provided by the configurations singleton.

Overview ​

This service allows managing generic named objects designed to store application-specific configuration options that can be edited client-side.

Creation from external clients is blocked. Updates are entirely disabled (use patch to modify existing configurations). Deletion from external clients is also blocked, restricting removal to server-side operations.

Data model ​

The data model is a named object associated with a generic value:

FieldTypeDescription
nameStringConfiguration identifier
valueAnyConfiguration value

Hooks ​

The following hooks are executed on the configurations service: