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
98
99
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// 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 <set>
#include <string>
#include <vector>
#include "base/macros.h"
typedef void* ProfileID;
class GURL;
class Notification;
class PrefService;
class Profile;
// This virtual interface is used to manage the UI surfaces for desktop
// 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:
// Convert a profile pointer into an opaque profile id, which can be safely
// used by FindById() and CancelById() even after a profile may have been
// destroyed.
static ProfileID GetProfileID(Profile* profile) {
return static_cast<ProfileID>(profile);
}
virtual ~NotificationUIManager() {}
// Creates an initialized UI manager.
// TODO(dewittj): Remove the PrefService argument which is unused. See
// crbug.com/530376
static NotificationUIManager* Create(PrefService* local_state);
// Adds a notification to be displayed. Virtual for unit test override.
virtual void Add(const Notification& notification, Profile* profile) = 0;
// Updates an existing notification. If |update_progress_only|, assume
// only message and progress properties are updated.
virtual bool Update(const 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 Notification* FindById(const std::string& delegate_id,
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,
ProfileID profile_id) = 0;
// Returns the set of all delegate IDs for notifications from the passed
// |profile_id| and |source|.
virtual std::set<std::string> GetAllIdsByProfileAndSourceOrigin(
ProfileID profile_id,
const GURL& source) = 0;
// Returns the set of all delegate IDs for notifications from |profile_id|.
virtual std::set<std::string> GetAllIdsByProfile(ProfileID profile_id) = 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;
// Removes notifications matching |profile_id|. Returns true if any were
// removed.
virtual bool CancelAllByProfile(ProfileID profile_id) = 0;
// Cancels all pending notifications and closes anything currently showing.
// Used when the app is terminating.
virtual void CancelAll() = 0;
protected:
NotificationUIManager() {}
private:
DISALLOW_COPY_AND_ASSIGN(NotificationUIManager);
};
#endif // CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_H_
|
