Notifications should be in Modules/notifications
[WebKit-https.git] / Source / WebCore / Modules / notifications / Notification.idl
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2011, 2012 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 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
39         Constructor(in DOMString title, in [Optional=DefaultIsUndefined] Dictionary options),
40         CallWith=ScriptExecutionContext,
41 #else
42         OmitConstructor
43 #endif
44     ] Notification {
45         void show();
46 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
47         void cancel();
48 #endif
49 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
50         void close();
51 #endif
52
53
54 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
55         [CallWith=ScriptExecutionContext] static DOMString permissionLevel();
56         [Custom] static void requestPermission(in NotificationPermissionCallback callback);
57 #endif
58
59         attribute EventListener onshow;
60 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
61         attribute EventListener ondisplay;
62 #endif
63         attribute EventListener onerror;
64         attribute EventListener onclose;
65         attribute EventListener onclick;
66
67         attribute DOMString dir;
68 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
69         attribute DOMString replaceId;
70 #endif
71 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
72         attribute DOMString tag;
73 #endif
74
75         // EventTarget interface
76         void addEventListener(in DOMString type, 
77                               in EventListener listener, 
78                               in [Optional] boolean useCapture);
79         void removeEventListener(in DOMString type, 
80                                  in EventListener listener, 
81                                  in [Optional] boolean useCapture);
82         boolean dispatchEvent(in Event evt)
83             raises(EventException);
84     };
85
86 }