Class PreferenceService

Service to get, set (apply and persist) settings. Uses OData profile service endpoint.

Hierarchy (View Summary)

PreferenceService
- PreferenceServiceLocalStorage

Index

Constructors

Properties

Methods

getAllProfileEntries getPreferences getPresets init persistProfileEntries setPreferences setPresets

Constructors

constructor

new PreferenceService(): PreferenceService
Returns PreferenceService

Properties

`Protected`entries

entries: ProfileEntry[] = []

Methods

`Protected`getAllProfileEntries

getAllProfileEntries(): Promise<ProfileEntry[]>
Returns Promise<ProfileEntry[]>
- Defined in core/src/custom-elements/webparts/UserPreference/PreferenceService.ts:134

getPreferences

getPreferences(): Preferences
Returns Preferences
- Defined in core/src/custom-elements/webparts/UserPreference/PreferenceService.ts:55

getPresets

getPresets(scope: string): Preset<unknown>[]
Parameters
- scope: string
Returns Preset<unknown>[]
- Defined in core/src/custom-elements/webparts/UserPreference/PreferenceService.ts:100

init

init(): Promise<void>
Returns Promise<void>
- Defined in core/src/custom-elements/webparts/UserPreference/PreferenceService.ts:49

`Protected`persistProfileEntries

persistProfileEntries(entries: ProfileEntry[]): Promise<void>
Parameters
- entries: ProfileEntry[]
Returns Promise<void>
- Defined in core/src/custom-elements/webparts/UserPreference/PreferenceService.ts:121

setPreferences

setPreferences(preferences?: Preferences): Promise<void>
Parameters
- Optionalpreferences: Preferences
Returns Promise<void>
- Defined in core/src/custom-elements/webparts/UserPreference/PreferenceService.ts:62

setPresets

setPresets(scope: string, presets: Preset<unknown>[]): Promise<void>
Parameters
- scope: string
- presets: Preset<unknown>[]
Returns Promise<void>
- Defined in core/src/custom-elements/webparts/UserPreference/PreferenceService.ts:105