systemPreferences
获取system preferences.
进程:主进程
const { systemPreferences } = require('electron')
console.log(systemPreferences.isDarkMode())
Get system preferences.
Process: Main
const { systemPreferences } = require('electron')
console.log(systemPreferences.isDarkMode())
事件
systemPreferences
对象触发以下事件:
Events
The systemPreferences
object emits the following events:
Event: 'accent-color-changed' Windows
返回:
event
EventnewColor
String - 用户指定的新 RGBA 颜色作为系统偏好颜色.
Event: 'accent-color-changed' Windows
Returns:
event
EventnewColor
String - The new RGBA color the user assigned to be their system accent color.
Event: 'color-changed' Windows
返回:
event
Event
Event: 'color-changed' Windows
Returns:
event
Event
Event: 'inverted-color-scheme-changed' Windows
返回:
event
EventinvertedColorScheme
Boolean -true
if an inverted color scheme (a high contrast color scheme with light text and dark backgrounds) is being used,false
otherwise.
Event: 'inverted-color-scheme-changed' Windows
Returns:
event
EventinvertedColorScheme
Boolean -true
if an inverted color scheme (a high contrast color scheme with light text and dark backgrounds) is being used,false
otherwise.
Event: 'high-contrast-color-scheme-changed' Windows
返回:
event
EventhighContrastColorScheme
Boolean -true
if a high contrast theme is being used,false
otherwise.
Event: 'high-contrast-color-scheme-changed' Windows
Returns:
event
EventhighContrastColorScheme
Boolean -true
if a high contrast theme is being used,false
otherwise.
方法
Methods
systemPreferences.isDarkMode()
macOS
返回Boolean
,表示系统是否处于Dark模式
systemPreferences.isDarkMode()
macOS
Returns Boolean
- Whether the system is in Dark Mode.
systemPreferences.isSwipeTrackingFromScrollEventsEnabled()
macOS
返回值 Boolean
- 是否在页面设置之间进行滑动。
systemPreferences.isSwipeTrackingFromScrollEventsEnabled()
macOS
Returns Boolean
- Whether the Swipe between pages setting is on.
systemPreferences.postNotification(event, userInfo[, deliverImmediately])
macOS
event
StringuserInfo
ObjectdeliverImmediately
Boolean (optional) -true
to post notifications immediately even when the subscribing app is inactive.
发送 event
作为macOS的原生通知。 userInfo
是一个Object,它包含随通知一起发送的用户信息字典。
systemPreferences.postNotification(event, userInfo[, deliverImmediately])
macOS
event
StringuserInfo
ObjectdeliverImmediately
Boolean (optional) -true
to post notifications immediately even when the subscribing app is inactive.
Posts event
as native notifications of macOS. The userInfo
is an Object that contains the user information dictionary sent along with the notification.
systemPreferences.postLocalNotification(event, userInfo)
macOS
event
StringuserInfo
Object
发送 event
作为macOS的原生通知。 userInfo
是一个Object,它包含随通知一起发送的用户信息字典。
systemPreferences.postLocalNotification(event, userInfo)
macOS
event
StringuserInfo
Object
Posts event
as native notifications of macOS. The userInfo
is an Object that contains the user information dictionary sent along with the notification.
systemPreferences.postWorkspaceNotification(event, userInfo)
macOS
event
StringuserInfo
Object
发送 event
作为macOS的原生通知。 userInfo
是一个Object,它包含随通知一起发送的用户信息字典。
systemPreferences.postWorkspaceNotification(event, userInfo)
macOS
event
StringuserInfo
Object
Posts event
as native notifications of macOS. The userInfo
is an Object that contains the user information dictionary sent along with the notification.
systemPreferences.subscribeNotification(event, callback)
macOS
event
Stringcallback
Functionevent
StringuserInfo
Object
返回 Number
- 该订阅的 ID
订阅macOS的原生通知,当通信的 event</ 0>发生时,将调用 <code>callback(event, userInfo)
。 userInfo
是一个Object,它包含随通知一起发送的用户信息字典。
返回订阅的 id
, 可用于取消该订阅的 event
.
在这个API下订阅NSDistributedNotificationCenter
, event
的示例值为:
AppleInterfaceThemeChangedNotification
AppleAquaColorVariantChanged
AppleColorPreferencesChangedNotification
AppleShowScrollBarsSettingChanged
systemPreferences.subscribeNotification(event, callback)
macOS
event
Stringcallback
Functionevent
StringuserInfo
Object
Returns Number
- The ID of this subscription
Subscribes to native notifications of macOS, callback
will be called with callback(event, userInfo)
when the corresponding event
happens. The userInfo
is an Object that contains the user information dictionary sent along with the notification.
The id
of the subscriber is returned, which can be used to unsubscribe the event
.
Under the hood this API subscribes to NSDistributedNotificationCenter
, example values of event
are:
AppleInterfaceThemeChangedNotification
AppleAquaColorVariantChanged
AppleColorPreferencesChangedNotification
AppleShowScrollBarsSettingChanged
systemPreferences.subscribeLocalNotification(event, callback)
macOS
event
Stringcallback
Functionevent
StringuserInfo
Object
返回 Number
- 该订阅的 ID
与subscribeNotification
相同,但使用NSNotificationCenter
作为本地默认值。 这对事件NSUserDefaultsDidChangeNotification
是必需的。
systemPreferences.subscribeLocalNotification(event, callback)
macOS
event
Stringcallback
Functionevent
StringuserInfo
Object
Returns Number
- The ID of this subscription
Same as subscribeNotification
, but uses NSNotificationCenter
for local defaults. This is necessary for events such as NSUserDefaultsDidChangeNotification
.
systemPreferences.subscribeWorkspaceNotification(event, callback)
macOS
event
Stringcallback
Functionevent
StringuserInfo
Object
与 subscribeNotification
一样, 但使用NSWorkspace.sharedWorkspace.notificationCenter
。 这对事件 NSWorkspaceDidActivateApplicationNotification
是必需的。
systemPreferences.subscribeWorkspaceNotification(event, callback)
macOS
event
Stringcallback
Functionevent
StringuserInfo
Object
Same as subscribeNotification
, but uses NSWorkspace.sharedWorkspace.notificationCenter
. This is necessary for events such as NSWorkspaceDidActivateApplicationNotification
.
systemPreferences.unsubscribeNotification(id)
macOS
id
Integer
使用 id
删除订阅。
systemPreferences.unsubscribeNotification(id)
macOS
id
Integer
Removes the subscriber with id
.
systemPreferences.unsubscribeLocalNotification(id)
macOS
id
Integer
与unsubscribeNotification
相同,但将订户从NSNotificationCenter
中删除。
systemPreferences.unsubscribeLocalNotification(id)
macOS
id
Integer
Same as unsubscribeNotification
, but removes the subscriber from NSNotificationCenter
.
systemPreferences.unsubscribeWorkspaceNotification(id)
macOS
id
Integer
与 unsubscribeNotification
一样,但是它从 NSWorkspace.sharedWorkspace.notificationCenter
中移除订阅者。
systemPreferences.unsubscribeWorkspaceNotification(id)
macOS
id
Integer
Same as unsubscribeNotification
, but removes the subscriber from NSWorkspace.sharedWorkspace.notificationCenter
.
systemPreferences.registerDefaults(defaults)
macOS
defaults
Object - 用户默认选项集 (key: value
)
在应用的NSUserDefaults
配置项中添加其它默认设置。
systemPreferences.registerDefaults(defaults)
macOS
defaults
Object - a dictionary of (key: value
) user defaults
Add the specified defaults to your application's NSUserDefaults
.
systemPreferences.getUserDefault(key, type)
macOS
key
Stringtype
String - 可以为string
,boolean
,integer
,float
,double
,url
,array
或dictionary
.
返回 any
- NSUserDefaults
中 key
的值.
常用的 key
和 type
的类型为:
AppleInterfaceStyle
:string
AppleAquaColorVariant
:integer
AppleHighlightColor
:string
AppleShowScrollBars
:string
NSNavRecentPlaces
:array
NSPreferredWebServices
:dictionary
NSUserDictionaryReplacementItems
:array
systemPreferences.getUserDefault(key, type)
macOS
key
Stringtype
String - Can bestring
,boolean
,integer
,float
,double
,url
,array
ordictionary
.
Returns any
- The value of key
in NSUserDefaults
.
Some popular key
and type
s are:
AppleInterfaceStyle
:string
AppleAquaColorVariant
:integer
AppleHighlightColor
:string
AppleShowScrollBars
:string
NSNavRecentPlaces
:array
NSPreferredWebServices
:dictionary
NSUserDictionaryReplacementItems
:array
systemPreferences.setUserDefault(key, type, value)
macOS
key
Stringtype
String - 参见getUserDefault
.value
String
设置 NSUserDefaults
中 key
的值.
请注意,type
应与value
的实际类型匹配。 如果不存在,则抛出异常。
常用的 key
和 type
的类型为:
ApplePressAndHoldEnabled
:boolean
systemPreferences.setUserDefault(key, type, value)
macOS
key
Stringtype
String - SeegetUserDefault
.value
String
Set the value of key
in NSUserDefaults
.
Note that type
should match actual type of value
. An exception is thrown if they don't.
Some popular key
and type
s are:
ApplePressAndHoldEnabled
:boolean
systemPreferences.removeUserDefault(key)
macOS
key
String
删除 NSUserDefaults
中的 key
. 这可以用来恢复默认值或之前用 setUserDefault
设置的 key
的全局值。
systemPreferences.removeUserDefault(key)
macOS
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
.
systemPreferences.isAeroGlassEnabled()
Windows
返回 Boolean
- true
如果启用了 DWM composition (Aero Glass), 否则为 false
.
使用它来确定是否应创建透明窗口的示例 (当禁用 DWM 组合时, 透明窗口无法正常工作):
const { BrowserWindow, systemPreferences } = require('electron')
let browserOptions = { width: 1000, height: 800 }
// Make the window transparent only if the platform supports it.
if (process.platform !== 'win32' || systemPreferences.isAeroGlassEnabled()) {
browserOptions.transparent = true
browserOptions.frame = false
}
// Create the window.
let win = new BrowserWindow(browserOptions)
// Navigate.
if (browserOptions.transparent) {
win.loadURL(`file://${__dirname}/index.html`)
} else {
// No transparency, so we load a fallback that uses basic styles.
win.loadURL(`file://${__dirname}/fallback.html`)
}
systemPreferences.isAeroGlassEnabled()
Windows
Returns Boolean
- true
if DWM composition (Aero Glass) is enabled, and false
otherwise.
An example of using it to determine if you should create a transparent window or not (transparent windows won't work correctly when DWM composition is disabled):
const { BrowserWindow, systemPreferences } = require('electron')
let browserOptions = { width: 1000, height: 800 }
// Make the window transparent only if the platform supports it.
if (process.platform !== 'win32' || systemPreferences.isAeroGlassEnabled()) {
browserOptions.transparent = true
browserOptions.frame = false
}
// Create the window.
let win = new BrowserWindow(browserOptions)
// Navigate.
if (browserOptions.transparent) {
win.loadURL(`file://${__dirname}/index.html`)
} else {
// No transparency, so we load a fallback that uses basic styles.
win.loadURL(`file://${__dirname}/fallback.html`)
}
systemPreferences.getAccentColor()
Windows macOS
返回 String
- 用户当前系统偏好颜色,RGBA 十六进制形式.
const color = systemPreferences.getAccentColor() // `"aabbccdd"`
const red = color.substr(0, 2) // "aa"
const green = color.substr(2, 2) // "bb"
const blue = color.substr(4, 2) // "cc"
const alpha = color.substr(6, 2) // "dd"
This API is only available on macOS 10.14 Mojave or newer.
systemPreferences.getAccentColor()
Windows macOS
Returns String
- The users current system wide accent color preference in RGBA hexadecimal form.
const color = systemPreferences.getAccentColor() // `"aabbccdd"`
const red = color.substr(0, 2) // "aa"
const green = color.substr(2, 2) // "bb"
const blue = color.substr(4, 2) // "cc"
const alpha = color.substr(6, 2) // "dd"
This API is only available on macOS 10.14 Mojave or newer.
systemPreferences.getColor(color)
Windows macOS
color
String - 下列值之一:On Windows:
3d-dark-shadow
- 三维显示元素的暗阴影。3d-face
- 面向三维显示元素和对话框背景的颜色。3d-highlight
- 三维显示元素的高亮色.3d-light
- 三维显示元素的亮色.3d-shadow
- 三维显示元素的阴影颜色.active-border
- 活动窗口边框。active-caption
-活动窗口标题栏。 如果启用了渐变效果,则指定活动窗口标题栏的颜色渐变中的左侧颜色。active-caption-gradient
- 活动窗口标题栏的颜色渐变中的右侧颜色。app-workspace
- 多文档界面 (MDI) 应用程序的背景颜色。button-text
- 按钮上的文本。caption-text
- 标题,大小框和滚动条箭头框中的文本。desktop
- 桌面的背景色。disabled-text
- 灰色 (禁用的) 文字.highlight
- 在控件中选择的项目。highlight-text
- 在控件中选择的项目文本。hotlight
- 超链接或热追踪项目的颜色。inactive-border
- 非活动窗口边框。inactive-caption
-非活动窗口标题栏。 如果启用了渐变效果,则指定非活动窗口标题栏的颜色渐变中的左侧颜色。inactive-caption-gradient
- 非活动窗口标题栏的颜色渐变中的右侧颜色。inactive-caption-text
- 非活动标题中的文字颜色。info-background
- 工具提示控件的背景颜色。info-text
- 工具提示控件的文本颜色。menu
- 菜单的背景色.menu-highlight
- 当菜单显示为平面菜单时用于突出显示菜单项的颜色。menubar
- 菜单显示为平面菜单时菜单栏的背景颜色。menu-text
- 菜单的文字.scrollbar
- 滚动条的灰色区域.window
- 窗口的背景色.window-frame
- 窗口框.window-text
- 窗口的文字。
On macOS
alternate-selected-control-text
- The text on a selected surface in a list or table.control-background
- The background of a large interface element, such as a browser or table.control
- The surface of a control.control-text
-The text of a control that isn’t disabled.disabled-control-text
- The text of a control that’s disabled.find-highlight
- The color of a find indicator.grid
- The gridlines of an interface element such as a table.header-text
- The text of a header cell in a table.highlight
- The virtual light source onscreen.keyboard-focus-indicator
- The ring that appears around the currently focused control when using the keyboard for interface navigation.label
- The text of a label containing primary content.link
- A link to other content.placeholder-text
- A placeholder string in a control or text view.quaternary-label
- The text of a label of lesser importance than a tertiary label such as watermark text.scrubber-textured-background
- The background of a scrubber in the Touch Bar.secondary-label
- The text of a label of lesser importance than a normal label such as a label used to represent a subheading or additional information.selected-content-background
- The background for selected content in a key window or view.selected-control
- The surface of a selected control.selected-control-text
- The text of a selected control.selected-menu-item
- The text of a selected menu.selected-text-background
- The background of selected text.selected-text
- Selected text.separator
- A separator between different sections of content.shadow
- The virtual shadow cast by a raised object onscreen.tertiary-label
- The text of a label of lesser importance than a secondary label such as a label used to represent disabled text.text-background
- Text background.text
- The text in a document.under-page-background
- The background behind a document's content.unemphasized-selected-content-background
- The selected content in a non-key window or view.unemphasized-selected-text-background
- A background for selected text in a non-key window or view.unemphasized-selected-text
- Selected text in a non-key window or view.window-background
- The background of a window.window-frame-text
- The text in the window's titlebar area.
返回 String
-系统颜色设置为RGB十六进制格式 (#ABCDEF
). See the Windows docs and the MacOS docs for more details.
systemPreferences.getColor(color)
Windows macOS
color
String - One of the following values:On Windows:
3d-dark-shadow
- Dark shadow for three-dimensional display elements.3d-face
- Face color for three-dimensional display elements and for dialog box backgrounds.3d-highlight
- Highlight color for three-dimensional display elements.3d-light
- Light color for three-dimensional display elements.3d-shadow
- Shadow color for three-dimensional display elements.active-border
- Active window border.active-caption
- Active window title bar. Specifies the left side color in the color gradient of an active window's title bar if the gradient effect is enabled.active-caption-gradient
- Right side color in the color gradient of an active window's title bar.app-workspace
- Background color of multiple document interface (MDI) applications.button-text
- Text on push buttons.caption-text
- Text in caption, size box, and scroll bar arrow box.desktop
- Desktop background color.disabled-text
- Grayed (disabled) text.highlight
- Item(s) selected in a control.highlight-text
- Text of item(s) selected in a control.hotlight
- Color for a hyperlink or hot-tracked item.inactive-border
- Inactive window border.inactive-caption
- Inactive window caption. Specifies the left side color in the color gradient of an inactive window's title bar if the gradient effect is enabled.inactive-caption-gradient
- Right side color in the color gradient of an inactive window's title bar.inactive-caption-text
- Color of text in an inactive caption.info-background
- Background color for tooltip controls.info-text
- Text color for tooltip controls.menu
- Menu background.menu-highlight
- The color used to highlight menu items when the menu appears as a flat menu.menubar
- The background color for the menu bar when menus appear as flat menus.menu-text
- Text in menus.scrollbar
- Scroll bar gray area.window
- Window background.window-frame
- Window frame.window-text
- Text in windows.
On macOS
alternate-selected-control-text
- The text on a selected surface in a list or table.control-background
- The background of a large interface element, such as a browser or table.control
- The surface of a control.control-text
-The text of a control that isn’t disabled.disabled-control-text
- The text of a control that’s disabled.find-highlight
- The color of a find indicator.grid
- The gridlines of an interface element such as a table.header-text
- The text of a header cell in a table.highlight
- The virtual light source onscreen.keyboard-focus-indicator
- The ring that appears around the currently focused control when using the keyboard for interface navigation.label
- The text of a label containing primary content.link
- A link to other content.placeholder-text
- A placeholder string in a control or text view.quaternary-label
- The text of a label of lesser importance than a tertiary label such as watermark text.scrubber-textured-background
- The background of a scrubber in the Touch Bar.secondary-label
- The text of a label of lesser importance than a normal label such as a label used to represent a subheading or additional information.selected-content-background
- The background for selected content in a key window or view.selected-control
- The surface of a selected control.selected-control-text
- The text of a selected control.selected-menu-item
- The text of a selected menu.selected-text-background
- The background of selected text.selected-text
- Selected text.separator
- A separator between different sections of content.shadow
- The virtual shadow cast by a raised object onscreen.tertiary-label
- The text of a label of lesser importance than a secondary label such as a label used to represent disabled text.text-background
- Text background.text
- The text in a document.under-page-background
- The background behind a document's content.unemphasized-selected-content-background
- The selected content in a non-key window or view.unemphasized-selected-text-background
- A background for selected text in a non-key window or view.unemphasized-selected-text
- Selected text in a non-key window or view.window-background
- The background of a window.window-frame-text
- The text in the window's titlebar area.
Returns String
- The system color setting in RGB hexadecimal form (#ABCDEF
). See the Windows docs and the MacOS docs for more details.
systemPreferences.getSystemColor(color)
macOS
color
String - 下列值之一:blue
brown
gray
green
orange
pink
purple
red
yellow
Returns one of several standard system colors that automatically adapt to vibrancy and changes in accessibility settings like 'Increase contrast' and 'Reduce transparency'. See Apple Documentation for more details.
systemPreferences.getSystemColor(color)
macOS
color
String - One of the following values:blue
brown
gray
green
orange
pink
purple
red
yellow
Returns one of several standard system colors that automatically adapt to vibrancy and changes in accessibility settings like 'Increase contrast' and 'Reduce transparency'. See Apple Documentation for more details.
systemPreferences.isInvertedColorScheme()
Windows
Returns Boolean
- true
if an inverted color scheme (a high contrast color scheme with light text and dark backgrounds) is active, false
otherwise.
systemPreferences.isInvertedColorScheme()
Windows
Returns Boolean
- true
if an inverted color scheme (a high contrast color scheme with light text and dark backgrounds) is active, false
otherwise.
systemPreferences.isHighContrastColorScheme()
Windows
Returns Boolean
- true
if a high contrast theme is active, false
otherwise.
systemPreferences.isHighContrastColorScheme()
Windows
Returns Boolean
- true
if a high contrast theme is active, false
otherwise.
systemPreferences.getEffectiveAppearance()
macOS
返回 String
- 其值可能是 dark
、light
或 unknown
.
获取当前应用到你的程序上的 macOS 设置项,会映射到 NSApplication.effectiveAppearance
需要注意的是,在 构建针对Electron 10.14 SDK 之前的版本时,你的程序的effectiveAppearance
默认为 "light" 并且不会继承系统的设置。 In the interim in order for your application to inherit the OS preference you must set the NSRequiresAquaSystemAppearance
key in your apps Info.plist
to false
. If you are using electron-packager
or electron-forge
just set the enableDarwinDarkMode
packager option to true
. 查看 Electron Packager API 以获得更多细节。
systemPreferences.getEffectiveAppearance()
macOS
Returns String
- Can be dark
, light
or unknown
.
Gets the macOS appearance setting that is currently applied to your application, maps to NSApplication.effectiveAppearance
Please note that until Electron is built targeting the 10.14 SDK, your application's effectiveAppearance
will default to 'light' and won't inherit the OS preference. In the interim in order for your application to inherit the OS preference you must set the NSRequiresAquaSystemAppearance
key in your apps Info.plist
to false
. If you are using electron-packager
or electron-forge
just set the enableDarwinDarkMode
packager option to true
. See the Electron Packager API for more details.
systemPreferences.getAppLevelAppearance()
macOS
返回 String
| null
- 其值可能为 dark
、light
或 unknown
。
Gets the macOS appearance setting that you have declared you want for your application, maps to NSApplication.appearance. 您可以使用 setAppLevelAppearance
API 来设置此值。
systemPreferences.getAppLevelAppearance()
macOS
Returns String
| null
- Can be dark
, light
or unknown
.
Gets the macOS appearance setting that you have declared you want for your application, maps to NSApplication.appearance. You can use the setAppLevelAppearance
API to set this value.
systemPreferences.setAppLevelAppearance(appearance)
macOS
appearance
String | null - 可以是dark
或light
设定您的应用程序的外观设置,这应该覆盖系统默认值以及覆盖 getEffectiveAppearance
的值。
systemPreferences.setAppLevelAppearance(appearance)
macOS
appearance
String | null - Can bedark
orlight
Sets the appearance setting for your application, this should override the system default and override the value of getEffectiveAppearance
.
systemPreferences.canPromptTouchID()
macOS
Returns Boolean
- whether or not this device has the ability to use Touch ID.
NOTE: This API will return false
on macOS systems older than Sierra 10.12.2.
systemPreferences.canPromptTouchID()
macOS
Returns Boolean
- whether or not this device has the ability to use Touch ID.
NOTE: This API will return false
on macOS systems older than Sierra 10.12.2.
systemPreferences.promptTouchID(reason)
macOS
reason
String - The reason you are asking for Touch ID authentication
Returns Promise<void>
- resolves if the user has successfully authenticated with Touch ID.
const { systemPreferences } = require('electron')
systemPreferences.promptTouchID('To get consent for a Security-Gated Thing').then(success => {
console.log('You have successfully authenticated with Touch ID!')
}).catch(err => {
console.log(err)
})
This API itself will not protect your user data; rather, it is a mechanism to allow you to do so. Native apps will need to set Access Control Constants like kSecAccessControlUserPresence
on the their keychain entry so that reading it would auto-prompt for Touch ID biometric consent. This could be done with node-keytar
, such that one would store an encryption key with node-keytar
and only fetch it if promptTouchID()
resolves.
NOTE: This API will return a rejected Promise on macOS systems older than Sierra 10.12.2.
systemPreferences.promptTouchID(reason)
macOS
reason
String - The reason you are asking for Touch ID authentication
Returns Promise<void>
- resolves if the user has successfully authenticated with Touch ID.
const { systemPreferences } = require('electron')
systemPreferences.promptTouchID('To get consent for a Security-Gated Thing').then(success => {
console.log('You have successfully authenticated with Touch ID!')
}).catch(err => {
console.log(err)
})
This API itself will not protect your user data; rather, it is a mechanism to allow you to do so. Native apps will need to set Access Control Constants like kSecAccessControlUserPresence
on the their keychain entry so that reading it would auto-prompt for Touch ID biometric consent. This could be done with node-keytar
, such that one would store an encryption key with node-keytar
and only fetch it if promptTouchID()
resolves.
NOTE: This API will return a rejected Promise on macOS systems older than Sierra 10.12.2.
systemPreferences.isTrustedAccessibilityClient(prompt)
macOS
prompt
Boolean - whether or not the user will be informed via prompt if the current process is untrusted.
Returns Boolean
- true
if the current process is a trusted accessibility client and false
if it is not.
systemPreferences.isTrustedAccessibilityClient(prompt)
macOS
prompt
Boolean - whether or not the user will be informed via prompt if the current process is untrusted.
Returns Boolean
- true
if the current process is a trusted accessibility client and false
if it is not.
systemPreferences.getMediaAccessStatus(mediaType)
macOS
mediaType
String -microphone
orcamera
.
Returns String
- Can be not-determined
, granted
, denied
, restricted
or unknown
.
This user consent was not required until macOS 10.14 Mojave, so this method will always return granted
if your system is running 10.13 High Sierra or lower.
systemPreferences.getMediaAccessStatus(mediaType)
macOS
mediaType
String -microphone
orcamera
.
Returns String
- Can be not-determined
, granted
, denied
, restricted
or unknown
.
This user consent was not required until macOS 10.14 Mojave, so this method will always return granted
if your system is running 10.13 High Sierra or lower.
systemPreferences.askForMediaAccess(mediaType)
macOS
mediaType
String - the type of media being requested; can bemicrophone
,camera
.
Returns 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.
Important: In order to properly leverage this API, you must set the NSMicrophoneUsageDescription
and NSCameraUsageDescription
strings in your app's Info.plist
file. The values for these keys will be used to populate the permission dialogs so that the user will be properly informed as to the purpose of the permission request. See Electron Application Distribution for more information about how to set these in the context of Electron.
This user consent was not required until macOS 10.14 Mojave, so this method will always return true
if your system is running 10.13 High Sierra or lower.
systemPreferences.askForMediaAccess(mediaType)
macOS
mediaType
String - the type of media being requested; can bemicrophone
,camera
.
Returns 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.
Important: In order to properly leverage this API, you must set the NSMicrophoneUsageDescription
and NSCameraUsageDescription
strings in your app's Info.plist
file. The values for these keys will be used to populate the permission dialogs so that the user will be properly informed as to the purpose of the permission request. See Electron Application Distribution for more information about how to set these in the context of Electron.
This user consent was not required until macOS 10.14 Mojave, so this method will always return true
if your system is running 10.13 High Sierra or lower.
systemPreferences.getAnimationSettings()
返回 Object
:
shouldRenderRichAnimation
Boolean - Returns true if rich animations should be rendered. Looks at session type (e.g. remote desktop) and accessibility settings to give guidance for heavy animations.scrollAnimationsEnabledBySystem
Boolean - Determines on a per-platform basis whether scroll animations (e.g. produced by home/end key) should be enabled.prefersReducedMotion
Boolean - Determines whether the user desires reduced motion based on platform APIs.
Returns an object with system animation settings.
systemPreferences.getAnimationSettings()
Returns Object
:
shouldRenderRichAnimation
Boolean - Returns true if rich animations should be rendered. Looks at session type (e.g. remote desktop) and accessibility settings to give guidance for heavy animations.scrollAnimationsEnabledBySystem
Boolean - Determines on a per-platform basis whether scroll animations (e.g. produced by home/end key) should be enabled.prefersReducedMotion
Boolean - Determines whether the user desires reduced motion based on platform APIs.
Returns an object with system animation settings.