From 1647c12c732faf56ab5ef33dae7f48ed4ad2c840 Mon Sep 17 00:00:00 2001 From: Felix Rieseberg Date: Sat, 16 Jun 2018 02:32:19 +0200 Subject: [PATCH] :memo: Make appUserModelId requirement clearer (#13259) --- docs/tutorial/notifications.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/tutorial/notifications.md b/docs/tutorial/notifications.md index b8c2c69168..f6144544a9 100644 --- a/docs/tutorial/notifications.md +++ b/docs/tutorial/notifications.md @@ -24,12 +24,20 @@ are subtle differences. ## Windows -* On Windows 10, notifications "just work". -* On Windows 8.1 and Windows 8, a shortcut to your app, with an [Application User -Model ID][app-user-model-id], must be installed to the Start screen. Note, +* On Windows 10, a shortcut to your app with an [Application User +Model ID][app-user-model-id] must be installed to the Start Menu. +* On Windows 8.1 and Windows 8, a shortcut to your app with an [Application User +Model ID][app-user-model-id] must be installed to the Start screen. Note, however, that it does not need to be pinned to the Start screen. * On Windows 7, notifications work via a custom implementation which visually - resembles the native one on newer systems. +resembles the native one on newer systems. + +Electron attempts to automate the work around the Application User Model ID. When +Electron is used together with the installation and update framework Squirrel, +[shortcuts will automatically be set correctly][squirrel-events]. Furthermore, +Electron will detect that Squirrel was used and will automatically call +`app.setAppUserModelId()` with the correct value. During development, you may have +to call [`app.setAppUserModelId()`][[set-app-user-model-id]] yourself. Furthermore, in Windows 8, the maximum length for the notification body is 250 characters, with the Windows team recommending that notifications should be kept @@ -88,3 +96,5 @@ GNOME, KDE. [notification-spec]: https://developer.gnome.org/notification-spec/ [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx +[set-app-user-model-id]: ../api/app.md#appsetappusermodelidid-windows +[squirrel-events]: https://github.com/electron/windows-installer/blob/master/README.md#handling-squirrel-events \ No newline at end of file