File: ui_action_performer.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 (67 lines) | stat: -rw-r--r-- 2,758 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
59
60
61
62
63
64
65
66
67
// 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 CHROME_BROWSER_ASH_GROWTH_UI_ACTION_PERFORMER_H_
#define CHROME_BROWSER_ASH_GROWTH_UI_ACTION_PERFORMER_H_

#include "base/functional/callback.h"
#include "base/observer_list.h"
#include "base/observer_list_types.h"
#include "chrome/browser/ash/growth/metrics.h"
#include "chromeos/ash/components/growth/action_performer.h"

// Implements a base action performer to show visial elements, such a nudge and
// a notification.
class UiActionPerformer : public growth::ActionPerformer {
 public:
  class Observer : public base::CheckedObserver {
   public:
    // Trigger when calling to show the UI. The UI may or may not show.
    virtual void OnReadyToLogImpression(int campaign_id,
                                        std::optional<int> group_id,
                                        bool should_log_cros_events) = 0;

    // Trigger when the UI is pressed.
    // NOTE: Any button press could dismiss the UI. And the UI could auto
    // dismiss after some time.
    // TODO: b/330956316 - Log dismissal by reasons, e.g. the nudge is dismissed
    // automatically.
    virtual void OnDismissed(int campaign_id,
                             std::optional<int> group_id,
                             bool should_mark_dismissed,
                             bool should_log_cros_events) = 0;

    // Trigger when the button in the UI (if exists) is pressed.
    virtual void OnButtonPressed(int campaign_id,
                                 std::optional<int> group_id,
                                 CampaignButtonId button_id,
                                 bool should_mark_dismissed,
                                 bool should_log_cros_events) = 0;
  };

  UiActionPerformer();
  ~UiActionPerformer() override;

  void AddObserver(Observer* observer);
  void RemoveObserver(Observer* observer);

 protected:
  void NotifyReadyToLogImpression(int campaign_id,
                                  std::optional<int> group_id,
                                  bool should_log_cros_events = false);
  void NotifyDismissed(int campaign_id,
                       std::optional<int> group_id,
                       bool should_mark_dismissed,
                       bool should_log_cros_events = false);
  void NotifyButtonPressed(int campaign_id,
                           std::optional<int> group_id,
                           CampaignButtonId button_id,
                           bool should_mark_dismissed,
                           bool should_log_cros_events = false);

 private:
  base::ObserverList<Observer> observers_;
};

#endif  // CHROME_BROWSER_ASH_GROWTH_UI_ACTION_PERFORMER_H_