UserSettingsService.md

incyclist-services - v1.2.2 / UserSettingsService

Class: UserSettingsService

Table of contents

Constructors

• constructor

Properties

• settings
• binding
• logger
• isInitialized
• isDirty
• savePromise
• instanceId
• initPromise
• observers
• _instance
• _defaultBinding

Methods

• setBinding
• init
• getAll
• get
• set
• requestNotifyOnChange
• stopNotifyOnChange
• update
• updateSettings
• save
• onAppClose
• getInstance
• setDefaultBinding

Constructors

constructor

• new UserSettingsService(binding?): UserSettingsService

Parameters

Name	Type
binding?	IUserSettingsBinding

Returns

UserSettingsService

Properties

settings

• settings: any

---

binding

• binding: IUserSettingsBinding

---

logger

• logger: default

---

isInitialized

• isInitialized: boolean

---

isDirty

• isDirty: boolean

---

savePromise

• savePromise: Promise<boolean>

---

instanceId

• instanceId: number

---

initPromise

• initPromise: Promise<boolean>

---

observers

• observers: { id: string ; key: string ; observer: Observer }[] = []

---

_instance

▪ Static _instance: UserSettingsService

---

_defaultBinding

▪ Static _defaultBinding: IUserSettingsBinding

Methods

setBinding

▸ setBinding(binding): void

Parameters

Name	Type
binding	IUserSettingsBinding

Returns

void

---

init

▸ init(): Promise<boolean>

Returns

Promise<boolean>

---

getAll

▸ getAll(): any

Returns

any

---

get

▸ get(key, defValue): any

Parameters

Name	Type
key	string
defValue	any

Returns

any

---

set

▸ set(key, value, save?): void

Parameters

Name	Type	Default value
key	string	undefined
value	any	undefined
save	boolean	true

Returns

void

---

requestNotifyOnChange

▸ requestNotifyOnChange(requesterId, key): Observer

Parameters

Name	Type
requesterId	string
key	string

Returns

Observer

---

stopNotifyOnChange

▸ stopNotifyOnChange(requesterId): void

Parameters

Name	Type
requesterId	string

Returns

void

---

update

▸ update(data): Promise<boolean>

Parameters

Name	Type
data	any

Returns

Promise<boolean>

---

updateSettings

▸ updateSettings(data): Promise<boolean>

Parameters

Name	Type
data	any

Returns

Promise<boolean>

---

save

▸ save(): Promise<void>

Returns

Promise<void>

---

onAppClose

▸ onAppClose(): Promise<void>

Returns

Promise<void>

---

getInstance

▸ getInstance(): UserSettingsService

Returns

UserSettingsService

---

setDefaultBinding

▸ setDefaultBinding(binding): void

Parameters

Name	Type
binding	IUserSettingsBinding

Returns

void