NotificationListenerService.RankingMap

public static class NotificationListenerService.RankingMap
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.notification.NotificationListenerService.RankingMap


Provides access to ranking information on currently active notifications.

Note that this object represents a ranking snapshot that only applies to notifications active at the time of retrieval.

Summary

Inherited constants

Fields

public static final Creator<NotificationListenerService.RankingMap> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

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

String[] getOrderedKeys()

Request the list of notification keys in their current ranking order.

boolean getRanking(String key, NotificationListenerService.Ranking outRanking)

Populates outRanking with ranking information for the notification with the given key.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 21
public static final Creator<NotificationListenerService.RankingMap> CREATOR

Public methods

describeContents

Added in API level 21
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 21
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.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getOrderedKeys

Added in API level 21
public String[] getOrderedKeys ()

Request the list of notification keys in their current ranking order.

Returns
String[] An array of active notification keys, in their ranking order.

getRanking

Added in API level 21
public boolean getRanking (String key, 
                NotificationListenerService.Ranking outRanking)

Populates outRanking with ranking information for the notification with the given key.

Parameters
key String

outRanking NotificationListenerService.Ranking

Returns
boolean true if a valid key has been passed and outRanking has been populated; false otherwise

writeToParcel

Added in API level 21
public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES