Skip to content

PlatformSettingKey

Platform setting keys the SDK supports.

Only these keys can be read or written — the settings store holds other keys, but they are not part of this SDK's surface.

Every operation in this module is user-scoped: userId is always sent, so reads and writes act on one user's own value for a key. The underlying store can also hold an organization-wide value per key (selected by omitting userId), but this SDK does not expose that scope.

Enumeration Members

UserAccessibility

UserAccessibility: "UserAccessibility.Accessibility"

Whether the user has enabled accessibility mode (e.g. true, false).


UserAlert

UserAlert: "UserAlert.AlertDuration"

How long alerts remain visible for the user.


UserCaseAppOrder

UserCaseAppOrder: "UserCase.AppOrderByTenant"

The user's app ordering in Case Management, per tenant. Stored as JSON.


UserCaseInstancesTableFiltersByTenant

UserCaseInstancesTableFiltersByTenant: "UserCase.InstancesTableFiltersByTenant"

The user's saved case-instance table filters, per tenant. Stored as JSON.


UserCasePinnedInstancesByTenant

UserCasePinnedInstancesByTenant: "UserCase.PinnedInstancesByTenant"

Case instances the user has pinned, per tenant. Stored as JSON.


UserLanguage

UserLanguage: "UserLanguage.Language"

The user's preferred UI language.


UserLanguageDate

UserLanguageDate: "UserLanguage.Date"

The user's preferred date format.


UserTheme

UserTheme: "UserTheme.Theme"

The user's UI theme (e.g. light, dark).