blob: c90129d57c2fccd7f94181d28b01f530d5ca60e3 [file] [log] [blame]
// Copyright 2015 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.
#include <stdint.h>
#include <vector>
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/notification_database_data.h"
class GURL;
namespace content {
// Represents the storage context for persistent Web Notifications, specific to
// the storage partition owning the instance. All methods defined in this
// interface may only be used on the IO thread.
class PlatformNotificationContext
: public base::RefCountedThreadSafe<PlatformNotificationContext,
BrowserThread::DeleteOnUIThread> {
using ReadResultCallback =
base::Callback<void(bool /* success */,
const NotificationDatabaseData&)>;
using ReadAllResultCallback =
base::Callback<void(bool /* success */,
const std::vector<NotificationDatabaseData>&)>;
using WriteResultCallback =
base::Callback<void(bool /* success */,
const std::string& /* notification_id */)>;
using DeleteResultCallback = base::Callback<void(bool /* success */)>;
// Reasons for updating a notification, triggering a read.
enum class Interaction {
// No interaction was taken with the notification.
// An action button in the notification was clicked.
// The notification itself was clicked.
// The notification was closed.
// Reads the data associated with |notification_id| belonging to |origin|
// from the database. |callback| will be invoked with the success status
// and a reference to the notification database data when completed.
// |interaction| is passed in for UKM logging purposes and does not
// otherwise affect the read.
virtual void ReadNotificationDataAndRecordInteraction(
const std::string& notification_id,
const GURL& origin,
Interaction interaction,
const ReadResultCallback& callback) = 0;
// Reads all data associated with |service_worker_registration_id| belonging
// to |origin| from the database. |callback| will be invoked with the success
// status and a vector with all read notification data when completed.
virtual void ReadAllNotificationDataForServiceWorkerRegistration(
const GURL& origin,
int64_t service_worker_registration_id,
const ReadAllResultCallback& callback) = 0;
// Writes the data associated with a notification to a database. When this
// action completed, |callback| will be invoked with the success status and
// the notification id when written successfully. The notification ID field
// for |database_data| will be generated, and thus must be empty.
virtual void WriteNotificationData(
int64_t persistent_notification_id,
int64_t service_worker_registration_id,
const GURL& origin,
const NotificationDatabaseData& database_data,
const WriteResultCallback& callback) = 0;
// Deletes all data associated with |notification_id| belonging to |origin|
// from the database. |callback| will be invoked with the success status
// when the operation has completed.
virtual void DeleteNotificationData(const std::string& notification_id,
const GURL& origin,
const DeleteResultCallback& callback) = 0;
friend class base::DeleteHelper<PlatformNotificationContext>;
friend struct BrowserThread::DeleteOnThread<BrowserThread::UI>;
virtual ~PlatformNotificationContext() {}
} // namespace content