File: nsINotificationHandler.idl

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (36 lines) | stat: -rw-r--r-- 1,400 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/* -*- 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 "nsISupports.idl"

interface nsIPrincipal;

[scriptable, uuid(55051271-52a2-48c6-9a47-2aff6baf1d7b)]
interface nsINotificationHandler : nsISupports
{
  /**
   * Either ping the service worker corresponding to the notification, or open
   * a new window if none is found.
   *
   * The principal and notification ID must match the values stored in DB to
   * call the service worker, otherwise it'll behave as if none is found.
   *
   * @param aPrincipal The principal that this notification is for.
   * @param aNotificationID The ID for the notification.
   *        Corresponding to `nsINotificationStorageEntry.id` and
   *        `nsIAlertNotification.id`.
   * @param aActionName The notification action in case the action button is
   *        clicked.
   * @param aAutoClosed Whether the notification is auto-closed by system after
   *        a click, e.g. on Windows. Checking this will remove the
   *        notification from the DB.
   */
  Promise respondOnClick(
    in nsIPrincipal aPrincipal,
    in AString aNotificationId,
    in AString aActionName,
    in boolean aAutoClosed
  );
};