kotlin-electron/electron.core/SystemPreferences

SystemPreferences

external interface SystemPreferences : EventEmitter(source)

Properties

abstract external val accentColorChangedEvent: EventInstance<Tuple2<Event<*>, String>>

accessibilityDisplayShouldReduceTransparency

abstract external var accessibilityDisplayShouldReduceTransparency: Boolean

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

colorChangedEvent

abstract external val colorChangedEvent: EventInstance<Tuple1<Event<*>>>

effectiveAppearance

abstract external val effectiveAppearance: SystemPreferencesEffectiveAppearance

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

Functions

addListener

external fun addListener(type: EventType, listener: EventListener)

askForMediaAccess

abstract external 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 external fun canPromptTouchID(): Boolean

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

emit

external fun emit(type: EventType, vararg args: Any?): Boolean

eventNames

external fun eventNames(): ReadonlyArray<EventType>

getAccentColor

abstract external fun getAccentColor(): String

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

getAnimationSettings

abstract external fun getAnimationSettings(): AnimationSettings

Returns an object with system animation settings.

getColor

abstract external 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 external fun getEffectiveAppearance(): SystemPreferencesGetEffectiveAppearanceResult

Can be dark, light or unknown.

getMaxListeners

external fun getMaxListeners(): Double

getMediaAccessStatus

abstract external fun getMediaAccessStatus(mediaType: SystemPreferencesGetMediaAccessStatusMediaType): SystemPreferencesGetMediaAccessStatusResult

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

getSystemColor

abstract external fun getSystemColor(color: SystemPreferencesGetSystemColorColor): String

The standard system color formatted as #RRGGBBAA.

getUserDefault

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

The value of key in NSUserDefaults.

isSwipeTrackingFromScrollEventsEnabled

abstract external fun isSwipeTrackingFromScrollEventsEnabled(): Boolean

Whether the Swipe between pages setting is on.

isTrustedAccessibilityClient

abstract external fun isTrustedAccessibilityClient(prompt: Boolean): Boolean

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

listenerCount

external fun listenerCount(type: EventType, listener: EventListener): Double

listeners

external fun listeners(type: EventType): ReadonlyArray<EventListener>

off

external fun off(type: EventType, listener: EventListener)

external fun on(type: EventType, listener: EventListener)

once

external fun once(type: EventType, listener: EventListener)

postLocalNotification

abstract external 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 external 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 external 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.

prependListener