components/sync/user_events/user_event_service.h

// Copyright 2017 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 COMPONENTS_SYNC_USER_EVENTS_USER_EVENT_SERVICE_H_
#define COMPONENTS_SYNC_USER_EVENTS_USER_EVENT_SERVICE_H_

#include <memory>
#include <string>

#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/sync/protocol/user_event_specifics.pb.h"

namespace syncer {

class ModelTypeSyncBridge;

class UserEventService : public KeyedService {
 public:
  UserEventService();
  ~UserEventService() override;

  // Records a given event to be reported. Relevant settings will be checked to
  // verify user events should be emitted and this will no-op if the the
  // requisite permissions are not present.
  virtual void RecordUserEvent(
      std::unique_ptr<sync_pb::UserEventSpecifics> specifics) = 0;
  virtual void RecordUserEvent(
      const sync_pb::UserEventSpecifics& specifics) = 0;

  // Register that knowledge about a given field trial is important when
  // interpreting specified user event type, and should be recorded if assigned.
  virtual void RegisterDependentFieldTrial(
      const std::string& trial_name,
      sync_pb::UserEventSpecifics::EventCase event_case) = 0;

  // Returns the underlying Sync integration point.
  virtual base::WeakPtr<ModelTypeSyncBridge> GetSyncBridge() = 0;

 private:
  DISALLOW_COPY_AND_ASSIGN(UserEventService);
};

}  // namespace syncer

#endif  // COMPONENTS_SYNC_USER_EVENTS_USER_EVENT_SERVICE_H_