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 NotificationListenerService
s.
Inherited constants |
---|
From
interface
android.os.Parcelable
|
Fields | |
---|---|
public
static
final
Creator<StatusBarNotification> |
CREATOR
|
Public constructors | |
---|---|
StatusBarNotification(String pkg, String opPkg, int id, String tag, int uid, int initialPid, int score, Notification notification, UserHandle user, long postTime)
|
|
StatusBarNotification(Parcel in)
|
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 |
String
|
getKey()
A unique instance key for this notification record. |
Notification
|
getNotification()
The |
String
|
getOverrideGroupKey()
Returns the override group key. |
String
|
getPackageName()
The package of the app that posted the notification. |
long
|
getPostTime()
The time (in |
String
|
getTag()
The tag supplied to |
UserHandle
|
getUser()
The |
int
|
getUserId()
This method was deprecated
in API level 21.
Use |
boolean
|
isClearable()
Convenience method to check the notification's flags for
either |
boolean
|
isGroup()
Returns true if this notification is part of a group. |
boolean
|
isOngoing()
Convenience method to check the notification's flags for
|
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
| |
From
interface
android.os.Parcelable
|
StatusBarNotification (String pkg, String opPkg, int id, String tag, int uid, int initialPid, int score, Notification notification, UserHandle user, long postTime)
Parameters | |
---|---|
pkg |
String
|
opPkg |
String
|
id |
int
|
tag |
String
|
uid |
int
|
initialPid |
int
|
score |
int
|
notification |
Notification
|
user |
UserHandle
|
postTime |
long
|
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:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
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.
The method clone
for class Object
performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable
, then a
CloneNotSupportedException
is thrown. Note that all arrays
are considered to implement the interface Cloneable
and that
the return type of the clone
method of an array type T[]
is T[]
where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object
does not itself implement the interface
Cloneable
, so calling the clone
method on an object
whose class is Object
will result in throwing an
exception at run time.
Returns | |
---|---|
StatusBarNotification |
a clone of this instance. |
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(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. |
String getGroupKey ()
A key that indicates the group with which this message ranks.
Returns | |
---|---|
String |
String getKey ()
A unique instance key for this notification record.
Returns | |
---|---|
String |
Notification getNotification ()
The Notification
supplied to
notify(int, Notification)
.
Returns | |
---|---|
Notification |
String getOverrideGroupKey ()
Returns the override group key.
Returns | |
---|---|
String |
String getPackageName ()
The package of the app that posted the notification.
Returns | |
---|---|
String |
long getPostTime ()
The time (in currentTimeMillis()
time) the notification was posted,
which may be different than when
.
Returns | |
---|---|
long |
String getTag ()
The tag supplied to notify(int, Notification)
,
or null if no tag was specified.
Returns | |
---|---|
String |
UserHandle getUser ()
The UserHandle
for whom this notification is intended.
Returns | |
---|---|
UserHandle |
int getUserId ()
This method was deprecated
in API level 21.
Use getUser()
instead.
Returns a userHandle for the instance of the app that posted this notification.
Returns | |
---|---|
int |
boolean isClearable ()
Convenience method to check the notification's flags for
either FLAG_ONGOING_EVENT
or
FLAG_NO_CLEAR
.
Returns | |
---|---|
boolean |
boolean isGroup ()
Returns true if this notification is part of a group.
Returns | |
---|---|
boolean |
boolean isOngoing ()
Convenience method to check the notification's flags for
FLAG_ONGOING_EVENT
.
Returns | |
---|---|
boolean |
void setOverrideGroupKey (String overrideGroupKey)
Sets the override group key.
Parameters | |
---|---|
overrideGroupKey |
String
|
String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
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. |
flags |
int :
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE .
|