src/chrome/browser/sync/profile_sync_service_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 CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_OBSERVER_H_
   6 #define CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_OBSERVER_H_
   7
   8 // Various UI components such as the New Tab page can be driven by observing
   9 // the ProfileSyncService through this interface.
  10 class ProfileSyncServiceObserver {
  11  public:
  12   // When one of the following events occurs, OnStateChanged() is called.
  13   // Observers should query the service to determine what happened.
  14   // - We initialized successfully.
  15   // - The sync servers are unavailable at this time.
  16   // - Credentials are now in flight for authentication.
  17   // - The data type configuration has started or ended.
  18   // - Sync shut down.
  19   // - Sync errors (passphrase, auth, unrecoverable, actionable, etc.).
  20   // - Encryption changes.
  21   virtual void OnStateChanged() = 0;
  22
  23   // If a client wishes to handle sync cycle completed events in a special way,
  24   // they can use this function.  By default, it re-routes to OnStateChanged().
  25   virtual void OnSyncCycleCompleted();
  26
  27  protected:
  28   virtual ~ProfileSyncServiceObserver() { }
  29 };
  30
  31 #endif  // CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_OBSERVER_H_