WebKit/chromium/public/WebNotificationPresenter.h
changeset 0 4f2f89ce4247
equal deleted inserted replaced
-1:000000000000 0:4f2f89ce4247
       
     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 WebNotificationPresenter_h
       
    32 #define WebNotificationPresenter_h
       
    33 
       
    34 #include "WebNotificationPermissionCallback.h"
       
    35 #include "WebSecurityOrigin.h"
       
    36 #include "WebString.h"
       
    37 
       
    38 namespace WebKit {
       
    39 
       
    40 class WebDocument;
       
    41 class WebNotification;
       
    42 class WebURL;
       
    43 
       
    44 // Provides the services to show desktop notifications to the user.
       
    45 class WebNotificationPresenter {
       
    46 public:
       
    47     enum Permission {
       
    48         PermissionAllowed,     // User has allowed permission to the origin.
       
    49         PermissionNotAllowed,  // User has not taken an action on the origin (defaults to not allowed).
       
    50         PermissionDenied       // User has explicitly denied permission from the origin.
       
    51     };
       
    52 
       
    53     // Shows a notification.
       
    54     virtual bool show(const WebNotification&) = 0;
       
    55 
       
    56     // Cancels a notification previously shown, and removes it if being shown.
       
    57     virtual void cancel(const WebNotification&) = 0;
       
    58 
       
    59     // Indiciates that the notification object subscribed to events for a previously shown notification is
       
    60     // being destroyed.  Does _not_ remove the notification if being shown, but detaches it from receiving events.
       
    61     virtual void objectDestroyed(const WebNotification&) = 0;
       
    62 
       
    63     // Checks the permission level for the given origin.
       
    64     virtual Permission checkPermission(const WebURL&) = 0;
       
    65 
       
    66     // Requests permission for a given origin.  This operation is asynchronous and the callback provided
       
    67     // will be invoked when the permission decision is made.  Callback pointer must remain
       
    68     // valid until called.
       
    69     virtual void requestPermission(const WebSecurityOrigin&, WebNotificationPermissionCallback*) = 0;
       
    70 };
       
    71 
       
    72 } // namespace WebKit
       
    73 
       
    74 #endif