android.app
Class Notification

java.lang.Object
  android.app.Notification

All Implemented Interfaces:

Parcelable

public class Notification
extends Object
implements Parcelable

A class that represents how a persistent notification is to be presented to the user using the NotificationManager.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.Creator<T>

Field Summary

int	audioStreamType The audio stream type to use when playing the sound.
PendingIntent	contentIntent The intent to execute when the expanded status entry is clicked.
RemoteViews	contentView The view that shows when this notification is shown in the expanded status bar.
static Parcelable.Creator<Notification>	CREATOR Parcelable.Creator that instantiates Notification objects
static int	DEFAULT_ALL Use all default values (where applicable).
static int	DEFAULT_LIGHTS Use the default notification lights.
static int	DEFAULT_SOUND Use the default notification sound.
static int	DEFAULT_VIBRATE Use the default notification vibrate.
int	defaults Specifies which values should be taken from the defaults.
PendingIntent	deleteIntent The intent to execute when the status entry is deleted by the user with the "Clear All Notifications" button.
static 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.
static int	FLAG_INSISTENT Bit to be bitwise-ored into the flags field that if set, the audio and vibration will be repeated until the notification is cancelled.
static 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.
static 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.
static 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.
static 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	flags
int	icon The resource id of a drawable to use as the icon in the status bar.
int	iconLevel If the icon in the status bar is to have more than one level, you can set this.
int	ledARGB The color of the led.
int	ledOffMS The number of milliseconds for the LED to be off while it's flashing.
int	ledOnMS The number of milliseconds for the LED to be on while it's flashing.
int	number The number of events that this notification represents.
Uri	sound The sound to play.
static int	STREAM_DEFAULT Use this constant as the value for audioStreamType to request that the default stream type for notifications be used.
CharSequence	tickerText Text to scroll across the screen when this item is added to the status bar.
long[]	vibrate The pattern with which to vibrate.
long	when The timestamp for the notification.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Notification()
Constructs a Notification object with everything set to 0.

Notification(Context context, int icon, CharSequence tickerText, long when, CharSequence contentTitle, CharSequence contentText, Intent contentIntent)
Deprecated. use Notification(int,CharSequence,long) and setLatestEventInfo(android.content.Context, java.lang.CharSequence, java.lang.CharSequence, android.app.PendingIntent).

Notification(int icon, CharSequence tickerText, long when)
Constructs a Notification object with the information needed to have a status bar icon without the standard expanded view.

Notification(Parcel parcel)
Unflatten the notification from a parcel.

Method Summary

int	describeContents() Describe the kinds of special objects contained in this Parcelable's marshalled representation.
void	setLatestEventInfo(Context context, CharSequence contentTitle, CharSequence contentText, PendingIntent contentIntent) Sets the contentView field to be a view with the standard "Latest Event" layout.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
void	writeToParcel(Parcel parcel, int flags) Flatten this notification from a parcel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ALL

public static final int DEFAULT_ALL

Use all default values (where applicable).

See Also:

Constant Field Values

DEFAULT_SOUND

public static final int DEFAULT_SOUND

Use the default notification sound. This will ignore any given sound.

See Also:

defaults, Constant Field Values

DEFAULT_VIBRATE

public static final int DEFAULT_VIBRATE

Use the default notification vibrate. This will ignore any given vibrate.

See Also:

defaults, Constant Field Values

DEFAULT_LIGHTS

public static final int DEFAULT_LIGHTS

Use the default notification lights. This will ignore the FLAG_SHOW_LIGHTS bit, and ledARGB, ledOffMS, or ledOnMS.

See Also:

defaults, Constant Field Values

when

public long when

The timestamp for the notification. The icons and expanded views are sorted by this key.

icon

public int icon

The resource id of a drawable to use as the icon in the status bar.

number

public int number

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.

contentIntent

public PendingIntent contentIntent

The intent to execute when the expanded status entry is clicked. If this is an activity, it must include the Intent.FLAG_ACTIVITY_NEW_TASK flag, which requires that you take care of task management as described in the application model document.

deleteIntent

public PendingIntent deleteIntent

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.

tickerText

public CharSequence tickerText

Text to scroll across the screen when this item is added to the status bar.

contentView

public RemoteViews contentView

