From 7d97605469c399ab0eed8a378d255e4603e08b13 Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Thu, 22 Aug 2019 12:00:41 -0700 Subject: [PATCH] docs: clarify dock.bounce usage --- docs/api/dock.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/dock.md b/docs/api/dock.md index df2c53e5dab63..2f1b12bff9d16 100644 --- a/docs/api/dock.md +++ b/docs/api/dock.md @@ -18,6 +18,8 @@ app.dock.bounce() * `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. @@ -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 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_