e6dd25a1fa742bf376122186c0744f5411b8c3cf
[WebKit-https.git] / Source / WebCore / notifications / Notification.idl
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2011 Apple 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 are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 module threads {
33
34     interface [
35         Conditional=NOTIFICATIONS|LEGACY_NOTIFICATIONS,
36         ActiveDOMObject,
37         EventTarget,
38         OmitConstructor
39     ] Notification {
40         void show();
41         void cancel();
42
43         attribute EventListener onshow;
44         // FIXME: The latest Web Notifications standard uses the onshow event listener.
45         // The ondisplay event listener should be removed when implementations change the event listener to onshow.
46         attribute EventListener ondisplay;
47         attribute EventListener onerror;
48         attribute EventListener onclose;
49         attribute EventListener onclick;
50
51         attribute DOMString dir;
52         attribute DOMString replaceId;
53
54         // EventTarget interface
55         void addEventListener(in DOMString type, 
56                               in EventListener listener, 
57                               in [Optional] boolean useCapture);
58         void removeEventListener(in DOMString type, 
59                                  in EventListener listener, 
60                                  in [Optional] boolean useCapture);
61         boolean dispatchEvent(in Event evt)
62             raises(EventException);
63     };
64
65 }