github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-09 15:38:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore: revert promisified systemPreferences notification methods

Browse Source 
This reverts commit eec12b399a.
This commit is contained in:
Shelley Vohr
2019-06-10 09:34:21 -07:00
committed by GitHub
parent 4321df13f2
commit af108764c7
4 changed files with 49 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/api/system-preferences.md
View File

@@ -62,7 +62,7 @@ Returns `Boolean` - Whether the Swipe between pages setting is on.
### `systemPreferences.postNotification(event, userInfo[, deliverImmediately])` _macOS_
* `event` String
* `userInfo` Record<string, unknown>
* `userInfo` Object
* `deliverImmediately` 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
@@ -71,7 +71,7 @@ that contains the user information dictionary sent along with the notification.
### `systemPreferences.postLocalNotification(event, userInfo)` _macOS_
* `event` String
* `userInfo` Record<string, unknown>
* `userInfo` Object
Posts `event` as native notifications of macOS. The `userInfo` is an Object
that contains the user information dictionary sent along with the notification.
@@ -79,7 +79,7 @@ that contains the user information dictionary sent along with the notification.
### `systemPreferences.postWorkspaceNotification(event, userInfo)` _macOS_
* `event` String
* `userInfo` Record<string, unknown>
* `userInfo` Object
Posts `event` as native notifications of macOS. The `userInfo` is an Object
that contains the user information dictionary sent along with the notification.
@@ -89,7 +89,7 @@ that contains the user information dictionary sent along with the notification.
* `event` String
* `callback` Function
* `event` String
* `userInfo` Record<string, unknown>
* `userInfo` Object
Returns `Number` - The ID of this subscription
@@ -109,93 +109,43 @@ example values of `event` are:
* `AppleColorPreferencesChangedNotification`
* `AppleShowScrollBarsSettingChanged`
**[Deprecated](modernization/promisification.md)**
### `systemPreferences.subscribeNotification(event)` _macOS_
* `event` String
Returns `Promise<Object>` - Resolves with an object containing the following items:
* `id` Number - The ID of this subscription, which can be used to unsubscribe the
`event`.
* `event` String
* `userInfo` Record<string, unknown>
Subscribes to native notifications of macOS.
Under the hood this API subscribes to `NSDistributedNotificationCenter`,
example values of `event` are:
* `AppleInterfaceThemeChangedNotification`
* `AppleAquaColorVariantChanged`
* `AppleColorPreferencesChangedNotification`
* `AppleShowScrollBarsSettingChanged`
### `systemPreferences.subscribeLocalNotification(event, callback)` _macOS_
* `event` String
* `callback` Function
* `event` String
* `userInfo` Record<string, unknown>
* `userInfo` 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`.
**[Deprecated](modernization/promisification.md)**
### `systemPreferences.subscribeLocalNotification(event)` _macOS_
* `event` String
Returns `Promise<Object>` - Resolves with an object containing the following items:
* `id` Number - The ID of this subscription
* `event` String
* `userInfo` Record<string, unknown>
Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults.
This is necessary for events such as `NSUserDefaultsDidChangeNotification`.
### `systemPreferences.subscribeWorkspaceNotification(event, callback)` _macOS_
* `event` String
* `callback` Function
* `event` String
* `userInfo` Record<string, unknown>
Same as `subscribeNotification`, but uses `NSWorkspace.sharedWorkspace.notificationCenter`.
This is necessary for events such as `NSWorkspaceDidActivateApplicationNotification`.
**[Deprecated](modernization/promisification.md)**
### `systemPreferences.subscribeWorkspaceNotification(event)` _macOS_
* `event` String
Returns `Promise<Object>` - Resolves with an object containing the following items:
* `id` Number - The ID of this subscription
* `event` String
* `userInfo` Record<string, unknown>
* `userInfo` Object
Same as `subscribeNotification`, but uses `NSWorkspace.sharedWorkspace.notificationCenter`.
This is necessary for events such as `NSWorkspaceDidActivateApplicationNotification`.
### `systemPreferences.unsubscribeNotification(id)` _macOS_
* `id` Number
* `id` Integer
Removes the subscriber with `id`.
### `systemPreferences.unsubscribeLocalNotification(id)` _macOS_
* `id` Number
* `id` Integer
Same as `unsubscribeNotification`, but removes the subscriber from `NSNotificationCenter`.
### `systemPreferences.unsubscribeWorkspaceNotification(id)` _macOS_
* `id` Number
* `id` Integer
Same as `unsubscribeNotification`, but removes the subscriber from `NSWorkspace.sharedWorkspace.notificationCenter`.