third_party/WebKit/Source/core/events/MessageEvent.idl

   1 /*
   2  * Copyright (C) 2007 Henry Mason <hmason@mac.com>
   3  * Copyright (C) 2011 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  */
  27
  28 // https://html.spec.whatwg.org/multipage/comms.html#the-messageevent-interfaces
  29
  30 [
  31     Constructor(DOMString type, optional MessageEventInit eventInitDict),
  32     Exposed=(Window,Worker),
  33     RaisesException=Constructor,
  34 ] interface MessageEvent : Event {
  35     [Custom=Getter] readonly attribute any data;
  36     readonly attribute DOMString origin;
  37     readonly attribute DOMString lastEventId;
  38     // TODO(bashi): |source| should be (WindowProxy or MessagePort)?
  39     readonly attribute EventTarget? source;
  40     readonly attribute MessagePort[]? ports;
  41
  42     // TODO(philipj): None of the initMessageEvent() arguments should be
  43     // optional, and |sourceArg| and |portsArg| are of the wrong type.
  44     [Custom, MeasureAs=InitMessageEvent] void initMessageEvent([Default=Undefined] optional DOMString typeArg,
  45                                    [Default=Undefined] optional boolean canBubbleArg,
  46                                    [Default=Undefined] optional boolean cancelableArg,
  47                                    [Default=Undefined] optional any dataArg,
  48                                    [Default=Undefined] optional DOMString originArg,
  49                                    [Default=Undefined] optional DOMString lastEventIdArg,
  50                                    [Default=Undefined] optional Window sourceArg,
  51                                    [Default=Undefined] optional MessagePort[] portsArg);
  52 };