Source/WebCore/dom/MessageEvent.idl

   1 /*
   2  * Copyright (C) 2007 Henry Mason <hmason@mac.com>
   3  * Copyright (C) 2011 Google Inc. All rights reserved.
   4  * Copyright (C) 2016 Apple Inc. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  */
  28
  29 #if defined(ENABLE_SERVICE_WORKER) && ENABLE_SERVICE_WORKER
  30 typedef (WindowProxy or MessagePort or ServiceWorker) MessageEventSource;
  31 #else
  32 typedef (WindowProxy or MessagePort) MessageEventSource;
  33 #endif
  34
  35 [
  36     Constructor(DOMString type, optional MessageEventInit eventInitDict),
  37     Exposed=(Window,Worker),
  38     JSCustomMarkFunction,
  39 ] interface MessageEvent : Event {
  40     readonly attribute USVString origin;
  41     readonly attribute DOMString lastEventId;
  42     readonly attribute MessageEventSource? source;
  43     [CustomGetter] readonly attribute any data;
  44     readonly attribute FrozenArray<MessagePort> ports;
  45
  46     void initMessageEvent(DOMString type, optional boolean bubbles = false, optional boolean cancelable = false,
  47         optional any data = null, optional USVString originArg = "", optional DOMString lastEventId = "", optional MessageEventSource? source = null,
  48         optional sequence<MessagePort> messagePorts = []);
  49 };
  50
  51 dictionary MessageEventInit : EventInit {
  52     any data = null;
  53     USVString origin = "";
  54     DOMString lastEventId = "";
  55     MessageEventSource? source = null;
  56     sequence<MessagePort> ports = [];
  57 };