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

docs: clarify dock.bounce usage (#19894)

Browse source
This commit is contained in:
Shelley Vohr 2019-08-23 01:16:18 -07:00 • committed by Samuel Attard
parent 6a3922d330
commit c6a8b7f959
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api/dock.md
View file

@ -18,6 +18,8 @@ app.dock.bounce()
* `type` String (optional) - Can be `critical` or `informational`. The default is * `type` String (optional) - Can be `critical` or `informational`. The default is
`informational` `informational`
Returns `Integer` - an ID representing the request.
When `critical` is passed, the dock icon will bounce until either the When `critical` is passed, the dock icon will bounce until either the
application becomes active or the request is canceled. application becomes active or the request is canceled.
@ -25,7 +27,7 @@ When `informational` is passed, the dock icon will bounce for one second.
However, the request remains active until either the application becomes active However, the request remains active until either the application becomes active
or the request is canceled. or the request is canceled.
Returns `Integer` an ID representing the request. **Nota Bene:** This method can only be used while the app is not focused; when the app is focused it will return -1.
#### `dock.cancelBounce(id)` _macOS_ #### `dock.cancelBounce(id)` _macOS_