summaryrefslogtreecommitdiffstats
path: root/dom/webidl/PresentationConnectionCloseEvent.webidl
blob: 69fce5514c141dd6a55f07b71b3199ea3a0c8233 (plain)
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
37
38
39
40
41
42
43
/* -*- 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-presentationconnectioncloseevent
 */

enum PresentationConnectionClosedReason
{
  // The communication encountered an unrecoverable error.
  "error",

  // |PresentationConnection.close()| is called by controlling browsing context
  // or the receiving browsing context.
  "closed",

  // The connection is closed because the destination browsing context
  // that owned the connection navigated or was discarded.
  "wentaway"
};

[Pref="dom.presentation.enabled",
 Exposed=Window]
interface PresentationConnectionCloseEvent : Event
{
  constructor(DOMString type,
              PresentationConnectionCloseEventInit eventInitDict);

  readonly attribute PresentationConnectionClosedReason reason;

  // The message is a human readable description of
  // how the communication channel encountered an error.
  // It is empty when the closed reason is closed or wentaway.
  readonly attribute DOMString message;
};

dictionary PresentationConnectionCloseEventInit : EventInit
{
  required PresentationConnectionClosedReason reason;
  DOMString message = "";
};