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

Document boolean return value of app.setAsDefaultProtocolClient + app.removeAsDefaultProtocolClient

Browse source
This commit is contained in:
Milan Burda 2016-08-08 02:26:27 +02:00
parent a0cf013112
commit e84c82b4a7
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api/app.md
View file

@ -460,6 +460,8 @@ system. Once registered, all links with `your-protocol://` will be opened with
the current executable. The whole link, including protocol, will be passed to the current executable. The whole link, including protocol, will be passed to
your application as a parameter. your application as a parameter.
Returns `true` when the call succeeded, otherwise returns `false`.
**Note:** On macOS, you can only register protocols that have been added to **Note:** On macOS, you can only register protocols that have been added to
your app's `info.plist`, which can not be modified at runtime. You can however your app's `info.plist`, which can not be modified at runtime. You can however
change the file with a simple text editor or script during build time. change the file with a simple text editor or script during build time.
@ -474,6 +476,8 @@ The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally
This method checks if the current executable as the default handler for a This method checks if the current executable as the default handler for a
protocol (aka URI scheme). If so, it will remove the app as the default handler. protocol (aka URI scheme). If so, it will remove the app as the default handler.
Returns `true` when the call succeeded, otherwise returns `false`.
### `app.isDefaultProtocolClient(protocol)` _macOS_ _Windows_ ### `app.isDefaultProtocolClient(protocol)` _macOS_ _Windows_
* `protocol` String - The name of your protocol, without `://`. * `protocol` String - The name of your protocol, without `://`.