Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8e3ec2a7 authored by Pavel Grafov's avatar Pavel Grafov
Browse files

Clarify reasons for notification removal. 

The removed list of reasons is incomplete and might make developer think
that a notification can't be removed for any other reason. "reason"
argument in one of the overloads provides a link to full list of
reasons.

Annotating the argument with @NotificationCancelReason generates an
equivalent of @param javadoc with the complete list of reasons.

Bug: 292204120
Test: doc-only change
Change-Id: I1394b987e8ccdab474189f5fbb57ea3c70bce50b
parent 25f954ed

core/java/android/service/notification/NotificationListenerService.java

+1 −11
Original line number Diff line number Diff line
@@ -485,9 +485,6 @@ public abstract class NotificationListenerService extends Service { 
    /**

     * Implement this method to learn when notifications are removed.

     * <p>

     * This might occur because the user has dismissed the notification using system UI (or another

     * notification listener) or because the app has withdrawn the notification.

     * <p>

     * NOTE: The {@link StatusBarNotification} object you receive will be "light"; that is, the

     * result from {@link StatusBarNotification#getNotification} may be missing some heavyweight

     * fields such as {@link android.app.Notification#contentView} and
@@ -506,9 +503,6 @@ public abstract class NotificationListenerService extends Service { 
    /**

     * Implement this method to learn when notifications are removed.

     * <p>

     * This might occur because the user has dismissed the notification using system UI (or another

     * notification listener) or because the app has withdrawn the notification.

     * <p>

     * NOTE: The {@link StatusBarNotification} object you receive will be "light"; that is, the

     * result from {@link StatusBarNotification#getNotification} may be missing some heavyweight

     * fields such as {@link android.app.Notification#contentView} and
@@ -531,9 +525,6 @@ public abstract class NotificationListenerService extends Service { 
    /**

     * Implement this method to learn when notifications are removed and why.

     * <p>

     * This might occur because the user has dismissed the notification using system UI (or another

     * notification listener) or because the app has withdrawn the notification.

     * <p>

     * NOTE: The {@link StatusBarNotification} object you receive will be "light"; that is, the

     * result from {@link StatusBarNotification#getNotification} may be missing some heavyweight

     * fields such as {@link android.app.Notification#contentView} and
@@ -546,10 +537,9 @@ public abstract class NotificationListenerService extends Service { 
     *            was just removed.

     * @param rankingMap The current ranking map that can be used to retrieve ranking information

     *                   for active notifications.

     * @param reason see {@link #REASON_LISTENER_CANCEL}, etc.

     */

    public void onNotificationRemoved(StatusBarNotification sbn, RankingMap rankingMap,

            int reason) {

            @NotificationCancelReason int reason) {

        onNotificationRemoved(sbn, rankingMap);

    }