systemPreferences API 列表

本模块包含 36 个 API。

Events(事件)

API 说明 鸿蒙支持
accent-color-changed 在系统主题色发生变化时触发。 不支持
color-changed 在系统颜色配置发生变化时触发。 不支持

Methods(方法)

API 说明 鸿蒙支持
systemPreferences.isSwipeTrackingFromScrollEventsEnabled 返回 boolean,表示「滑动页面」设置是否已开启。 不支持
systemPreferences.postNotification 将 event 以 macOS 原生通知形式发出,userInfo 为随通知发送的用户信息字典。 不支持
systemPreferences.postLocalNotification 将 event 以 macOS 本地原生通知形式发出,userInfo 为随通知发送的用户信息字典。 不支持
systemPreferences.postWorkspaceNotification 将 event 以 macOS Workspace 原生通知形式发出,userInfo 为随通知发送的用户信息字典。 不支持
systemPreferences.subscribeNotification 返回 number,即该订阅的 ID,用于订阅 macOS 原生通知。 不支持
systemPreferences.subscribeLocalNotification 返回 number,即该订阅的 ID,用于订阅 macOS 本地通知。 不支持
systemPreferences.subscribeWorkspaceNotification 返回 number,即该订阅的 ID,用于订阅 macOS Workspace 通知。 不支持
systemPreferences.unsubscribeNotification 移除指定 ID 的通知订阅。 不支持
systemPreferences.unsubscribeLocalNotification 与 unsubscribeNotification 类似,但从 NSNotificationCenter 中移除订阅者。 不支持
systemPreferences.unsubscribeWorkspaceNotification 与 unsubscribeNotification 类似,但从 NSWorkspace.sharedWorkspace.notificationCenter 中移除订阅者。 不支持
systemPreferences.registerDefaults 将指定的默认值添加到应用的 NSUserDefaults 中。 不支持
systemPreferences.getUserDefault-Type-extends-keyof-UserDefaultTypes 返回 UserDefaultTypes[Type],获取 NSUserDefaults 中指定 key 的值,支持 url、array、dictionary 等类型。 不支持
systemPreferences.setUserDefault-Type-extends-keyof-UserDefaultTypes 设置 NSUserDefaults 中指定 key 的值。 不支持
systemPreferences.removeUserDefault 移除 NSUserDefaults 中指定的 key,可用于恢复之前通过 setUserDefault 设置的键的默认值或全局值。 不支持
systemPreferences.isAeroGlassEnabled 返回 boolean,表示 DWM 合成(Aero Glass)是否已启用。 不支持
systemPreferences.getAccentColor 返回 string,以 RGBA 十六进制格式返回用户当前的系统强调色。 不支持
systemPreferences.getColor 返回 string,以 RGBA 十六进制格式(#RRGGBBAA)返回系统颜色设置,包含活动窗口标题栏渐变色等。 不支持
systemPreferences.getSystemColor 返回 string,以 #RRGGBBAA 格式返回标准系统颜色。 不支持
systemPreferences.getEffectiveAppearance 返回 string,可为 dark、light 或 unknown。 不支持
systemPreferences.canPromptTouchID 返回 boolean,表示设备是否支持 Touch ID。 不支持
systemPreferences.promptTouchID 返回 Promise,用户通过 Touch ID 验证成功后 resolve。 不支持
systemPreferences.isTrustedAccessibilityClient 返回 boolean,表示当前进程是否为受信任的辅助功能客户端。 不支持
systemPreferences.getMediaAccessStatus 返回 string,表示媒体访问状态,可为 not-determined、granted、denied、restricted 或 unknown。 支持
systemPreferences.askForMediaAccess 返回 Promise,用户授权时 resolve 为 true,拒绝时为 false。若传入无效 mediaType 则 reject;若权限曾被拒绝,需通过系统偏好设置修改,重启应用后生效。 支持
systemPreferences.getAnimationSettings 返回包含动画设置信息的 Object。 支持
systemPreferences.requestDirectoryPermission 返回 Promise,请求目录访问权限。 支持
systemPreferences.requestSystemPermission 返回 Promise,请求指定的系统权限。 支持
systemPreferences.openApplicationInfoEntry 打开系统设置并跳转到应用程序信息页面。 支持
systemPreferences.fileAccessPersist 对传入的多个文件或目录持久化授权。 支持
systemPreferences.requestNotificationPermission 弹出请求通知权限弹窗。 支持
systemPreferences.checkNotificationEnabled 返回通知是否授权结果。 支持
systemPreferences.activateFileAccessPersist 使能已经永久授权过的文件或目录。 支持

Properties(属性)

API 说明 鸿蒙支持
systemPreferences.accessibilityDisplayShouldReduceTransparency 布尔属性,表示应用是否应避免使用半透明背景,对应 NSWorkspace.accessibilityDisplayShouldReduceTransparency。 不支持
systemPreferences.effectiveAppearance 返回当前应用的 macOS 外观设置,字符串类型,值为 dark、light 或 unknown。 不支持