SettingsHandler | Ilias Buddy Desktop

handle settings (Set/Get them and their default values, ...)

Hierarchy

SettingsHandler

Index

Methods

isValidURL

isValidURL(urlToCheck: string): boolean

- Defined in modules/Settings/HANDLER/SettingsHandler.js:216
This tester does not like "user-name:password@..."

author

https://www.regextester.com/94502

Parameters
- urlToCheck: string
  
  Url to be checked
Returns boolean

is valid url

Static checkIfIdIsAllowed

checkIfIdIsAllowed(id: string, modifiable?: boolean): boolean

- Defined in modules/Settings/HANDLER/SettingsHandler.js:100
Check if the id is an allowed settings id

Parameters
- id: string
- Default value modifiable: boolean = false
Returns boolean

Static getDefaultValue

getDefaultValue(id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow", modifiable?: boolean): any

- Defined in modules/Settings/HANDLER/SettingsHandler.js:88
Get the default value of the setting

Parameters
- id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"
- Default value modifiable: boolean = false
  
  Specify if hidden or modifiable setting
Returns any

Static getLocalValue

getLocalValue(id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow", modifiable?: boolean): any

- Defined in modules/Settings/HANDLER/SettingsHandler.js:59
Get the local value of the setting or the default if no local one was found

Parameters
- id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"
- Default value modifiable: boolean = false
  
  Specify if hidden or modifiable setting
Returns any

{import('../API/SettingsTypes').Hidden.SettingsType | import('../API/SettingsTypes').Modifiable.SettingsType | undefined}

Static getModifiableSettingsWithCurrentValue

getModifiableSettingsWithCurrentValue(): SettingsObjectMerged[]

- Defined in modules/Settings/HANDLER/SettingsHandler.js:156
Get the current modifiable settings with the current local value

Returns SettingsObjectMerged[]

Static getSettingsObjectByIdHelper

getSettingsObjectByIdHelper(settings: object[], id: string): any

- Defined in modules/Settings/HANDLER/SettingsHandler.js:76
Get the local value of the setting or the default if no local one was found

Parameters
- settings: object[]
- id: string
Returns any

Static getValue

getValue(id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow", modifiable?: boolean): any

- Defined in modules/Settings/HANDLER/SettingsHandler.js:39
Get settings object value

Parameters
- id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"
- Default value modifiable: boolean = false
  
  Specify if hidden or modifiable setting
Returns any

Static makeModifiableTypeChecks

makeModifiableTypeChecks(type: "password" | "toggle" | "text" | "cronJob" | "url" | "keyboardShortcut", value: any): void

- Defined in modules/Settings/HANDLER/SettingsHandler.js:167
Type check a setting

Parameters
- type: "password" | "toggle" | "text" | "cronJob" | "url" | "keyboardShortcut"
- value: any
Returns void

Static save

save(): void

- Defined in modules/Settings/HANDLER/SettingsHandler.js:148
Save the current local settings to a local file

Returns void

Static setModifiableOrHidden

setModifiableOrHidden(id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow", value: any, modifiable?: boolean): void

- Defined in modules/Settings/HANDLER/SettingsHandler.js:115
Set hidden or modifiable settings

Parameters
- id: "restartInfo" | "windowBounds" | "minWindowBounds" | "searchFilter" | "sort" | "savedEntries" | "savedLinks" | "githubLatestReleaseUrl" | "nativeTitleBar" | "userName" | "userUrl" | "userPassword" | "minimizeToSystemTray" | "devMode" | "checkForUpdatesOnStartup" | "checkForUpdatesCronJob" | "checkForUpdatesCronJobConfiguration" | "checkForFeedCronJob" | "checkForFeedCronJobConfiguration" | "autoLaunch" | "globalShortcutShow"
- value: any
- Default value modifiable: boolean = false
  
  Specify if hidden or modifiable setting
Returns void

Hierarchy

Index

Methods

Methods

isValidURL

Parameters

urlToCheck: string

Returns boolean

Static checkIfIdIsAllowed

Parameters

id: string

Default value modifiable: boolean = false

Returns boolean

Static getDefaultValue

Parameters

Default value modifiable: boolean = false

Returns any

Static getLocalValue

Parameters

Default value modifiable: boolean = false

Returns any

Static getModifiableSettingsWithCurrentValue

Returns SettingsObjectMerged[]

Static getSettingsObjectByIdHelper

Parameters

settings: object[]

id: string

Returns any

Static getValue

Parameters

Default value modifiable: boolean = false

Returns any

Static makeModifiableTypeChecks

Parameters

type: "password" | "toggle" | "text" | "cronJob" | "url" | "keyboardShortcut"

value: any

Returns void

Static save

Returns void

Static setModifiableOrHidden

Parameters

value: any

Default value modifiable: boolean = false

Returns void