From 964c88a1891ab59eb5bbcc73c8e4a230b8bbe158 Mon Sep 17 00:00:00 2001 From: Ben Gotow Date: Mon, 21 Nov 2016 16:55:18 -0800 Subject: [PATCH] Update open-url docs to mention NSPrincipalClass We got bit by a nasty bug today - if you change your app's info.plist `NSPrincipalClass` to something other to `AtomApplication` (We set it to NylasApplication via a bad find-replace), everything works except open-url is never fired. Add a small reference to the docs so folks know to check this key. --- docs/api/app.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index ae4685a5a3..fd296dac77 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -108,8 +108,9 @@ Returns: * `event` Event * `url` String -Emitted when the user wants to open a URL with the application. The URL scheme -must be registered to be opened by your application. +Emitted when the user wants to open a URL with the application. Your application's +Info.plist file must define the url scheme within the `CFBundleURLTypes` key, and +set `NSPrincipalClass` to `AtomApplication`. You should call `event.preventDefault()` if you want to handle this event.