gecko-dev/dom/webidl/PushManager.webidl
Nikhil Marathe 33f71bcea2 Bug 1197998 - Use counters for Push subscribe, unsubscribe and permission query. r=froydnj,kitcambridge,jst
Counters do not currently work on Web Workers, so it a no-op on non main thread.

--HG--
extra : commitid : 27kBY7qMP1n
extra : rebase_source : 9b300637a335662e8bff1b522271d947aa6b51eb
extra : amend_source : a26e654021a325b800b94e72ae4327788ee93b05
2015-09-03 17:54:59 -07:00

44 lines
1.4 KiB
Plaintext

/* -*- 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/
*/
// Please see comments in dom/push/PushManager.h for the split between
// PushManagerImpl and PushManager.
[JSImplementation="@mozilla.org/push/PushManager;1",
NoInterfaceObject]
interface PushManagerImpl {
Promise<PushSubscription> subscribe();
Promise<PushSubscription?> getSubscription();
Promise<PushPermissionState> permissionState();
// We need a setter in the bindings so that the C++ can use it,
// but we don't want it exposed to client JS. WebPushMethodHider
// always returns false.
[Func="ServiceWorkerRegistration::WebPushMethodHider"] void setScope(DOMString scope);
};
[Exposed=(Window,Worker), Func="nsContentUtils::PushEnabled"]
interface PushManager {
[ChromeOnly, Throws, Exposed=Window]
void setPushManagerImpl(PushManagerImpl store);
[Throws, UseCounter]
Promise<PushSubscription> subscribe();
[Throws]
Promise<PushSubscription?> getSubscription();
[Throws]
Promise<PushPermissionState> permissionState();
};
enum PushPermissionState
{
"granted",
"denied",
"prompt"
};