github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify dock.bounce usage (#20458)

Browse Source
This commit is contained in:
Shelley Vohr
2019-10-07 17:15:48 +02:00
committed by GitHub
parent 3176e323e4
commit 15e611a0ff
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/app.md
View File

@@ -1285,6 +1285,8 @@ you exactly what went wrong
* `type` String (optional) - Can be `critical` or `informational`. The default is
`informational`
Returns `Integer` an ID representing the request.
When `critical` is passed, the dock icon will bounce until either the
application becomes active or the request is canceled.
@@ -1292,7 +1294,7 @@ When `informational` is passed, the dock icon will bounce for one second.
However, the request remains active until either the application becomes active
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.
### `app.dock.cancelBounce(id)` _macOS_