File: extension_notification_display_helper.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 (81 lines) | stat: -rw-r--r-- 2,911 bytes parent folder | download | duplicates (11)
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
// Copyright 2017 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_EXTENSIONS_API_NOTIFICATIONS_EXTENSION_NOTIFICATION_DISPLAY_HELPER_H_
#define CHROME_BROWSER_EXTENSIONS_API_NOTIFICATIONS_EXTENSION_NOTIFICATION_DISPLAY_HELPER_H_

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

#include "base/memory/raw_ptr.h"
#include "components/keyed_service/core/keyed_service.h"

class GURL;
class NotificationDisplayService;
class Profile;

namespace message_center {
class Notification;
}

namespace extensions {

// Helper class for displaying notifications through the notification display
// service. The NDS supports notifications that can outlive the browser process,
// and therefore does not retain as much information as is necessary to support
// the extensions API. (Notably the ability to partly update notifications.)
class ExtensionNotificationDisplayHelper : public KeyedService {
 public:
  explicit ExtensionNotificationDisplayHelper(Profile* profile);

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

  ~ExtensionNotificationDisplayHelper() override;

  // Displays the |notification| using the notification display service.
  void Display(const message_center::Notification& notification);

  // Returns the notification identified by |notification_id| if it is currently
  // visible. May return a nullptr.
  message_center::Notification* GetByNotificationId(
      const std::string& notification_id);

  // Returns a set with the IDs of all notifications that are currently being
  // shown on behalf of the |extension_origin|.
  std::set<std::string> GetNotificationIdsForExtension(
      const GURL& extension_origin) const;

  // Removes stored state for the notification identified by |notification_id|.
  // Returns whether there was local state.
  bool EraseDataForNotificationId(const std::string& notification_id);

  // Closes the notification identified by |notification_id|. Returns whether a
  // notification was closed in response to the call.
  bool Close(const std::string& notification_id);

  // KeyedService overrides:
  void Shutdown() override;

 private:
  using NotificationVector =
      std::vector<std::unique_ptr<message_center::Notification>>;

  // Returns the notification display service instance to communicate with.
  NotificationDisplayService* GetDisplayService();

  // The Profile instance that owns this keyed service.
  raw_ptr<Profile> profile_;

  // Vector of notifications that are being shown for extensions.
  NotificationVector notifications_;
};

}  // namespace extensions

#endif  // CHROME_BROWSER_EXTENSIONS_API_NOTIFICATIONS_EXTENSION_NOTIFICATION_DISPLAY_HELPER_H_