blob: 9da6936079142501dc8155c8a34625c62ab34692 [file] [log] [blame]
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_DISPLAY_SERVICE_H_
#define CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_DISPLAY_SERVICE_H_
#include <map>
#include <memory>
#include <set>
#include <string>
#include "base/callback_forward.h"
#include "base/macros.h"
#include "chrome/browser/notifications/notification_common.h"
#include "chrome/browser/notifications/notification_handler.h"
#include "components/keyed_service/core/keyed_service.h"
class Profile;
namespace message_center {
class Notification;
}
// Profile-bound service that enables user-visible notifications to be displayed
// and managed. Notifications may either be presented using a notification
// center provided by the platform, or by Chrome's Message Center.
class NotificationDisplayService : public KeyedService {
public:
~NotificationDisplayService() override;
// Callback to be used with the GetDisplayed() method. Includes the set of
// notification ids that is being displayed to the user. The
// |supports_synchronization| callback indicates whether the platform has the
// ability to query which notifications are still being displayed.
//
// TODO(peter): Rename |supports_synchronization| to |supported|.
// TODO(peter): Change this to be a base::OnceCallback, remove use of the
// std::unique_ptr<> in favor of move semantics.
using DisplayedNotificationsCallback =
base::Callback<void(std::unique_ptr<std::set<std::string>>,
bool /* supports_synchronization */)>;
// Returns an instance of the display service for the given |profile|.
static NotificationDisplayService* GetForProfile(Profile* profile);
// Returns the NDS for system notifications which aren't tied to a particular
// user. Currently only implemented on Chrome OS. TODO(estade): implement
// elsewhere as needed.
static NotificationDisplayService* GetForSystemNotifications();
// Displays the |notification| of type |notification_type|. The |metadata|
// may be provided for certain notification types that require additional
// information for the notification to be displayed.
virtual void Display(
NotificationHandler::Type notification_type,
const message_center::Notification& notification,
std::unique_ptr<NotificationCommon::Metadata> metadata = nullptr) = 0;
// Closes the notification having |notification_id| of |notification_type|.
virtual void Close(NotificationHandler::Type notification_type,
const std::string& notification_id) = 0;
// Gets the IDs of currently displaying notifications and invokes |callback|
// once available. Not all backends support retrieving this information.
virtual void GetDisplayed(const DisplayedNotificationsCallback& callback) = 0;
protected:
NotificationDisplayService() = default;
private:
DISALLOW_COPY_AND_ASSIGN(NotificationDisplayService);
};
#endif // CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_DISPLAY_SERVICE_H_