Skip to content

Commit bb222ef

Browse files
trop[bot]codebytere
authored andcommitted
docs: clarify dock.bounce usage (electron#20460)
1 parent 945d025 commit bb222ef

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/api/app.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1252,14 +1252,16 @@ you exactly what went wrong
12521252
* `type` String (optional) - Can be `critical` or `informational`. The default is
12531253
`informational`
12541254

1255+
Returns `Integer` an ID representing the request.
1256+
12551257
When `critical` is passed, the dock icon will bounce until either the
12561258
application becomes active or the request is canceled.
12571259

12581260
When `informational` is passed, the dock icon will bounce for one second.
12591261
However, the request remains active until either the application becomes active
12601262
or the request is canceled.
12611263

1262-
Returns `Integer` an ID representing the request.
1264+
**Nota Bene:** This method can only be used while the app is not focused; when the app is focused it will return -1.
12631265

12641266
### `app.dock.cancelBounce(id)` _macOS_
12651267

0 commit comments

Comments
 (0)