gecko-dev/toolkit/components/alerts/nsIWindowsAlertsService.idl
Nicholas Rishel 8a411e49fa Bug 1797678 - Fix Windows native notifications interaction from prior Firefox instances and closed tabs. r=nalexander,Jamie,mossop
We need to ensure we're not in a `WndProc` callback context when interacting with native notification COM objects, which is currently a problem when called from the command line handler (see Bug 1805802). We achieve this by moving COM work onto a background task which defers processing until after `WndProc` returns.

Now that retrieving the fallback URL occurs on a background task waiting for it before returning would block the main thread. Making `handleWindowsTag` async introduced race conditions with commandline handling, requiring a `enterLastWindowClosingSurvivalArea`/`exitLastWindowClosingSurvivalArea` to prevent misbehavior in case early blank window is pref'd off. In order to simplify exit cleanup, the API was updated to return a `Promise`.

Differential Revision: https://phabricator.services.mozilla.com/D160458
2023-01-06 18:36:21 +00:00

69 lines
2.6 KiB
Text

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsIAlertsService.idl"
#include "nsISupports.idl"
#include "nsIObserver.idl"
[scriptable, function, uuid(059f8305-4e2f-4d31-a9cb-5b918ee84773)]
interface nsIUnknownWindowsTagListener : nsISupports
{
/**
* Handle any launch URL associated to the given Windows-specific tag string.
* Usually, this will navigate to the launch URL in some manner.
*
* @param {AString} aWindowsTag the tag
* @param {AString} aLaunchURL associated launch URL, or null.
* @param {AString} aPrivilegedName associated alert name if this is a chrome
* privileged alert, or null.
*/
void handleUnknownWindowsTag(in AString aWindowsTag,
in AString aLaunchURL,
in AString aPrivilegedName);
};
[scriptable, uuid(e01c8066-fb4b-4304-b9c9-ab6ed4a8322c)]
interface nsIWindowsAlertsService : nsIAlertsService
{
/**
* If callbacks for the given Windows-specific tag string will be handled by
* this Firefox process, set the associated event.
*
* @param {AString} aWindowsTag the tag
* @return {Promise}
* @resolves {Object}
* Resolves with an Object, may contain the following optional
* properties if notification exists but wasn't registered with
* the WindowsAlertService:
*
* `launchUrl` {string} a fallback URL to open.
*
* `privilegedName` {string} a privileged name assigned by the
* browser chrome.
*
* @rejects `nsresult` when there was an error retrieving the notification.
*/
[implicit_jscontext]
Promise handleWindowsTag(in AString aWindowsTag);
/**
* Get the Windows-specific XML generated for the given alert.
*
* @note This method is intended for testing purposes.
*
* @param {nsIAlertNotification} aAlert the alert
* @param {AString} an optional Windows tag; default is generated
* @return {string} generated XML
*/
AString getXmlStringForWindowsAlert(in nsIAlertNotification aAlert,
[optional] in AString aWindowsTag);
/**
* Removes all action center and snoozed notifications associated with this
* install. Note that this removes all notifications regardless of which profile
* they originated from.
*/
void removeAllNotificationsForInstall();
};