main/settings-file
Functions
Section titled “Functions”exportSettings()
Section titled “exportSettings()”exportSettings(
sender,definitions,settings):Promise<boolean>
Defined in: app/src/main/settings-file.ts:43
Saves the settings that the user changed, in a file that the user picks.
Parameters
Section titled “Parameters”sender
Section titled “sender”WebContents
The settings page.
definitions
Section titled “definitions”readonly SettingDefinition<unknown>[]
The settings that the page shows.
settings
Section titled “settings”The settings.
Returns
Section titled “Returns”Promise<boolean>
Whether the file was saved.
importSettings()
Section titled “importSettings()”importSettings(
sender,shown,settings):Promise<{applied:number;ok:true;skipped:number; } | {error:"invalid"|"canceled";ok:false; }>
Defined in: app/src/main/settings-file.ts:73
Reads settings from a file that the user picks. Settings that a policy fixes, that the page does not show or whose value is not valid are skipped; nothing else changes.
Parameters
Section titled “Parameters”sender
Section titled “sender”WebContents
The settings page.
ReadonlyMap<string, SettingDefinition<unknown>>
The settings that the page shows, by key.
settings
Section titled “settings”The settings.
Returns
Section titled “Returns”Promise<{ applied: number; ok: true; skipped: number; } | { error: "invalid" | "canceled"; ok: false; }>