The view that shows when this notification is shown in the expanded status bar.

iconLevel

public int iconLevel

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.

See Also:

ImageView.setImageLevel(int), android.graphics.drawable#setLevel

sound

public Uri sound

The sound to play.

To play the default notification sound, see defaults.

STREAM_DEFAULT

public static final int STREAM_DEFAULT

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.

See Also:

Constant Field Values

audioStreamType

public int audioStreamType

The audio stream type to use when playing the sound. Should be one of the STREAM_ constants from AudioManager.

vibrate

public long[] vibrate

The pattern with which to vibrate. This pattern will repeat if FLAG_INSISTENT bit is set in the flags field.

To vibrate the default pattern, see defaults.

See Also:

Vibrator.vibrate(long[],int)

ledARGB

public int ledARGB

The color of the led. The hardware will do its best approximation.

See Also:

FLAG_SHOW_LIGHTS, flags

ledOnMS

public int ledOnMS

The number of milliseconds for the LED to be on while it's flashing. The hardware will do its best approximation.

See Also:

FLAG_SHOW_LIGHTS, flags

ledOffMS

public int ledOffMS

The number of milliseconds for the LED to be off while it's flashing. The hardware will do its best approximation.

See Also:

FLAG_SHOW_LIGHTS, flags

defaults

public int defaults

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.

FLAG_SHOW_LIGHTS

public static final 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.

• To turn the LED off, pass 0 in the alpha channel for colorARGB or 0 for both ledOnMS and ledOffMS.
• To turn the LED on, pass 1 for ledOnMS and 0 for ledOffMS.
• To flash the LED, pass the number of milliseconds that it should be on and off to ledOnMS and ledOffMS.

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.

See Also:

Constant Field Values

FLAG_ONGOING_EVENT

public static final 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. 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.

See Also:

Constant Field Values

FLAG_INSISTENT

public static final int FLAG_INSISTENT

Bit to be bitwise-ored into the flags field that if set, the audio and vibration will be repeated until the notification is cancelled.

NOTE: This notion will change when we have decided exactly what the UI will be.

See Also:

Constant Field Values

FLAG_ONLY_ALERT_ONCE

public static final 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.

See Also:

Constant Field Values

FLAG_AUTO_CANCEL

public static final 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.

See Also:

Constant Field Values

FLAG_NO_CLEAR

public static final 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.

See Also:

Constant Field Values

flags

public int flags

CREATOR

public static final Parcelable.Creator<Notification> CREATOR

Parcelable.Creator that instantiates Notification objects

Constructor Detail

Notification

public Notification()

Constructs a Notification object with everything set to 0.

Notification

public Notification(Context context,
                    int icon,
                    CharSequence tickerText,
                    long when,
                    CharSequence contentTitle,
                    CharSequence contentText,
                    Intent contentIntent)

Deprecated. use Notification(int,CharSequence,long) and setLatestEventInfo(android.content.Context, java.lang.CharSequence, java.lang.CharSequence, android.app.PendingIntent).

Notification

public Notification(int icon,
                    CharSequence tickerText,
                    long when)

Constructs a Notification object with the information needed to have a status bar icon without the standard expanded view.

Parameters:

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.

Notification

public Notification(Parcel parcel)

Unflatten the notification from a parcel.

Method Detail

describeContents

public int describeContents()

Description copied from interface: Parcelable

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Specified by:

describeContents in interface Parcelable

Returns:

a bitmask indicating the set of special object types marshalled by the Parcelable.

writeToParcel

public void writeToParcel(Parcel parcel,
                          int flags)

Flatten this notification from a parcel.

Specified by:

writeToParcel in interface Parcelable

Parameters:

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.PARCELABLE_WRITE_RETURN_VALUE.

setLatestEventInfo

public void setLatestEventInfo(Context context,
                               CharSequence contentTitle,
                               CharSequence contentText,
                               PendingIntent contentIntent)

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.

Parameters:

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 Intent.FLAG_ACTIVITY_NEW_TASK flag, which requires that you take care of task management as described in the application model document.

toString

public String toString()

Description copied from class: Object

Returns a string containing a concise, human-readable description of the receiver.

Overrides:

toString in class Object

Returns:

String a printable representation for the receiver.