File: new_badge_policy.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 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 (58 lines) | stat: -rw-r--r-- 2,142 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 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_USER_EDUCATION_COMMON_NEW_BADGE_NEW_BADGE_POLICY_H_
#define COMPONENTS_USER_EDUCATION_COMMON_NEW_BADGE_NEW_BADGE_POLICY_H_

#include "base/feature_list.h"
#include "base/time/time.h"

namespace user_education {

class UserEducationStorageService;
struct NewBadgeData;

// Describes when a "New" Badge can be shown for a given feature.
class NewBadgePolicy {
 public:
  NewBadgePolicy();
  NewBadgePolicy(const NewBadgePolicy&) = delete;
  void operator=(const NewBadgePolicy&) = delete;
  virtual ~NewBadgePolicy();

  // Returns whether a "New" Badge should be shown.
  virtual bool ShouldShowNewBadge(
      const NewBadgeData& data,
      const UserEducationStorageService& storage_service) const;

  // Records metrics for "New" Badge. Call when the badge will be shown.
  virtual void RecordNewBadgeShown(const base::Feature& feature, int count);

  // Records metrics when the associated `feature` for a "New" Badge was used.
  virtual void RecordFeatureUsed(const base::Feature& feature, int count);

  // Returns the recommended number of times to record that the feature was
  // used in prefs, which should be greater than `uses_before_dismiss` to allow
  // the limits to be adjusted up or down via Finch config. Guaranteed to be
  // significantly larger than the use cap.
  virtual int GetFeatureUsedStorageCap() const;

 protected:
  // Constructor that sets the default number of times a badge can be shown or
  // its associated entry point used before the badge disappears.
  NewBadgePolicy(int times_shown_before_dismiss,
                 int uses_before_dismiss,
                 base::TimeDelta display_window,
                 base::TimeDelta new_profile_grace_period);

 private:
  const int times_shown_before_dismiss_;
  const int uses_before_dismiss_;
  const base::TimeDelta display_window_;
  const base::TimeDelta new_profile_grace_period_;
};

}  // namespace user_education

#endif  // COMPONENTS_USER_EDUCATION_COMMON_NEW_BADGE_NEW_BADGE_POLICY_H_