kotlin-electron/electron.core/SystemPreferences

SystemPreferences

external interface SystemPreferences : EventEmitter(source)

Properties

effectiveAppearance

abstract val effectiveAppearance: SystemPreferencesEffectiveAppearance

A string property that can be dark, light or unknown.

Functions

accessibilityDisplayShouldReduceTransparency

abstract fun accessibilityDisplayShouldReduceTransparency(): Boolean

A boolean property which determines whether the app avoids using semitransparent backgrounds. This maps to NSWorkspace.accessibilityDisplayShouldReduceTransparency

addListener

abstract fun addListener(event: SystemPreferencesEvent.ACCENT_COLOR_CHANGED, listener: (event: Event<*>, newColor: String) -> Unit)

abstract fun addListener(event: SystemPreferencesEvent.COLOR_CHANGED, listener: (event: Event<*>) -> Unit)

askForMediaAccess

abstract fun askForMediaAccess(mediaType: SystemPreferencesAskForMediaAccessMediaType): Promise<Boolean>

A promise that resolves with true if consent was granted and false if it was denied. If an invalid mediaType is passed, the promise will be rejected. If an access request was denied and later is changed through the System Preferences pane, a restart of the app will be required for the new permissions to take effect. If access has already been requested and denied, it must be changed through the preference pane; an alert will not pop up and the promise will resolve with the existing access status.

canPromptTouchID

abstract fun canPromptTouchID(): Boolean

whether or not this device has the ability to use Touch ID.

eventNames

fun eventNames(): Array<Any>

getAccentColor

abstract fun getAccentColor(): String

The users current system wide accent color preference in RGBA hexadecimal form.

getAnimationSettings

abstract fun getAnimationSettings(): AnimationSettings

Returns an object with system animation settings.

getColor

abstract fun getColor(color: SystemPreferencesGetColorColor): String

The system color setting in RGBA hexadecimal form (#RRGGBBAA). See the Windows docs and the macOS docs for more details.

getEffectiveAppearance

abstract fun getEffectiveAppearance(): SystemPreferencesGetEffectiveAppearanceResult

Can be dark, light or unknown.

getMaxListeners

fun getMaxListeners(): Double

getMediaAccessStatus

abstract fun getMediaAccessStatus(mediaType: SystemPreferencesGetMediaAccessStatusMediaType): SystemPreferencesGetMediaAccessStatusResult

Can be not-determined, granted, denied, restricted or unknown.

getSystemColor

abstract fun getSystemColor(color: SystemPreferencesGetSystemColorColor): String

The standard system color formatted as #RRGGBBAA.

getUserDefault

abstract fun getUserDefault(key: String, type: String): Any?

The value of key in NSUserDefaults.

isAeroGlassEnabled

abstract fun isAeroGlassEnabled(): Boolean

true if DWM composition (Aero Glass) is enabled, and false otherwise.

isSwipeTrackingFromScrollEventsEnabled

abstract fun isSwipeTrackingFromScrollEventsEnabled(): Boolean

Whether the Swipe between pages setting is on.

isTrustedAccessibilityClient

abstract fun isTrustedAccessibilityClient(prompt: Boolean): Boolean

true if the current process is a trusted accessibility client and false if it is not.

off

abstract fun off(event: SystemPreferencesEvent.ACCENT_COLOR_CHANGED, listener: (event: Event<*>, newColor: String) -> Unit)

abstract fun off(event: SystemPreferencesEvent.COLOR_CHANGED, listener: (event: Event<*>) -> Unit)

abstract fun on(event: SystemPreferencesEvent.ACCENT_COLOR_CHANGED, listener: (event: Event<*>, newColor: String) -> Unit)

abstract fun on(event: SystemPreferencesEvent.COLOR_CHANGED, listener: (event: Event<*>) -> Unit)

once

abstract fun once(event: SystemPreferencesEvent.ACCENT_COLOR_CHANGED, listener: (event: Event<*>, newColor: String) -> Unit)

abstract fun once(event: SystemPreferencesEvent.COLOR_CHANGED, listener: (event: Event<*>) -> Unit)

postLocalNotification

abstract fun postLocalNotification(event: String, userInfo: ReadonlyRecord<String, Any?>)

Posts event as native notifications of macOS. The userInfo is an Object that contains the user information dictionary sent along with the notification.

postNotification

abstract fun postNotification(event: String, userInfo: ReadonlyRecord<String, Any?>, deliverImmediately: Boolean = definedExternally)

Posts event as native notifications of macOS. The userInfo is an Object that contains the user information dictionary sent along with the notification.

postWorkspaceNotification

abstract fun postWorkspaceNotification(event: String, userInfo: ReadonlyRecord<String, Any?>)

Posts event as native notifications of macOS. The userInfo is an Object that contains the user information dictionary sent along with the notification.

promptTouchID

abstract fun promptTouchID(reason: String): Promise<Void>

resolves if the user has successfully authenticated with Touch ID.

registerDefaults

abstract fun registerDefaults(defaults: ReadonlyRecord<String, Any>)

Add the specified defaults to your application's NSUserDefaults.

removeListener

abstract fun removeListener(event: SystemPreferencesEvent.ACCENT_COLOR_CHANGED, listener: (event: Event<*>, newColor: String) -> Unit)

abstract fun removeListener(event: SystemPreferencesEvent.COLOR_CHANGED, listener: (event: Event<*>) -> Unit)

removeUserDefault

abstract fun removeUserDefault(key: String)

Removes the key in NSUserDefaults. This can be used to restore the default or global value of a key previously set with setUserDefault.

setMaxListeners

fun setMaxListeners(n: Number)

setUserDefault

abstract fun setUserDefault(key: String, type: String, value: Any?)

Set the value of key in NSUserDefaults.

subscribeLocalNotification

abstract fun subscribeLocalNotification(event: String?, callback: (event: String, userInfo: ReadonlyRecord<String, Any?>, object: String) -> Unit): Double

The ID of this subscription

subscribeNotification

abstract fun subscribeNotification(event: String?, callback: (event: String, userInfo: ReadonlyRecord<String, Any?>, object: String) -> Unit): Double

The ID of this subscription

subscribeWorkspaceNotification

abstract fun subscribeWorkspaceNotification(event: String?, callback: (event: String, userInfo: ReadonlyRecord<String, Any?>, object: String) -> Unit): Double

The ID of this subscription

unsubscribeLocalNotification

abstract fun unsubscribeLocalNotification(id: Double)

Same as unsubscribeNotification, but removes the subscriber from NSNotificationCenter.

unsubscribeNotification

abstract fun unsubscribeNotification(id: Double)

Removes the subscriber with id.

unsubscribeWorkspaceNotification

abstract fun unsubscribeWorkspaceNotification(id: Double)

Same as unsubscribeNotification, but removes the subscriber from NSWorkspace.sharedWorkspace.notificationCenter.