java.lang.Object | |
↳ | android.app.Notification |
A class that represents how a persistent notification is to be presented to the user using the NotificationManager.
For a guide to creating notifications, see the Creating Status Bar Notifications document in the Dev Guide.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creator<Notification> | CREATOR | Parcelable.Creator that instantiates Notification objects | |||||||||
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_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 | 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
audioStreamType | The audio stream type to use when playing the sound. | ||||||||||
contentIntent | The intent to execute when the expanded status entry is clicked. | ||||||||||
contentView | The view that shows when this notification is shown in the expanded status bar. | ||||||||||
defaults | Specifies which values should be taken from the defaults. | ||||||||||
deleteIntent | The intent to execute when the status entry is deleted by the user with the "Clear All Notifications" button. | ||||||||||
flags | |||||||||||
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. | ||||||||||
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. | ||||||||||
sound | The sound to play. | ||||||||||
tickerText | Text to scroll across the screen when this item is added to the status bar. | ||||||||||
vibrate | The pattern with which to vibrate. | ||||||||||
when | The timestamp for the notification. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a Notification object with everything set to 0.
| |||||||||||
Constructs a Notification object with the information needed to
have a status bar icon without the standard expanded view.
| |||||||||||
Unflatten the notification from a parcel.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
Sets the contentView field to be a view with the standard "Latest Event"
layout.
| |||||||||||
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
|
Parcelable.Creator that instantiates Notification objects
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 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.
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_RING.
The audio stream type to use when playing the sound. Should be one of the STREAM_ constants from AudioManager.
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 Activities and Tasks section of the Application Fundamentals document.
The view that shows when this notification is shown 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 status entry is deleted by the user with the "Clear All Notifications" button. This probably shouldn't be launching an activity since several of those will be sent at the same time.
The resource id of a drawable to use as the icon in the status bar.
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 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, if this is the new mail notification, this would be the number of unread messages. This number is be superimposed over the icon in the status bar. If the number is 0 or negative, it is not shown in the status bar.
Text to scroll across the screen when this item is added to the status bar.
The pattern with which to vibrate.
To vibrate the default pattern, see defaults.
The timestamp for the notification. The icons and expanded views are sorted by this key.
Constructs a Notification object with everything set to 0.
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. |
Unflatten the notification from a parcel.
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
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 Application Fundamentals: Activities and Tasks. |
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 simply concatenates the class name, the '@' sign and a hexadecimal representation of the object's hashCode(), that is, it is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
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. |