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

Update shell openExternal docs (from review)

Browse source
This commit is contained in:
Gabriel Handford 2016-10-14 12:34:22 -07:00 • committed by Cheng Zhao
parent 9ca684d87f
commit c78567aba6
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api/shell.md
View file

@ -40,9 +40,11 @@ Open the given file in the desktop's default manner.
* `options` Object (optional) _macOS_ * `options` Object (optional) _macOS_
* `activate` Boolean - `true` to bring the opened application to the * `activate` Boolean - `true` to bring the opened application to the
foreground. The default is `true`. foreground. The default is `true`.
* `callback` Function (optional) _macOS_ * `callback` Function (optional) - If specified will perform the open asynchronously. _macOS_
* `opened` Boolean
Returns `Boolean` - Whether an application was available to open the URL. Returns `Boolean` - Whether an application was available to open the URL.
If callback is specified, it will return whether it was able to initiate the open call.
Open the given external protocol URL in the desktop's default manner. (For Open the given external protocol URL in the desktop's default manner. (For
example, mailto: URLs in the user's default mail agent). example, mailto: URLs in the user's default mail agent).