Browse Source

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

Closes #16852
Samuel Attard 6 years ago
parent
commit
90ebd8eb12
1 changed files with 5 additions and 0 deletions
  1. 5 0
      docs/api/app.md

+ 5 - 0
docs/api/app.md

@@ -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.
 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.
 
 ### `app.removeAsDefaultProtocolClient(protocol[, path, args])` _macOS_ _Windows_