Home | History | Annotate | Download | only in notifications
      1 /*
      2  * Copyright (C) 2009 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef NotificationPresenter_h
     32 #define NotificationPresenter_h
     33 
     34 #include <wtf/PassRefPtr.h>
     35 #include "VoidCallback.h"
     36 
     37 #if ENABLE(NOTIFICATIONS)
     38 
     39 namespace WebCore {
     40 
     41     class Document;
     42     class Notification;
     43     class KURL;
     44     class SecurityOrigin;
     45     class String;
     46 
     47     class NotificationPresenter {
     48 
     49     public:
     50         enum Permission {
     51             PermissionAllowed, // User has allowed notifications
     52             PermissionNotAllowed, // User has not yet allowed
     53             PermissionDenied // User has explicitly denied permission
     54         };
     55 
     56         virtual ~NotificationPresenter() {}
     57 
     58         // Requests that a notification be shown.
     59         virtual bool show(Notification*) = 0;
     60 
     61         // Requests that a notification that has already been shown be canceled.
     62         virtual void cancel(Notification*) = 0;
     63 
     64         // Informs the presenter that a Notification object has been destroyed
     65         // (such as by a page transition).  The presenter may continue showing
     66         // the notification, but must not attempt to call the event handlers.
     67         virtual void notificationObjectDestroyed(Notification*) = 0;
     68 
     69         // Requests user permission to show desktop notifications from a particular
     70         // origin. The callback parameter should be run when the user has
     71         // made a decision.
     72         virtual void requestPermission(SecurityOrigin*, PassRefPtr<VoidCallback>) = 0;
     73 
     74         // Checks the current level of permission for the specified URL. If the
     75         // URL is a document (as opposed to a worker or other ScriptExecutionContext),
     76         // |document| will also be provided.
     77         virtual Permission checkPermission(const KURL&, Document*) = 0;
     78     };
     79 
     80 } // namespace WebCore
     81 
     82 #endif // ENABLE(NOTIFICATIONS)
     83 
     84 #endif // NotificationPresenter_h
     85