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

Add string to notification doc

Browse source 
Tiny fix: The docs suggest `NativeImage` for `icon`, but a string is also allowed.
This commit is contained in:
Felix Rieseberg 2017-09-25 14:02:59 -07:00 committed by GitHub
parent c33c21e174
commit ff97817668
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/notification.md
View file

@ -34,7 +34,7 @@ Returns `Boolean` - Whether or not desktop notifications are supported on the cu
* `subtitle` String - (optional) 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` (String | [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_
* `sound` String - (optional) The name of the sound file to play when the notification is shown. _macOS_ * `sound` String - (optional) The name of the sound file to play when the notification is shown. _macOS_