Added in API level 21

RankingMap

open class RankingMap : Parcelable
kotlin.Any
   ↳ 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
Public methods
open Int

open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
open Array<String!>!

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

Populates outRanking with ranking information for the notification with the given key.
open Unit
writeToParcel(out: Parcel, flags: Int)
Properties
static Parcelable.Creator<NotificationListenerService.RankingMap!>

Public methods

describeContents

Added in API level 21
open fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

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

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getOrderedKeys

Added in API level 21
open fun getOrderedKeys(): Array<String!>!

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

Return
Array<String!>! An array of active notification keys, in their ranking order.

getRanking

Added in API level 21
open fun getRanking(
    key: String!, 
    outRanking: NotificationListenerService.Ranking!
): Boolean

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

Return
Boolean true if a valid key has been passed and outRanking has been populated; false otherwise

writeToParcel

Added in API level 21
open fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit
Parameters
dest 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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 21
static val CREATOR: Parcelable.Creator<NotificationListenerService.RankingMap!>