toolkit/components/alerts/nsIWindowsAlertsService.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsIAlertsService.idl"
   7
   8 [scriptable, uuid(a46c385b-a45c-4b48-ab7c-aaed1252bb83)]
   9 interface nsIWindowsAlertNotification : nsIAlertNotification
  10 {
  11   /**
  12    * Boolean to signal that notification button actions will be handled, and the
  13    * resulting action should be communicated back on clicks through the
  14    * `aData` field.
  15    */
  16   attribute boolean handleActions;
  17
  18   /**
  19    * Image placements corresponding to placements in Windows Toast
  20    * Notification XML.
  21    */
  22   cenum ImagePlacement : 8 {
  23     eInline,
  24     eHero,
  25     eIcon,
  26   };
  27
  28   /**
  29    * Enum to specify image placement we want in the notification. n.b. in the
  30    * future we could extend this to instead allow multiple images in differing
  31    * placements in the same notification.
  32    */
  33   attribute nsIWindowsAlertNotification_ImagePlacement imagePlacement;
  34 };
  35
  36 [scriptable, uuid(e01c8066-fb4b-4304-b9c9-ab6ed4a8322c)]
  37 interface nsIWindowsAlertsService : nsIAlertsService
  38 {
  39   /**
  40    * If callbacks for the given Windows-specific tag string will be handled by
  41    * this Firefox process, set the associated event.
  42    *
  43    * @param {AString} aWindowsTag the tag
  44    * @return {Promise}
  45    * @resolves {Object}
  46    *           Resolves with an Object, may contain the following optional
  47    *           properties if notification exists but wasn't registered with
  48    *           the WindowsAlertsService:
  49    *
  50    *           `notificationData` {string} relaunch data, generally opaque to
  51    *           the Windows notification server DLL, for this relaunch.
  52    *
  53    * @rejects `nsresult` when there was an error retrieving the notification.
  54    */
  55   [implicit_jscontext]
  56   Promise handleWindowsTag(in AString aWindowsTag);
  57
  58   /**
  59    * Get the Windows-specific XML generated for the given alert.
  60    *
  61    * @note This method is intended for testing purposes.
  62    *
  63    * @param {nsIAlertNotification} aAlert the alert
  64    * @param {AString} an optional Windows tag; default is generated
  65    * @return {string} generated XML
  66    */
  67   AString getXmlStringForWindowsAlert(in nsIAlertNotification aAlert,
  68                                       [optional] in AString aWindowsTag);
  69
  70   /**
  71    * Removes all action center and snoozed notifications associated with this
  72    * install. Note that this removes all notifications regardless of which profile
  73    * they originated from.
  74    */
  75   void removeAllNotificationsForInstall();
  76 };