File: info_card_tracker.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (63 lines) | stat: -rw-r--r-- 2,136 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_FEED_CORE_V2_STREAM_INFO_CARD_TRACKER_H_
#define COMPONENTS_FEED_CORE_V2_STREAM_INFO_CARD_TRACKER_H_

#include <string>
#include <vector>

#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "components/feed/core/proto/v2/wire/info_card.pb.h"
#include "components/feed/core/v2/public/common_enums.h"

class PrefService;

namespace feed {

// Tracks the raw counts of the info cards in order to determine their
// acknowledgement states.
class InfoCardTracker {
 public:
  explicit InfoCardTracker(PrefService* profile_prefs);
  ~InfoCardTracker();

  InfoCardTracker(const InfoCardTracker&) = delete;
  InfoCardTracker& operator=(const InfoCardTracker&) = delete;

  // Returns the list of states of all tracked info cards. The returned view
  // timestamps will be adjusted to be based on server's clock. The adjustment
  // is computed based on `server_timestamp` and `client_timestamp`.
  // `server_timestamp` is the server timestamp, in milliseconds from Epoch,
  // when the response is produced.
  // `client_timestamp` is the client timestamp, in milliseconds from Epoch,
  // when the response is received.
  std::vector<feedwire::InfoCardTrackingState> GetAllStates(
      int64_t server_timestamp,
      int64_t client_timestamp) const;

  // Called when the info card is fully visible.
  void OnViewed(int info_card_type, int minimum_view_interval_seconds);

  // Called when the info card is tapped.
  void OnClicked(int info_card_type);

  // Called when the info card is dismissed explicitly.
  void OnDismissed(int info_card_type);

  // Reset the state of the info card.
  void ResetState(int info_card_type);

 private:
  feedwire::InfoCardTrackingState GetState(int info_card_type) const;
  void SetState(int info_card_type,
                const feedwire::InfoCardTrackingState& state);

  raw_ptr<PrefService, DanglingUntriaged> profile_prefs_;
};

}  // namespace feed

#endif  // COMPONENTS_FEED_CORE_V2_STREAM_INFO_CARD_TRACKER_H_