Source/WebCore/notifications/NotificationPresenter.h

   1 /*
   2  * Copyright (C) 2009 Google Inc. All rights reserved.
   3  * Copyright (C) 2011 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 #ifndef NotificationPresenter_h
  33 #define NotificationPresenter_h
  34
  35 #include <wtf/PassRefPtr.h>
  36 #include "VoidCallback.h"
  37
  38 namespace WebCore {
  39
  40 class Document;
  41 class Notification;
  42 class KURL;
  43 class ScriptExecutionContext;
  44
  45 class NotificationPresenter {
  46
  47 public:
  48     enum Permission {
  49         PermissionAllowed, // User has allowed notifications
  50         PermissionNotAllowed, // User has not yet allowed
  51         PermissionDenied // User has explicitly denied permission
  52     };
  53
  54     // Requests that a notification be shown.
  55     virtual bool show(Notification*) = 0;
  56
  57     // Requests that a notification that has already been shown be canceled.
  58     virtual void cancel(Notification*) = 0;
  59
  60     // Informs the presenter that a Notification object has been destroyed
  61     // (such as by a page transition). The presenter may continue showing
  62     // the notification, but must not attempt to call the event handlers.
  63     virtual void notificationObjectDestroyed(Notification*) = 0;
  64
  65     // Requests user permission to show desktop notifications from a particular
  66     // script context. The callback parameter should be run when the user has
  67     // made a decision.
  68     virtual void requestPermission(ScriptExecutionContext*, PassRefPtr<VoidCallback>) = 0;
  69
  70     // Cancel all outstanding requests for the ScriptExecutionContext
  71     virtual void cancelRequestsForPermission(ScriptExecutionContext*) = 0;
  72
  73     // Checks the current level of permission.
  74     virtual Permission checkPermission(ScriptExecutionContext*) = 0;
  75
  76 protected:
  77     virtual ~NotificationPresenter() { }
  78 };
  79
  80 } // namespace WebCore
  81
  82 #endif // NotificationPresenter_h