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

docs: document how setAsDefaultProtocolClient works in Windows Store (#16874)

Browse source 
Closes #16852
This commit is contained in:
Samuel Attard 2019-02-11 10:51:46 -08:00 • committed by GitHub
commit 90ebd8eb12
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/api/app.md
View file

@ -725,6 +725,11 @@ 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.
Please refer to [Apple's documentation][CFBundleURLTypes] for details. Please refer to [Apple's documentation][CFBundleURLTypes] for details.
**Note:** In a Windows Store environment (when packaged as an `appx`) this API
will return `true` for all calls but the registry key it sets won't be accessible
by other applications. In order to register your Windows Store application
as a default protocol handler you must [declare the protocol in your manifest](https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-protocol).
The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally. The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally.
### `app.removeAsDefaultProtocolClient(protocol[, path, args])` _macOS_ _Windows_ ### `app.removeAsDefaultProtocolClient(protocol[, path, args])` _macOS_ _Windows_