Notification.requestPermission callback should be optional
[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(in DOMString title, in [Optional=DefaultIsUndefined] Dictionary options),
38     CallWith=ScriptExecutionContext,
39 #else
40     OmitConstructor
41 #endif
42 ] interface Notification {
43     void show();
44 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
45     void cancel();
46 #endif
47 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
48     void close();
49 #endif
50
51
52 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
53     static readonly attribute [CallWith=ScriptExecutionContext] DOMString permission;
54     [CallWith=ScriptExecutionContext] static void requestPermission(in [Optional, Callback] NotificationPermissionCallback callback);
55 #endif
56
57     attribute EventListener onshow;
58 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
59     attribute EventListener ondisplay;
60 #endif
61     attribute EventListener onerror;
62     attribute EventListener onclose;
63     attribute EventListener onclick;
64
65 #if defined(ENABLE_LEGACY_NOTIFICATIONS) && ENABLE_LEGACY_NOTIFICATIONS
66     attribute DOMString dir;
67     attribute DOMString replaceId;
68 #endif
69 #if defined(ENABLE_NOTIFICATIONS) && ENABLE_NOTIFICATIONS
70     attribute DOMString tag;
71 #endif
72
73     // EventTarget interface
74     void addEventListener(in DOMString type, 
75                           in EventListener listener, 
76                           in [Optional] boolean useCapture);
77     void removeEventListener(in DOMString type, 
78                              in EventListener listener, 
79                              in [Optional] boolean useCapture);
80     boolean dispatchEvent(in Event evt)
81         raises(EventException);
82 };
83