Class PreferenceController

Hierarchy

PreferenceController

Index

Constructors

constructor

Methods

Constructors

constructor

new PreferenceController(): PreferenceController

Returns PreferenceController

Methods

_request

_request(options: SendOptions): Promise<any>

Parameters
- options: SendOptions
Returns Promise<any>

getPreference

getPreference(preferenceKey: string): Promise<unknown>

Get a preference 's value.

Parameters
- preferenceKey: string
Returns Promise<unknown>

loadPreferenceMap

loadPreferenceMap(): Promise<Record<string, unknown>>

Load all preferences.

Returns Promise<Record<string, unknown>>

setPreference

setPreference(preferenceKey: string, preferenceValue: unknown): Promise<ErrorCodeType>

Set a preference with key and value.

Parameters
- preferenceKey: string
- preferenceValue: unknown
Returns Promise<ErrorCodeType>

updatePreferenceMap

updatePreferenceMap(settings: Record<string, unknown>): Promise<ErrorCodeType>

Update all settings with key-value map.

Parameters
- settings: Record<string, unknown>
Returns Promise<ErrorCodeType>