b03dfd92a19a8a44c283ce361ec2ff999b65f564
[WebKit-https.git] / Source / WebCore / Modules / notifications / NotificationClient.h
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 #pragma once
33
34 #include <wtf/Forward.h>
35
36 namespace WebCore {
37
38 class Notification;
39 class NotificationPermissionCallback;
40 class Page;
41 class ScriptExecutionContext;
42 class VoidCallback;
43
44 class NotificationClient {
45 public:
46     enum Permission {
47         PermissionAllowed, // User has allowed notifications
48         PermissionNotAllowed, // User has not yet allowed
49         PermissionDenied // User has explicitly denied permission
50     };
51
52     // Requests that a notification be shown.
53     virtual bool show(Notification*) = 0;
54
55     // Requests that a notification that has already been shown be canceled.
56     virtual void cancel(Notification*) = 0;
57
58     // When the user closes a page, or quits the client application, all of the page's
59     // associated notifications are cleared.
60     virtual void clearNotifications(ScriptExecutionContext*) { }
61     
62     // Informs the presenter that a Notification object has been destroyed
63     // (such as by a page transition). The presenter may continue showing
64     // the notification, but must not attempt to call the event handlers.
65     virtual void notificationObjectDestroyed(Notification*) = 0;
66
67     // Informs the presenter the controller attached to the page has been destroyed.
68     virtual void notificationControllerDestroyed() = 0;
69
70     // Requests user permission to show desktop notifications from a particular
71     // script context. The callback parameter should be run when the user has
72     // made a decision.
73 #if ENABLE(LEGACY_NOTIFICATIONS)
74     virtual void requestPermission(ScriptExecutionContext*, RefPtr<VoidCallback>&&) = 0;
75 #endif
76 #if ENABLE(NOTIFICATIONS)
77     virtual void requestPermission(ScriptExecutionContext*, RefPtr<NotificationPermissionCallback>&&) = 0;
78 #endif
79
80     virtual bool hasPendingPermissionRequests(ScriptExecutionContext*) const = 0;
81
82     // Cancel all outstanding requests for the ScriptExecutionContext
83     virtual void cancelRequestsForPermission(ScriptExecutionContext*) = 0;
84
85     // Checks the current level of permission.
86     virtual Permission checkPermission(ScriptExecutionContext*) = 0;
87
88 protected:
89     virtual ~NotificationClient() { }
90 };
91
92 WEBCORE_EXPORT void provideNotification(Page*, NotificationClient*);
93
94 } // namespace WebCore