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