mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Mark certain Notification options as optional

Browse source 
This change makes the `subtitle` and `actions` options optional to the
Notification constructor, since they are only available on macOS.
This commit is contained in:
Loren Segal 2017-07-25 13:24:15 -04:00 committed by GitHub
parent cb3c5ded0f
commit 205954fa27
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api/notification.md
View file

@ -31,13 +31,13 @@ Returns `Boolean` - Whether or not desktop notifications are supported on the cu
* `options` Object * `options` Object
* `title` String - A title for the notification, which will be shown at the top of the notification window when it is shown * `title` String - A title for the notification, which will be shown at the top of the notification window when it is shown
* `subtitle` String - A subtitle for the notification, which will be displayed below the title. _macOS_ * `subtitle` String - (optional) A subtitle for the notification, which will be displayed below the title. _macOS_
* `body` String - The body text of the notification, which will be displayed below the title or subtitle * `body` String - The body text of the notification, which will be displayed below the title or subtitle
* `silent` Boolean - (optional) Whether or not to emit an OS notification noise when showing the notification * `silent` Boolean - (optional) Whether or not to emit an OS notification noise when showing the notification
* `icon` [NativeImage](native-image.md) - (optional) An icon to use in the notification * `icon` [NativeImage](native-image.md) - (optional) An icon to use in the notification
* `hasReply` Boolean - (optional) Whether or not to add an inline reply option to the notification. _macOS_ * `hasReply` Boolean - (optional) Whether or not to add an inline reply option to the notification. _macOS_
* `replyPlaceholder` String - (optional) The placeholder to write in the inline reply input field. _macOS_ * `replyPlaceholder` String - (optional) The placeholder to write in the inline reply input field. _macOS_
* `actions` [NotificationAction[]](structures/notification-action.md) - Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_ * `actions` [NotificationAction[]](structures/notification-action.md) - (optional) Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_
### Instance Events ### Instance Events