1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License
15  */
16 
17 package com.android.systemui.statusbar;
18 
19 import android.service.notification.NotificationListenerService;
20 import android.service.notification.StatusBarNotification;
21 
22 /**
23  * Interface for accepting notification updates from {@link NotificationListener}.
24  */
25 public interface NotificationUpdateHandler {
26     /**
27      * Add a new notification and update the current notification ranking map.
28      *
29      * @param notification Notification to add
30      * @param ranking RankingMap to update with
31      */
addNotification(StatusBarNotification notification, NotificationListenerService.RankingMap ranking)32     void addNotification(StatusBarNotification notification,
33             NotificationListenerService.RankingMap ranking);
34 
35     /**
36      * Remove a notification and update the current notification ranking map.
37      *
38      * @param key Key identifying the notification to remove
39      * @param ranking RankingMap to update with
40      * @param reason why the notification is being removed, e.g.
41      * {@link NotificationListenerService#REASON_CANCEL}.
42      */
removeNotification(String key, NotificationListenerService.RankingMap ranking, int reason)43     void removeNotification(String key, NotificationListenerService.RankingMap ranking, int reason);
44 
45     /**
46      * Update a given notification and the current notification ranking map.
47      *
48      * @param notification Updated notification
49      * @param ranking RankingMap to update with
50      */
updateNotification(StatusBarNotification notification, NotificationListenerService.RankingMap ranking)51     void updateNotification(StatusBarNotification notification,
52             NotificationListenerService.RankingMap ranking);
53 
54     /**
55      * Update with a new notification ranking map.
56      *
57      * @param ranking RankingMap to update with
58      */
updateNotificationRanking(NotificationListenerService.RankingMap ranking)59     void updateNotificationRanking(NotificationListenerService.RankingMap ranking);
60 }
61