Ranking

USER_SENTIMENT_NEGATIVE

static val USER_SENTIMENT_NEGATIVE: Int

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

Value: -1

USER_SENTIMENT_NEUTRAL

static val USER_SENTIMENT_NEUTRAL: Int

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

Value: 0

USER_SENTIMENT_POSITIVE

static val USER_SENTIMENT_POSITIVE: Int

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

Value: 1

VISIBILITY_NO_OVERRIDE

static val VISIBILITY_NO_OVERRIDE: Int

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

Value: -1000

Ranking

Ranking()

canBubble

open fun canBubble(): Boolean

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

open fun canShowBadge(): Boolean

Returns whether this notification can be displayed as a badge.

equals

open fun equals(other: Any?): Boolean

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

open fun getChannel(): NotificationChannel!

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

getConversationShortcutInfo

open fun getConversationShortcutInfo(): ShortcutInfo?

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

open fun getImportance(): Int

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

getImportanceExplanation

open fun getImportanceExplanation(): CharSequence!

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

getKey

open fun getKey(): String!

Returns the key of the notification this Ranking applies to.

getLastAudiblyAlertedMillis

open fun getLastAudiblyAlertedMillis(): Long

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

open fun getLockscreenVisibilityOverride(): Int

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

open fun getOverrideGroupKey(): String!

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

getRank

open fun getRank(): Int

Returns the rank of the notification.

getSmartActions

open fun getSmartActions(): MutableList<Notification.Action!>

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

getSmartReplies

open fun getSmartReplies(): MutableList<CharSequence!>

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

getSuppressedVisualEffects

open fun getSuppressedVisualEffects(): Int

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

open fun getUserSentiment(): Int

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

open fun isAmbient(): Boolean

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

isConversation

open fun isConversation(): Boolean

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

open fun isSuspended(): Boolean

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

matchesInterruptionFilter

open fun matchesInterruptionFilter(): Boolean

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