java.lang.Object | |
↳ | android.app.Notification |
A class that represents how a persistent notification is to be presented to
the user using the NotificationManager
.
The Notification.Builder
has been added to make it
easier to construct Notifications.
For a guide to creating notifications, read the Status Bar Notifications developer guide.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Notification.BigPictureStyle | Helper class for generating large-format notifications that include a large image attachment. | ||||||||||
Notification.BigTextStyle | Helper class for generating large-format notifications that include a lot of text. | ||||||||||
Notification.Builder | Builder class for Notification objects. |
||||||||||
Notification.InboxStyle | Helper class for generating large-format notifications that include a list of (up to 5) strings. | ||||||||||
Notification.Style | An object that can apply a rich notification style to a Notification.Builder
object. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | DEFAULT_ALL | Use all default values (where applicable). | |||||||||
int | DEFAULT_LIGHTS | Use the default notification lights. | |||||||||
int | DEFAULT_SOUND | Use the default notification sound. | |||||||||
int | DEFAULT_VIBRATE | Use the default notification vibrate. | |||||||||
int | FLAG_AUTO_CANCEL | Bit to be bitwise-ored into the flags field that should be
set if the notification should be canceled when it is clicked by the
user. |
|||||||||
int | FLAG_FOREGROUND_SERVICE | Bit to be bitwise-ored into the flags field that should be
set if this notification represents a currently running service. |
|||||||||
int | FLAG_HIGH_PRIORITY |
This constant was deprecated
in API level 16.
Use priority with a positive value.
|
|||||||||
int | FLAG_INSISTENT | Bit to be bitwise-ored into the flags field that if set,
the audio will be repeated until the notification is
cancelled or the notification window is opened. |
|||||||||
int | FLAG_NO_CLEAR | Bit to be bitwise-ored into the flags field that should be
set if the notification should not be canceled when the user clicks
the Clear all button. |
|||||||||
int | FLAG_ONGOING_EVENT | Bit to be bitwise-ored into the flags field that should be
set if this notification is in reference to something that is ongoing,
like a phone call. |
|||||||||
int | FLAG_ONLY_ALERT_ONCE | Bit to be bitwise-ored into the flags field that should be
set if you want the sound and/or vibration play each time the
notification is sent, even if it has not been canceled before that. |
|||||||||
int | FLAG_SHOW_LIGHTS | Bit to be bitwise-ored into the flags field that should be
set if you want the LED on for this notification. |
|||||||||
int | PRIORITY_DEFAULT | Default notification priority . |
|||||||||
int | PRIORITY_HIGH | Higher priority , for more important notifications or alerts. |
|||||||||
int | PRIORITY_LOW | Lower priority , for items that are less important. |
|||||||||
int | PRIORITY_MAX | Highest priority , for your application's most important items that require the
user's prompt attention or input. |
|||||||||
int | PRIORITY_MIN | Lowest priority ; these items might not be shown to the user except under special
circumstances, such as detailed notification logs. |
|||||||||
int | STREAM_DEFAULT | Use this constant as the value for audioStreamType to request that the default stream type for notifications be used. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR | Parcelable.Creator that instantiates Notification objects | ||||||||||
audioStreamType | The audio stream type to use when playing the sound. | ||||||||||
bigContentView | A large-format version of contentView , giving the Notification an
opportunity to show more detail. |
||||||||||
contentIntent | The intent to execute when the expanded status entry is clicked. | ||||||||||
contentView | The view that will represent this notification in the expanded status bar. | ||||||||||
defaults | Specifies which values should be taken from the defaults. | ||||||||||
deleteIntent | The intent to execute when the notification is explicitly dismissed by the user, either with the "Clear All" button or by swiping it away individually. | ||||||||||
flags | |||||||||||
fullScreenIntent | An intent to launch instead of posting the notification to the status bar. | ||||||||||
icon | The resource id of a drawable to use as the icon in the status bar. | ||||||||||
iconLevel | If the icon in the status bar is to have more than one level, you can set this. | ||||||||||
largeIcon | The bitmap that may escape the bounds of the panel and bar. | ||||||||||
ledARGB | The color of the led. | ||||||||||
ledOffMS | The number of milliseconds for the LED to be off while it's flashing. | ||||||||||
ledOnMS | The number of milliseconds for the LED to be on while it's flashing. | ||||||||||
number | The number of events that this notification represents. | ||||||||||
priority | Relative priority for this notification. | ||||||||||
sound | The sound to play. | ||||||||||
tickerText | Text to scroll across the screen when this item is added to the status bar on large and smaller devices. | ||||||||||
tickerView | The view to show as the ticker in the status bar when the notification is posted. | ||||||||||
vibrate | The pattern with which to vibrate. | ||||||||||
when | A timestamp related to this notification, in milliseconds since the epoch. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a Notification object with default values.
| |||||||||||
This constructor was deprecated
in API level 11.
Use
Notification.Builder instead.
| |||||||||||
Unflatten the notification from a parcel.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates and returns a copy of this
Object . | |||||||||||
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
This method was deprecated
in API level 11.
Use
Notification.Builder instead.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
Flatten this notification from a parcel.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
android.os.Parcelable
|
Use all default values (where applicable).
Use the default notification lights. This will ignore the
FLAG_SHOW_LIGHTS
bit, and ledARGB
, ledOffMS
, or
ledOnMS
.
Bit to be bitwise-ored into the flags
field that should be
set if the notification should be canceled when it is clicked by the
user.
Bit to be bitwise-ored into the flags
field that should be
set if this notification represents a currently running service. This
will normally be set for you by startForeground(int, Notification)
.
This constant was deprecated
in API level 16.
Use priority
with a positive value.
Obsolete flag indicating high-priority notifications; use the priority field instead.
Bit to be bitwise-ored into the flags
field that if set,
the audio will be repeated until the notification is
cancelled or the notification window is opened.
Bit to be bitwise-ored into the flags
field that should be
set if the notification should not be canceled when the user clicks
the Clear all button.
Bit to be bitwise-ored into the flags
field that should be
set if this notification is in reference to something that is ongoing,
like a phone call. It should not be set if this notification is in
reference to something that happened at a particular point in time,
like a missed phone call.
Bit to be bitwise-ored into the flags
field that should be
set if you want the sound and/or vibration play each time the
notification is sent, even if it has not been canceled before that.
Bit to be bitwise-ored into the flags
field that should be
set if you want the LED on for this notification.
Since hardware varies, you are not guaranteed that any of the values you pass are honored exactly. Use the system defaults (TODO) if possible because they will be set to values that work on any given hardware.
The alpha channel must be set for forward compatibility.
Default notification priority
. If your application does not prioritize its own
notifications, use this value for all notifications.
Higher priority
, for more important notifications or alerts. The UI may choose to
show these items larger, or at a different position in notification lists, compared with
your app's PRIORITY_DEFAULT
items.
Lower priority
, for items that are less important. The UI may choose to show these
items smaller, or at a different position in the list, compared with your app's
PRIORITY_DEFAULT
items.
Highest priority
, for your application's most important items that require the
user's prompt attention or input.
Lowest priority
; these items might not be shown to the user except under special
circumstances, such as detailed notification logs.
Use this constant as the value for audioStreamType to request that
the default stream type for notifications be used. Currently the
default stream type is STREAM_NOTIFICATION
.
Parcelable.Creator that instantiates Notification objects
The audio stream type to use when playing the sound.
Should be one of the STREAM_ constants from
AudioManager
.
A large-format version of contentView
, giving the Notification an
opportunity to show more detail. The system UI may choose to show this
instead of the normal content view at its discretion.
The intent to execute when the expanded status entry is clicked. If
this is an activity, it must include the
FLAG_ACTIVITY_NEW_TASK
flag, which requires
that you take care of task management as described in the
Tasks and Back
Stack document. In particular, make sure to read the notification section
Handling
Notifications for the correct ways to launch an application from a
notification.
The view that will represent this notification in the expanded status bar.
Specifies which values should be taken from the defaults.
To set, OR the desired from DEFAULT_SOUND
,
DEFAULT_VIBRATE
, DEFAULT_LIGHTS
. For all default
values, use DEFAULT_ALL
.
The intent to execute when the notification is explicitly dismissed by the user, either with the "Clear All" button or by swiping it away individually. This probably shouldn't be launching an activity since several of those will be sent at the same time.
An intent to launch instead of posting the notification to the status bar.
The resource id of a drawable to use as the icon in the status bar. This is required; notifications with an invalid icon resource will not be shown.
If the icon in the status bar is to have more than one level, you can set this. Otherwise, leave it at its default value of 0.
The bitmap that may escape the bounds of the panel and bar.
The color of the led. The hardware will do its best approximation.
The number of milliseconds for the LED to be off while it's flashing. The hardware will do its best approximation.
The number of milliseconds for the LED to be on while it's flashing. The hardware will do its best approximation.
The number of events that this notification represents. For example, in a new mail
notification, this could be the number of unread messages.
The system may or may not use this field to modify the appearance of the notification. For
example, before HONEYCOMB
, this number was
superimposed over the icon in the status bar. Starting with
HONEYCOMB
, the template used by
Notification.Builder
has displayed the number in the expanded notification view.
If the number is 0 or negative, it is never shown.
Relative priority for this notification. Priority is an indication of how much of the user's valuable attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The system will make a determination about how to interpret this priority when presenting the notification.
The sound to play.
To play the default notification sound, see defaults
.
Text to scroll across the screen when this item is added to the status bar on large and smaller devices.
The view to show as the ticker in the status bar when the notification is posted.
The pattern with which to vibrate.
To vibrate the default pattern, see defaults
.
A timestamp related to this notification, in milliseconds since the epoch.
Default value: Now
.
Choose a timestamp that will be most relevant to the user. For most finite events, this
corresponds to the time the event happened (or will happen, in the case of events that have
yet to occur but about which the user is being informed). Indefinite events should be
timestamped according to when the activity began.
Some examples:
Constructs a Notification object with default values.
You might want to consider using Notification.Builder
instead.
This constructor was deprecated
in API level 11.
Use Notification.Builder
instead.
Constructs a Notification object with the information needed to have a status bar icon without the standard expanded view.
icon | The resource id of the icon to put in the status bar. |
---|---|
tickerText | The text that flows by in the status bar when the notification first activates. |
when | The time to show in the time field. In the System.currentTimeMillis timebase. |
Creates and returns a copy of this Object
. The default
implementation returns a so-called "shallow" copy: It creates a new
instance of the same class and then copies the field values (including
object references) from this instance to the new instance. A "deep" copy,
in contrast, would also recursively clone nested objects. A subclass that
needs to implement this kind of cloning should call super.clone()
to create the new instance and then create deep copies of the nested,
mutable objects.
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
This method was deprecated
in API level 11.
Use Notification.Builder
instead.
Sets the contentView
field to be a view with the standard "Latest Event"
layout.
Uses the icon
and when
fields to set the icon and time fields
in the view.
context | The context for your application / activity. |
---|---|
contentTitle | The title that goes in the expanded entry. |
contentText | The text that goes in the expanded entry. |
contentIntent | The intent to launch when the user clicks the expanded notification.
If this is an activity, it must include the
FLAG_ACTIVITY_NEW_TASK flag, which requires
that you take care of task management as described in the
Tasks and Back
Stack document. |
Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString
method
if you intend implementing your own toString
method.
Flatten this notification from a parcel.
parcel | The Parcel in which the object should be written. |
---|---|
flags | Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE .
|