dom/webidl/PushManager.webidl
author James Cheng <jacheng@mozilla.com>
Fri, 05 Aug 2016 13:23:44 -0400
changeset 308428 8ee6f2eb8b349a351f6f76585eb85e0ec2b5c475
parent 294381 6ce993bd6aec52d4cf9e0c9783418453c423fb27
child 341378 d0174f989cfd222d838f80d1572c1f40866e8f42
permissions -rw-r--r--
Bug 1291229 - Fix typo for moving Java bindings to mozilla::java namespace. r=jchen MozReview-Commit-ID: KGAS6EhnwAI

/* -*- 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/.
*
* The origin of this IDL file is
* https://w3c.github.io/push-api/
*/

dictionary PushSubscriptionOptionsInit {
  // boolean userVisibleOnly = false;
  BufferSource? applicationServerKey = null;
};

// The main thread JS implementation. Please see comments in
// dom/push/PushManager.h for the split between PushManagerImpl and PushManager.
[JSImplementation="@mozilla.org/push/PushManager;1",
 ChromeOnly, Constructor(DOMString scope)]
interface PushManagerImpl {
  Promise<PushSubscription>    subscribe(optional PushSubscriptionOptionsInit options);
  Promise<PushSubscription?>   getSubscription();
  Promise<PushPermissionState> permissionState(optional PushSubscriptionOptionsInit options);
};

[Exposed=(Window,Worker), Func="nsContentUtils::PushEnabled",
 ChromeConstructor(DOMString scope)]
interface PushManager {
  [Throws, UseCounter]
  Promise<PushSubscription>    subscribe(optional PushSubscriptionOptionsInit options);
  [Throws]
  Promise<PushSubscription?>   getSubscription();
  [Throws]
  Promise<PushPermissionState> permissionState(optional PushSubscriptionOptionsInit options);
};

enum PushPermissionState
{
    "granted",
    "denied",
    "prompt"
};