sync/notifier/sync_notifier_observer.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef SYNC_NOTIFIER_SYNC_NOTIFIER_OBSERVER_H_
   6 #define SYNC_NOTIFIER_SYNC_NOTIFIER_OBSERVER_H_
   7
   8 #include "sync/notifier/object_id_payload_map.h"
   9 #include "sync/notifier/notifications_disabled_reason.h"
  10
  11 namespace syncer {
  12
  13 enum IncomingNotificationSource {
  14   // The server is notifying us that one or more datatypes have stale data.
  15   REMOTE_NOTIFICATION,
  16   // A chrome datatype is requesting an optimistic refresh of its data.
  17   LOCAL_NOTIFICATION,
  18 };
  19
  20 class SyncNotifierObserver {
  21  public:
  22   // Called when notifications are enabled.
  23   virtual void OnNotificationsEnabled() = 0;
  24
  25   // Called when notifications are disabled, with the reason in
  26   // |reason|.
  27   virtual void OnNotificationsDisabled(
  28       NotificationsDisabledReason reason) = 0;
  29
  30   // Called when a notification is received.  The per-id payloads
  31   // are in |type_payloads| and the source is in |source|.
  32   virtual void OnIncomingNotification(
  33       const ObjectIdPayloadMap& id_payloads,
  34       IncomingNotificationSource source) = 0;
  35
  36  protected:
  37   virtual ~SyncNotifierObserver() {}
  38 };
  39
  40 }  // namespace syncer
  41
  42 #endif  // SYNC_NOTIFIER_SYNC_NOTIFIER_OBSERVER_H_