1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Mozilla Foundation.
19 * Portions created by the Initial Developer are Copyright (C) 2007
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Jeff Walden <jwalden+code@mit.edu> (original author)
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either of the GNU General Public License Version 2 or later (the "GPL"),
27 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsIDOMEvent.idl"
40
41 /**
42 * The nsIDOMMessageEvent interface is used for server-sent events and for
43 * cross-domain messaging.
44 *
45 * For more information on this interface, please see
46 * http://www.whatwg.org/specs/web-apps/current-work/#messageevent
47 */
48 [scriptable, uuid(98150805-6A15-4667-815A-1A8C87CB4BBC)]
49 interface nsIDOMMessageEvent : nsIDOMEvent
50 {
51 /**
52 * Custom string data associated with this event.
53 */
54 readonly attribute DOMString data;
55
56 /**
57 * The origin of the site from which this event originated, which is the
58 * scheme, ":", and if the URI has a host, "//" followed by the
59 * host, and if the port is not the default for the given scheme,
60 * ":" followed by that port. This value does not have a trailing slash.
61 */
62 readonly attribute DOMString origin;
63
64 /**
65 * The last event ID string of the event source, for server-sent DOM events; this
66 * value is the empty string for cross-origin messaging.
67 */
68 readonly attribute DOMString lastEventId;
69
70 /**
71 * The window which originated this event.
72 */
73 readonly attribute nsIDOMWindow source;
74
75 /**
76 * Initializes this event with the given data, in a manner analogous to
77 * the similarly-named method on the nsIDOMEvent interface, also setting the
78 * data, origin, source, and lastEventId attributes of this appropriately.
79 */
80 void initMessageEvent(in DOMString aType,
81 in boolean aCanBubble,
82 in boolean aCancelable,
83 in DOMString aData,
84 in DOMString aOrigin,
85 in DOMString aLastEventId,
86 in nsIDOMWindow aSource);
87
88 /**
89 * Initializes this event with the given data, in a manner analogous to
90 * the similarly-named method on the Event interface, also setting the data,
91 * origin, source, and lastEventId attributes of this appropriately.
92 */
93 void initMessageEventNS(in DOMString aNamespaceURI,
94 in DOMString aType,
95 in boolean aCanBubble,
96 in boolean aCancelable,
97 in DOMString aData,
98 in DOMString aOrigin,
99 in DOMString aLastEventId,
100 in nsIDOMWindow aSource);
101 };