6b0e14021699911adbc15898e6566225b307fcf3
[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 [
33     Conditional=NOTIFICATIONS|LEGACY_NOTIFICATIONS,
34     ActiveDOMObject,
35     EventTarget,
36 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
37     Constructor(DOMString title, [Default=Undefined] optional Dictionary options),
38     ConstructorCallWith=ScriptExecutionContext,
39 #endif
40 ] interface Notification {
41     void show();
42 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
43     void cancel();
44 #endif
45 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
46     void close();
47 #endif
48
49
50 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
51     [CallWith=ScriptExecutionContext] static readonly attribute DOMString permission;
52     [CallWith=ScriptExecutionContext] static void requestPermission(optional NotificationPermissionCallback callback);
53 #endif
54
55     attribute EventListener onshow;
56 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
57     attribute EventListener ondisplay;
58 #endif
59     attribute EventListener onerror;
60     attribute EventListener onclose;
61     attribute EventListener onclick;
62
63 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
64     attribute DOMString dir;
65     attribute DOMString replaceId;
66 #endif
67 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
68     attribute DOMString tag;
69 #endif
70
71     // EventTarget interface
72     void addEventListener(DOMString type, 
73                           EventListener listener, 
74                           optional boolean useCapture);
75     void removeEventListener(DOMString type, 
76                              EventListener listener, 
77                              optional boolean useCapture);
78     [RaisesException] boolean dispatchEvent(Event evt);
79 };
80