gecko-dev/dom/webidl/PresentationRequest.webidl
Boris Zbarsky e5497b955e Bug 1423562 part 3. Remove [PrimaryGlobal] and require explicit [Exposed] annotations on everything. r=edgar
For review purposes, the important changes are in dom/bindings/Configuration.py
and dom/bindings/parser.

The changes to the IDL files were done by running these in dom/webidl
and dom/bindings/test:

  perl -pi -e 's/^interface ([A-Za-z0-9_]+)($| [:{])/[Exposed=Window]\ninterface \1\2/' *.webidl

  perl -pi -e 'BEGIN { $/ = undef; } s/\[HTMLConstructor\]\n\[Exposed=Window\]/[HTMLConstructor,\n Exposed=Window]/g' *.webidl

  perl -pi -e 'BEGIN { $/ = undef; } s/\[NoInterfaceObject\]\n\[Exposed=Window\]/[NoInterfaceObject,\n Exposed=Window]/g' *.webidl

  perl -pi -e 'BEGIN { $/ = undef; } s/\[ChromeOnly\]\n\[Exposed=Window\]/[ChromeOnly,\n Exposed=Window]/g' *.webidl

And running this in dom/chrome-webidl:

  perl -pi -e 'BEGIN { $/ = undef; } s/\[ChromeOnly\]\ninterface/[ChromeOnly, Exposed=Window]\ninterface/g' *.webidl

and then fixing all the resulting parser failures.  I then verified that the
generated code is the same as before this change.

Differential Revision: https://phabricator.services.mozilla.com/D46697

--HG--
extra : moz-landing-system : lando
2019-09-27 15:26:14 +00:00

91 lines
3.6 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/presentation-api/#interface-presentationrequest
*/
[Pref="dom.presentation.controller.enabled",
Exposed=Window]
interface PresentationRequest : EventTarget {
[Throws]
constructor(DOMString url);
[Throws]
constructor(sequence<DOMString> urls);
/*
* A requesting page use start() to start a new connection, and it will be
* returned with the promise. UA may show a prompt box with a list of
* available devices and ask the user to grant permission, choose a device, or
* cancel the operation.
*
* The promise is resolved when the presenting page is successfully loaded and
* the communication channel is established, i.e., the connection state is
* "connected".
*
* The promise may be rejected duo to one of the following reasons:
* - "OperationError": Unexpected error occurs.
* - "NotFoundError": No available device.
* - "AbortError": User dismiss/cancel the device prompt box.
* - "NetworkError": Failed to establish the control channel or data channel.
* - "TimeoutError": Presenting page takes too long to load.
* - "SecurityError": This operation is insecure.
*/
[Throws]
Promise<PresentationConnection> start();
/*
* A requesting page can use reconnect(presentationId) to reopen a
* non-terminated presentation connection.
*
* The promise is resolved when a new presentation connection is created.
* The connection state is "connecting".
*
* The promise may be rejected duo to one of the following reasons:
* - "OperationError": Unexpected error occurs.
* - "NotFoundError": Can not find a presentation connection with the presentationId.
* - "SecurityError": This operation is insecure.
*/
[Throws]
Promise<PresentationConnection> reconnect(DOMString presentationId);
/*
* UA triggers device discovery mechanism periodically and monitor device
* availability.
*
* The promise may be rejected duo to one of the following reasons:
* - "NotSupportedError": Unable to continuously monitor the availability.
* - "SecurityError": This operation is insecure.
*/
[Throws]
Promise<PresentationAvailability> getAvailability();
/*
* It is called when a connection associated with a PresentationRequest is created.
* The event is fired for all connections that are created for the controller.
*/
attribute EventHandler onconnectionavailable;
/*
* A chrome page, or page which has presentation-device-manage permissiongs,
* uses startWithDevice() to start a new connection with specified device,
* and it will be returned with the promise. UA may show a prompt box with a
* list of available devices and ask the user to grant permission, choose a
* device, or cancel the operation.
*
* The promise is resolved when the presenting page is successfully loaded and
* the communication channel is established, i.e., the connection state is
* "connected".
*
* The promise may be rejected duo to one of the following reasons:
* - "OperationError": Unexpected error occurs.
* - "NotFoundError": No available device.
* - "NetworkError": Failed to establish the control channel or data channel.
* - "TimeoutError": Presenting page takes too long to load.
*/
[ChromeOnly, Throws]
Promise<PresentationConnection> startWithDevice(DOMString deviceId);
};