kotlin-electron/electron.core/SystemPreferences

SystemPreferences

external interface SystemPreferences : <ERROR CLASS> ERROR CLASS: Symbol not found for node.events.EventEmitter(source)

Properties

abstract val accentColorChangedEvent: ERROR CLASS: Symbol not found for node.events.EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple2<electron/core/Event<*>, kotlin/String>>

accessibilityDisplayShouldReduceTransparency

abstract var accessibilityDisplayShouldReduceTransparency: Boolean

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

colorChangedEvent

abstract val colorChangedEvent: ERROR CLASS: Symbol not found for node.events.EventInstance<ERROR CLASS: Symbol not found for js.array.Tuple1<electron/core/Event<*>>>

effectiveAppearance

abstract val effectiveAppearance: SystemPreferencesEffectiveAppearance

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

Functions

askForMediaAccess

abstract fun askForMediaAccess(mediaType: SystemPreferencesAskForMediaAccessMediaType): ERROR CLASS: Symbol not found for Promise<kotlin/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.

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.

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.

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.

postLocalNotification

abstract fun postLocalNotification(event: String, userInfo: ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, kotlin/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: ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, kotlin/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: ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, kotlin/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): ERROR CLASS: Symbol not found for Promise<ERROR CLASS: Symbol not found for js.core.Void>

resolves if the user has successfully authenticated with Touch ID.

registerDefaults

abstract fun registerDefaults(defaults: ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, kotlin/Any>)

Add the specified defaults to your application's NSUserDefaults.

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.

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, @R|kotlin/ParameterName|(name = String(userInfo)) ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, kotlin/Any?>, object: String) -> Unit): Double

The ID of this subscription

subscribeNotification

abstract fun subscribeNotification(event: String?, callback: (event: String, @R|kotlin/ParameterName|(name = String(userInfo)) ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, kotlin/Any?>, object: String) -> Unit): Double

The ID of this subscription

subscribeWorkspaceNotification

abstract fun subscribeWorkspaceNotification(event: String?, callback: (event: String, @R|kotlin/ParameterName|(name = String(userInfo)) ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, kotlin/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.