# Print output for @column tags ?>
public
static
class
NotificationListenerService.Ranking
extends Object
java.lang.Object | |
↳ | android.service.notification.NotificationListenerService.Ranking |
Stores ranking related information on a currently active notification.
Ranking objects aren't automatically updated as notification events
occur. Instead, ranking information has to be retrieved again via the
current RankingMap
.
Constants | |
---|---|
int |
USER_SENTIMENT_NEGATIVE
The user is likely to have a negative reaction to this notification. |
int |
USER_SENTIMENT_NEUTRAL
It is not known how the user will react to this notification. |
int |
USER_SENTIMENT_POSITIVE
The user is likely to have a positive reaction to this notification. |
Public constructors | |
---|---|
Ranking()
|
Public methods | |
---|---|
boolean
|
canBubble()
Returns whether the user has allowed bubbles globally, at the app level, and at the channel level for this notification. |
boolean
|
canShowBadge()
Returns whether this notification can be displayed as a badge. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
NotificationChannel
|
getChannel()
Returns the notification channel this notification was posted to, which dictates notification behavior and presentation. |
int
|
getImportance()
Returns the importance of the notification, which dictates its
modes of presentation, see: |
CharSequence
|
getImportanceExplanation()
If the importance has been overridden by user preference, then this will be non-null, and should be displayed to the user. |
String
|
getKey()
Returns the key of the notification this Ranking applies to. |
long
|
getLastAudiblyAlertedMillis()
Returns the last time this notification alerted the user via sound or vibration. |
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. |
int
|
getRank()
Returns the rank of the notification. |
List<Notification.Action>
|
getSmartActions()
Returns a list of smart |
List<CharSequence>
|
getSmartReplies()
Returns a list of smart replies that can be added by the
|
int
|
getSuppressedVisualEffects()
Returns the type(s) of visual effects that should be suppressed for this notification. |
int
|
getUserSentiment()
Returns how the system thinks the user feels about notifications from the
channel provided by |
boolean
|
isAmbient()
Returns whether the notification is an ambient notification, that is a notification that doesn't require the user's immediate attention. |
boolean
|
isSuspended()
Returns whether the app that posted this notification is suspended, so this notification should be hidden. |
boolean
|
matchesInterruptionFilter()
Returns whether the notification matches the user's interruption filter. |
Inherited methods | |
---|---|
public static final int USER_SENTIMENT_NEGATIVE
The user is likely to have a negative reaction to this notification.
Constant Value: -1 (0xffffffff)
public static final int USER_SENTIMENT_NEUTRAL
It is not known how the user will react to this notification.
Constant Value: 0 (0x00000000)
public static final int USER_SENTIMENT_POSITIVE
The user is likely to have a positive reaction to this notification.
Constant Value: 1 (0x00000001)
public Ranking ()
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.
Returns | |
---|---|
boolean |
public boolean canShowBadge ()
Returns whether this notification can be displayed as a badge.
Returns | |
---|---|
boolean |
true if the notification can be displayed as a badge, false otherwise. |
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:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public NotificationChannel getChannel ()
Returns the notification channel this notification was posted to, which dictates notification behavior and presentation.
Returns | |
---|---|
NotificationChannel |
public int getImportance ()
Returns the importance of the notification, which dictates its
modes of presentation, see: NotificationManager#IMPORTANCE_DEFAULT
, etc.
Returns | |
---|---|
int |
the importance of the notification
Value is NotificationManager.IMPORTANCE_UNSPECIFIED , NotificationManager.IMPORTANCE_NONE , NotificationManager.IMPORTANCE_MIN , NotificationManager.IMPORTANCE_LOW , NotificationManager.IMPORTANCE_DEFAULT , or NotificationManager.IMPORTANCE_HIGH |
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.
Returns | |
---|---|
CharSequence |
the explanation for the importance, or null if it is the natural importance |
public String getKey ()
Returns the key of the notification this Ranking applies to.
Returns | |
---|---|
String |
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.
Returns | |
---|---|
long |
the time of the last alerting behavior, in milliseconds. Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z. |
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.
Returns | |
---|---|
String |
public int getRank ()
Returns the rank of the notification.
Returns | |
---|---|
int |
the rank of the notification, that is the 0-based index in the list of active notifications. |
public List<Notification.Action> getSmartActions ()
Returns a list of smart Notification.Action
that can be added by the
NotificationAssistantService
Returns | |
---|---|
List<Notification.Action> |
This value cannot be null . |
public List<CharSequence> getSmartReplies ()
Returns a list of smart replies that can be added by the
NotificationAssistantService
Returns | |
---|---|
List<CharSequence> |
This value cannot be null . |
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
.
Returns | |
---|---|
int |
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
.
Returns | |
---|---|
int |
public boolean isAmbient ()
Returns whether the notification is an ambient notification, that is a notification that doesn't require the user's immediate attention.
Returns | |
---|---|
boolean |
public boolean isSuspended ()
Returns whether the app that posted this notification is suspended, so this notification should be hidden.
Returns | |
---|---|
boolean |
true if the notification should be hidden, false otherwise. |
public boolean matchesInterruptionFilter ()
Returns whether the notification matches the user's interruption filter.
Returns | |
---|---|
boolean |
true if the notification is allowed by the filter, or
false if it is blocked. |