Prefs
The Prefs type of the TypeScript SDK, which identities.getPreferences and identities.setPreferences take or answer.
type Prefs = {
prefs: Record<string, unknown>
version: number
}Fields
| Field | Type | Description |
|---|---|---|
prefs | Record<string, unknown> | User client preferences JSON key-value map. Opaque to the server with one exception: notifyNewClient: false turns off the mail the platform sends when a client reaches the identity from a new location (the identity.client.new event to the tenant's hooks is unaffected) |
version | number | Monotonic version counter for optimistic concurrency control (CAS) |
Used by
| Method | What it does |
|---|---|
identities.getPreferences | Get identity preferences |
identities.setPreferences | Save identity preferences |