File: notification_ui_manager.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 (97 lines) | stat: -rw-r--r-- 4,272 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
// Copyright 2012 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_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_H_
#define CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_H_

#include <memory>
#include <set>
#include <string>
#include <vector>

#include "chrome/browser/notifications/notification_common.h"
#include "chrome/browser/notifications/profile_notification.h"

class GURL;
class Profile;

namespace message_center {
class Notification;
}

// This interface is used to manage the UI surfaces for non-native desktop
// notifications (hence, this is not used by Chrome OS and is not used for
// Windows Action Center notifications). There is just one instance for all
// profiles. This represents the middle layer of notification and it's aware of
// profile. It identifies a notification by the id string and a profile, hence
// two notifications from two different profiles, even though they may have
// identical ids, will not be considered the same notification. This interface
// will generate a new id behind the scene based on the id string and the
// profile's characteristics for each notification and use this new id to call
// lower layer MessageCenter interface which is profile agnostic. Therefore the
// ids passed into this interface are not the same as those passed into the
// MessageCenter interface.
class NotificationUIManager {
 public:
  NotificationUIManager(const NotificationUIManager&) = delete;
  NotificationUIManager& operator=(const NotificationUIManager&) = delete;
  virtual ~NotificationUIManager() = default;

  // Creates an initialized UI manager.
  static std::unique_ptr<NotificationUIManager> Create();

  // Adds a notification to be displayed.
  virtual void Add(const message_center::Notification& notification,
                   Profile* profile) = 0;

  // Updates the given notification, if it already exists.Returns true for
  // update and false to report a no-op.
  virtual bool Update(const message_center::Notification& notification,
                      Profile* profile) = 0;

  // Returns the pointer to a notification if it match the supplied ID, either
  // currently displayed or in the queue.
  // This function can be bound for delayed execution, where a profile pointer
  // may not be valid. Hence caller needs to call the static GetProfileID(...)
  // function to turn a profile pointer into a profile id and pass that in.
  virtual const message_center::Notification* FindById(
      const std::string& delegate_id,
      ProfileNotification::ProfileID profile_id) const = 0;

  // Removes any notifications matching the supplied ID, either currently
  // displayed or in the queue.  Returns true if anything was removed.
  // This function can be bound for delayed execution, where a profile pointer
  // may not be valid. Hence caller needs to call the static GetProfileID(...)
  // function to turn a profile pointer into a profile id and pass that in.
  virtual bool CancelById(const std::string& delegate_id,
                          ProfileNotification::ProfileID profile_id) = 0;

  // Returns the set of all delegate IDs for notifications from |profile_id|.
  virtual std::set<std::string> GetAllIdsByProfile(
      ProfileNotification::ProfileID profile_id) = 0;

  // Returns the set of all delegate IDs for notifications from `profile_id` and
  // `origin`.
  virtual std::set<std::string> GetAllIdsByProfileAndOrigin(
      ProfileNotification::ProfileID profile_id,
      const GURL& origin) = 0;

  // Removes notifications matching the |source_origin| (which could be an
  // extension ID). Returns true if anything was removed.
  virtual bool CancelAllBySourceOrigin(const GURL& source_origin) = 0;

  // Cancels all pending notifications and closes anything currently showing.
  // Used when the app is terminating.
  virtual void CancelAll() = 0;

  // Cancels all pending notifications and closes anything currently showing.
  // After this is called, no new notifications can be added. Used when the app
  // is terminating.
  virtual void StartShutdown() = 0;

 protected:
  NotificationUIManager() = default;
};

#endif  // CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_H_