ukm_recorder_observer.h 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. // Copyright 2022 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. #ifndef COMPONENTS_UKM_UKM_RECORDER_OBSERVER_H_
  5. #define COMPONENTS_UKM_UKM_RECORDER_OBSERVER_H_
  6. #include <vector>
  7. #include "base/observer_list_types.h"
  8. #include "services/metrics/public/cpp/ukm_source_id.h"
  9. #include "services/metrics/public/mojom/ukm_interface.mojom.h"
  10. #include "url/gurl.h"
  11. namespace ukm {
  12. // Base class for observing UkmRecorderImpl. This object is notified when
  13. // a new UKM entry is added, or when a source URL is updated, or when
  14. // purge happens. Observers are notified even if |recording_enabled_| is
  15. // false. All the methods are notified on the same SequencedTaskRunner
  16. // on which the observer is added.
  17. class COMPONENT_EXPORT(UKM_RECORDER) UkmRecorderObserver
  18. : public base::CheckedObserver {
  19. public:
  20. UkmRecorderObserver() = default;
  21. ~UkmRecorderObserver() override = default;
  22. UkmRecorderObserver(const UkmRecorderObserver&) = delete;
  23. UkmRecorderObserver& operator=(const UkmRecorderObserver&) = delete;
  24. // Called when a new UKM entry is added.
  25. virtual void OnEntryAdded(mojom::UkmEntryPtr entry);
  26. // Called when URLs are updated for a |source_id|.
  27. virtual void OnUpdateSourceURL(SourceId source_id,
  28. const std::vector<GURL>& urls);
  29. // Called when UKM entries related to the given URL scheme should be purged.
  30. virtual void OnPurgeRecordingsWithUrlScheme(const std::string& url_scheme);
  31. // Called when all UKM entries should be purged.
  32. virtual void OnPurge();
  33. // Called when the UKM consent state is changed. |allow| is true iff all UKM
  34. // is allowed for all profile states and URL-keyed anonymized data collection
  35. // is enabled for all profiles. This won't be called when extension or app
  36. // consent is changed.
  37. virtual void OnUkmAllowedStateChanged(bool allowed);
  38. };
  39. } // namespace ukm
  40. #endif // COMPONENTS_UKM_UKM_RECORDER_OBSERVER_H_