NotificationListenerService.Ranking

USER_SENTIMENT_NEGATIVE

public static final int USER_SENTIMENT_NEGATIVE

The user is likely to have a negative reaction to this notification.

Constant Value: -1 (0xffffffff)

USER_SENTIMENT_NEUTRAL

public static final int USER_SENTIMENT_NEUTRAL

It is not known how the user will react to this notification.

Constant Value: 0 (0x00000000)

USER_SENTIMENT_POSITIVE

public static final int USER_SENTIMENT_POSITIVE

The user is likely to have a positive reaction to this notification.

Constant Value: 1 (0x00000001)

VISIBILITY_NO_OVERRIDE

public static final int VISIBILITY_NO_OVERRIDE

Value signifying that the user and device policy manager have not expressed a lockscreen visibility override for a notification.

Constant Value: -1000 (0xfffffc18)

Ranking

public Ranking ()

canBubble

public boolean canBubble ()

Returns whether the user has allowed bubbles globally, at the app level, and at the channel level for this notification.

This does not take into account the current importance of the notification, the current DND state, or whether the posting app is foreground.

canShowBadge

public boolean canShowBadge ()

Returns whether this notification can be displayed as a badge.

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getChannel

public NotificationChannel getChannel ()

Returns the notification channel this notification was posted to, which dictates notification behavior and presentation.

getConversationShortcutInfo

public ShortcutInfo getConversationShortcutInfo ()

Returns the shortcut information associated with this notification, if it is a conversation notification.

This might be null even if the notification is a conversation notification, if the posting app hasn't opted into the full conversation feature set yet.

getImportance

public int getImportance ()

Returns the importance of the notification, which dictates its modes of presentation, see: NotificationManager.IMPORTANCE_DEFAULT, etc.

getImportanceExplanation

public CharSequence getImportanceExplanation ()

If the importance has been overridden by user preference, then this will be non-null, and should be displayed to the user.

getKey

public String getKey ()

Returns the key of the notification this Ranking applies to.

getLastAudiblyAlertedMillis

public long getLastAudiblyAlertedMillis ()

Returns the last time this notification alerted the user via sound or vibration.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

getLockscreenVisibilityOverride

public int getLockscreenVisibilityOverride ()

Returns the user or device policy manager specified visibility (see Notification.VISIBILITY_PRIVATE, Notification.VISIBILITY_PUBLIC, Notification.VISIBILITY_SECRET) for this notification, or NotificationListenerService.Ranking.VISIBILITY_NO_OVERRIDE if no such preference has been expressed.

getOverrideGroupKey

public String getOverrideGroupKey ()

If the system has overridden the group key, then this will be non-null, and this key should be used to bundle notifications.

getRank

public int getRank ()

Returns the rank of the notification.

getSmartActions

public List<Notification.Action> getSmartActions ()

Returns a list of smart Notification.Action that can be added by the notification assistant.

getSmartReplies

public List<CharSequence> getSmartReplies ()

Returns a list of smart replies that can be added by the notification assistant.

getSuppressedVisualEffects

public int getSuppressedVisualEffects ()

Returns the type(s) of visual effects that should be suppressed for this notification. See NotificationManager.Policy, e.g. NotificationManager.Policy.SUPPRESSED_EFFECT_LIGHTS.

getUserSentiment

public int getUserSentiment ()

Returns how the system thinks the user feels about notifications from the channel provided by getChannel(). You can use this information to expose controls to help the user block this channel's notifications, if the sentiment is USER_SENTIMENT_NEGATIVE, or emphasize this notification if the sentiment is USER_SENTIMENT_POSITIVE.

isAmbient

public boolean isAmbient ()

Returns whether the notification is an ambient notification, that is a notification that doesn't require the user's immediate attention.

isConversation

public boolean isConversation ()

Returns whether this notification is a conversation notification, and would appear in the conversation section of the notification shade, on devices that separate that type of notification.

isSuspended

public boolean isSuspended ()

Returns whether the app that posted this notification is suspended, so this notification should be hidden.

matchesInterruptionFilter

public boolean matchesInterruptionFilter ()

Returns whether the notification matches the user's interruption filter.