Added in API level 18

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

StatusBarNotification

---

Kotlin |Java

public class StatusBarNotification
extends Object implements Parcelable

java.lang.Object
↳	android.service.notification.StatusBarNotification

---

Class encapsulating a Notification. Sent by the NotificationManagerService to clients including the status bar and any NotificationListenerServices.

Summary

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<StatusBarNotification>	CREATOR

Public constructors
StatusBarNotification(Parcel in)
StatusBarNotification(String pkg, String opPkg, int id, String tag, int uid, int initialPid, int score, Notification notification, UserHandle user, long postTime) This constructor is deprecated. Non-system apps should not need to create StatusBarNotifications.

Public methods
StatusBarNotification	clone() Creates and returns a copy of this object.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
String	getGroupKey() A key that indicates the group with which this message ranks.
int	getId() The id supplied to NotificationManager.notify(int, Notification).
String	getKey() A unique instance key for this notification record.
Notification	getNotification() The Notification supplied to NotificationManager.notify(int, Notification).
String	getOpPkg() The package that posted the notification.
String	getOverrideGroupKey() Returns the override group key.
String	getPackageName() The package that the notification belongs to.
long	getPostTime() The time (in System.currentTimeMillis time) the notification was posted, which may be different than Notification.when.
String	getTag() The tag supplied to NotificationManager.notify(int, Notification), or null if no tag was specified.
int	getUid() The notifying app's (getPackageName()'s) uid.
UserHandle	getUser() The UserHandle for whom this notification is intended.
int	getUserId() This method was deprecated in API level 21. Use getUser() instead.
boolean	isAppGroup() Returns true if application asked that this notification be part of a group.
boolean	isClearable() Convenience method to check the notification's flags for either Notification.FLAG_ONGOING_EVENT or Notification.FLAG_NO_CLEAR.
boolean	isGroup() Returns true if this notification is part of a group.
boolean	isOngoing() Convenience method to check the notification's flags for Notification.FLAG_ONGOING_EVENT.
void	setOverrideGroupKey(String overrideGroupKey) Sets the override group key.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel out, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 18

public static final Creator<StatusBarNotification> CREATOR

Public constructors

StatusBarNotification

Added in API level 18

public StatusBarNotification (Parcel in)

Parameters
in	Parcel

StatusBarNotification

Added in API level 18

public StatusBarNotification (String pkg, 
                String opPkg, 
                int id, 
                String tag, 
                int uid, 
                int initialPid, 
                int score, 
                Notification notification, 
                UserHandle user, 
                long postTime)

This constructor is deprecated.
Non-system apps should not need to create StatusBarNotifications.

Parameters
pkg	String
opPkg	String
id	int
tag	String
uid	int
initialPid	int
score	int
notification	Notification
user	UserHandle
postTime	long

Public methods

clone

Added in API level 18

public StatusBarNotification clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns
StatusBarNotification	a clone of this instance.

describeContents

Added in API level 18

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

getGroupKey

Added in API level 21

public String getGroupKey ()

A key that indicates the group with which this message ranks.

Returns
String

getId

Added in API level 18

public int getId ()

The id supplied to NotificationManager.notify(int, Notification).

Returns
int

getKey

Added in API level 20

public String getKey ()

A unique instance key for this notification record.

Returns
String

getNotification

Added in API level 18

public Notification getNotification ()

The Notification supplied to NotificationManager.notify(int, Notification).

Returns
Notification

getOpPkg

Added in API level 29

public String getOpPkg ()

The package that posted the notification.

Might be different from getPackageName() if the app owning the notification has a notification delegate.

Returns
String	This value cannot be null.

getOverrideGroupKey

Added in API level 24

public String getOverrideGroupKey ()

Returns the override group key.

Returns
String

getPackageName

Added in API level 18

public String getPackageName ()

The package that the notification belongs to.

Returns
String

getPostTime

Added in API level 18

public long getPostTime ()

The time (in System.currentTimeMillis time) the notification was posted, which may be different than Notification.when.

Returns
long

getTag

Added in API level 18

public String getTag ()

The tag supplied to NotificationManager.notify(int, Notification), or null if no tag was specified.

Returns
String

getUid

Added in API level 29

public int getUid ()

The notifying app's (getPackageName()'s) uid.

Returns
int

getUser

Added in API level 21

public UserHandle getUser ()

The UserHandle for whom this notification is intended.

Returns
UserHandle

getUserId

Added in API level 18
Deprecated in API level 21

public int getUserId ()

This method was deprecated in API level 21.
Use getUser() instead.

Returns a userid for whom this notification is intended.

Returns
int

isAppGroup

Added in API level 30

public boolean isAppGroup ()

Returns true if application asked that this notification be part of a group.

Returns
boolean

isClearable

Added in API level 18

public boolean isClearable ()

Convenience method to check the notification's flags for either Notification.FLAG_ONGOING_EVENT or Notification.FLAG_NO_CLEAR.

Returns
boolean

isGroup

Added in API level 24

public boolean isGroup ()

Returns true if this notification is part of a group.

Returns
boolean

isOngoing

Added in API level 18

public boolean isOngoing ()

Convenience method to check the notification's flags for Notification.FLAG_ONGOING_EVENT.

Returns
boolean

setOverrideGroupKey

Added in API level 24

public void setOverrideGroupKey (String overrideGroupKey)

Sets the override group key.

Parameters
overrideGroupKey	String

toString

Added in API level 18

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 18

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