blob: eedef03dfb3a35d0e24557aebd53c7d715c54ae5 [file] [log] [blame]
// Copyright 2014 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.
namespace suggestions {
// Establishes the different sync states that users of SuggestionsService can
// specify. There are three different concepts in the sync service: initialized,
// sync enabled and history sync enabled.
enum SyncState {
// State: Sync service is not initialized, yet not disabled. History sync
// state is unknown (since not initialized).
// Behavior: Does not issue a server request, but serves from cache if
// available.
// State: Sync service is initialized, sync is enabled and history sync is
// enabled.
// Behavior: Update suggestions from the server. Serve from cache on timeout.
// State: Sync service is disabled or history sync is disabled.
// Behavior: Do not issue a server request. Clear the cache. Serve empty
// suggestions.
// Users of SuggestionsService should always use this function to get SyncState.
SyncState GetSyncState(bool sync_enabled,
bool sync_initialized,
bool history_sync_enabled);
} // namespace suggestions