Skip to content

Most visited

Recently visited

navigation

Notification

public class Notification
extends Object implements Parcelable

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.

Developer Guides

For a guide to creating notifications, read the Status Bar Notifications developer guide.

Summary

Nested classes

class Notification.Action

Structure to encapsulate a named action that can be shown as part of this notification. 

class Notification.BigPictureStyle

Helper class for generating large-format notifications that include a large image attachment. 

class Notification.BigTextStyle

Helper class for generating large-format notifications that include a lot of text. 

class Notification.Builder

Builder class for Notification objects. 

class Notification.CarExtender

Helper class to add Android Auto extensions to notifications. 

class Notification.DecoratedCustomViewStyle

Notification style for custom views that are decorated by the system

Instead of providing a notification that is completely custom, a developer can set this style and still obtain system decorations like the notification header with the expand affordance and actions. 

class Notification.DecoratedMediaCustomViewStyle

Notification style for media custom views that are decorated by the system

Instead of providing a media notification that is completely custom, a developer can set this style and still obtain system decorations like the notification header with the expand affordance and actions. 

interface Notification.Extender

Extender interface for use with extend(Notification.Action.Extender)

class Notification.InboxStyle

Helper class for generating large-format notifications that include a list of (up to 5) strings. 

class Notification.MediaStyle

Notification style for media playback notifications. 

class Notification.MessagingStyle

Helper class for generating large-format notifications that include multiple back-and-forth messages of varying types between any number of people. 

class Notification.Style

An object that can apply a rich notification style to a Notification.Builder object. 

class Notification.WearableExtender

Helper class to add wearable extensions to notifications. 

Constants

String CATEGORY_ALARM

Notification category: alarm or timer.

String CATEGORY_CALL

Notification category: incoming call (voice or video) or similar synchronous communication request.

String CATEGORY_EMAIL

Notification category: asynchronous bulk message (email).

String CATEGORY_ERROR

Notification category: error in background operation or authentication status.

String CATEGORY_EVENT

Notification category: calendar event.

String CATEGORY_MESSAGE

Notification category: incoming direct message (SMS, instant message, etc.).

String CATEGORY_PROGRESS

Notification category: progress of a long-running background operation.

String CATEGORY_PROMO

Notification category: promotion or advertisement.

String CATEGORY_RECOMMENDATION

Notification category: a specific, timely recommendation for a single thing.

String CATEGORY_REMINDER

Notification category: user-scheduled reminder.

String CATEGORY_SERVICE

Notification category: indication of running background service.

String CATEGORY_SOCIAL

Notification category: social network or sharing update.

String CATEGORY_STATUS

Notification category: ongoing information about device or contextual status.

String CATEGORY_SYSTEM

Notification category: system or device status update.

String CATEGORY_TRANSPORT

Notification category: media transport control for playback.

int COLOR_DEFAULT

Special value of color telling the system not to decorate this notification with any special color but instead use default colors when presenting this notification.

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.

String EXTRA_BACKGROUND_IMAGE_URI

extras key: A content URI pointing to an image that can be displayed in the background when the notification is selected.

String EXTRA_BIG_TEXT

extras key: this is the longer text shown in the big form of a Notification.BigTextStyle notification, as supplied to bigText(CharSequence).

String EXTRA_CHRONOMETER_COUNT_DOWN

extras key: whether the chronometer set on the notification should count down instead of counting up.

String EXTRA_COMPACT_ACTIONS

extras key: the indices of actions to be shown in the compact view, as supplied to (e.g.) setShowActionsInCompactView(int).

String EXTRA_CONVERSATION_TITLE

extras key: a CharSequence to be displayed as the title to a conversation represented by a Notification.MessagingStyle

String EXTRA_INFO_TEXT

extras key: this is a small piece of additional text as supplied to setContentInfo(CharSequence).

String EXTRA_LARGE_ICON

extras key: this is a bitmap to be used instead of the small icon when showing the notification payload, as supplied to setLargeIcon(android.graphics.Bitmap).

String EXTRA_LARGE_ICON_BIG

extras key: this is a bitmap to be used instead of the one from setLargeIcon(android.graphics.Bitmap) when the notification is shown in its expanded form, as supplied to bigLargeIcon(android.graphics.Bitmap).

String EXTRA_MEDIA_SESSION

extras key: A MediaSession.Token associated with a Notification.MediaStyle notification.

String EXTRA_MESSAGES

extras key: an array of Notification.MessagingStyle.Message bundles provided by a Notification.MessagingStyle notification.

String EXTRA_PEOPLE

extras key: A String array containing the people that this notification relates to, each of which was supplied to addPerson(String).

String EXTRA_PICTURE

extras key: this is a bitmap to be shown in Notification.BigPictureStyle expanded notifications, supplied to bigPicture(android.graphics.Bitmap).

String EXTRA_PROGRESS

extras key: this is the progress value supplied to setProgress(int, int, boolean).

String EXTRA_PROGRESS_INDETERMINATE

extras key: whether the progress bar is indeterminate, supplied to setProgress(int, int, boolean).

String EXTRA_PROGRESS_MAX

extras key: this is the maximum value supplied to setProgress(int, int, boolean).

String EXTRA_REMOTE_INPUT_HISTORY

extras key: this is the remote input history, as supplied to setRemoteInputHistory(CharSequence[]).

String EXTRA_SELF_DISPLAY_NAME

extras key: the username to be displayed for all messages sent by the user including direct replies Notification.MessagingStyle notification.

String EXTRA_SHOW_CHRONOMETER

extras key: whether when should be shown as a count-up timer (specifically a Chronometer) instead of a timestamp, as supplied to setUsesChronometer(boolean).

String EXTRA_SHOW_WHEN

extras key: whether when should be shown, as supplied to setShowWhen(boolean).

String EXTRA_SMALL_ICON

extras key: this is the resource ID of the notification's main small icon, as supplied to setSmallIcon(int).

String EXTRA_SUB_TEXT

extras key: this is a third line of text, as supplied to setSubText(CharSequence).

String EXTRA_SUMMARY_TEXT

extras key: this is a line of summary information intended to be shown alongside expanded notifications, as supplied to (e.g.) setSummaryText(CharSequence).

String EXTRA_TEMPLATE

extras key: A string representing the name of the specific Notification.Style used to create this notification.

String EXTRA_TEXT

extras key: this is the main text payload, as supplied to setContentText(CharSequence).

String EXTRA_TEXT_LINES

extras key: An array of CharSequences to show in Notification.InboxStyle expanded notifications, each of which was supplied to addLine(CharSequence).

String EXTRA_TITLE

extras key: this is the title of the notification, as supplied to setContentTitle(CharSequence).

String EXTRA_TITLE_BIG

extras key: this is the title of the notification when shown in expanded form, e.g.

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_GROUP_SUMMARY

Bit to be bitswise-ored into the flags field that should be set if this notification is the group summary for a group of notifications.

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_LOCAL_ONLY

Bit to be bitswise-ored into the flags field that should be set if this notification is relevant to the current device only and it is not recommended that it bridge to other devices.

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 would only like the sound, vibrate and ticker to be played if the notification was not already showing.

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.

String INTENT_CATEGORY_NOTIFICATION_PREFERENCES

An activity that provides a user interface for adjusting notification preferences for its containing application.

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

This constant was deprecated in API level 21. Use audioAttributes instead.

int VISIBILITY_PRIVATE

Notification visibility: Show this notification on all lockscreens, but conceal sensitive or private information on secure lockscreens.

int VISIBILITY_PUBLIC

Notification visibility: Show this notification in its entirety on all lockscreens.

int VISIBILITY_SECRET

Notification visibility: Do not reveal any part of this notification on a secure lockscreen.

Inherited constants

From interface android.os.Parcelable

Fields

public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT

The default value of audioAttributes.

public static final Creator<Notification> CREATOR

Parcelable.Creator that instantiates Notification objects

public Action[] actions

Array of all Notification.Action structures attached to this notification by addAction(int, CharSequence, PendingIntent).

public AudioAttributes audioAttributes

The audio attributes to use when playing the sound.

public int audioStreamType

This field was deprecated in API level 21. Use audioAttributes instead.

public RemoteViews bigContentView

A large-format version of contentView, giving the Notification an opportunity to show more detail.

public String category

One of the predefined notification categories (see the CATEGORY_* constants) that best describes this Notification.

public int color

Accent color (an ARGB integer like the constants in Color) to be applied by the standard Style templates when presenting this notification.

public PendingIntent contentIntent

The intent to execute when the expanded status entry is clicked.

public RemoteViews contentView

The view that will represent this notification in the notification list (which is pulled down from the status bar).

public int defaults

Specifies which values should be taken from the defaults.

public PendingIntent 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.

public Bundle extras

Additional semantic data to be carried around with this Notification.

public int flags

public PendingIntent fullScreenIntent

An intent to launch instead of posting the notification to the status bar.

public RemoteViews headsUpContentView

A medium-format version of contentView, providing the Notification an opportunity to add action buttons to contentView.

public int icon

This field was deprecated in API level 23. Use setSmallIcon(Icon) instead.

public int iconLevel

If the icon in the status bar is to have more than one level, you can set this.

public Bitmap largeIcon

This field was deprecated in API level 23. Use setLargeIcon(Icon) instead.

public int ledARGB

The color of the led.

public int ledOffMS

The number of milliseconds for the LED to be off while it's flashing.

public int ledOnMS

The number of milliseconds for the LED to be on while it's flashing.

public int number

This field was deprecated in API level 24. this number is not shown anymore

public int priority

Relative priority for this notification.

public Notification publicVersion

Replacement version of this notification whose content will be shown in an insecure context such as atop a secure keyguard.

public Uri sound

The sound to play.

public CharSequence tickerText

Text that summarizes this notification for accessibility services.

public RemoteViews tickerView

Formerly, a view showing the tickerText.

public long[] vibrate

The pattern with which to vibrate.

public int visibility

Sphere of visibility of this notification, which affects how and when the SystemUI reveals the notification's presence and contents in untrusted situations (namely, on the secure lockscreen).

public long when

A timestamp related to this notification, in milliseconds since the epoch.

Public constructors

Notification()

Constructs a Notification object with default values.

Notification(int icon, CharSequence tickerText, long when)

This constructor was deprecated in API level 11. Use Notification.Builder instead.

Notification(Parcel parcel)

Unflatten the notification from a parcel.

Public methods

Notification 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 getGroup()

Get the key used to group this notification into a cluster or stack with other notifications on devices which support such rendering.

Icon getLargeIcon()

The large icon shown in this notification's content view.

Icon getSmallIcon()

The small icon representing this notification in the status bar and content view.

String getSortKey()

Get a sort key that orders this notification among other notifications from the same package.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this notification into a parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

CATEGORY_ALARM

Added in API level 21
String CATEGORY_ALARM

Notification category: alarm or timer.

Constant Value: "alarm"

CATEGORY_CALL

Added in API level 21
String CATEGORY_CALL

Notification category: incoming call (voice or video) or similar synchronous communication request.

Constant Value: "call"

CATEGORY_EMAIL

Added in API level 21
String CATEGORY_EMAIL

Notification category: asynchronous bulk message (email).

Constant Value: "email"

CATEGORY_ERROR

Added in API level 21
String CATEGORY_ERROR

Notification category: error in background operation or authentication status.

Constant Value: "err"

CATEGORY_EVENT

Added in API level 21
String CATEGORY_EVENT

Notification category: calendar event.

Constant Value: "event"

CATEGORY_MESSAGE

Added in API level 21
String CATEGORY_MESSAGE

Notification category: incoming direct message (SMS, instant message, etc.).

Constant Value: "msg"

CATEGORY_PROGRESS

Added in API level 21
String CATEGORY_PROGRESS

Notification category: progress of a long-running background operation.

Constant Value: "progress"

CATEGORY_PROMO

Added in API level 21
String CATEGORY_PROMO

Notification category: promotion or advertisement.

Constant Value: "promo"

CATEGORY_RECOMMENDATION

Added in API level 21
String CATEGORY_RECOMMENDATION

Notification category: a specific, timely recommendation for a single thing. For example, a news app might want to recommend a news story it believes the user will want to read next.

Constant Value: "recommendation"

CATEGORY_REMINDER

Added in API level 23
String CATEGORY_REMINDER

Notification category: user-scheduled reminder.

Constant Value: "reminder"

CATEGORY_SERVICE

Added in API level 21
String CATEGORY_SERVICE

Notification category: indication of running background service.

Constant Value: "service"

CATEGORY_SOCIAL

Added in API level 21
String CATEGORY_SOCIAL

Notification category: social network or sharing update.

Constant Value: "social"

CATEGORY_STATUS

Added in API level 21
String CATEGORY_STATUS

Notification category: ongoing information about device or contextual status.

Constant Value: "status"

CATEGORY_SYSTEM

Added in API level 21
String CATEGORY_SYSTEM

Notification category: system or device status update. Reserved for system use.

Constant Value: "sys"

CATEGORY_TRANSPORT

Added in API level 21
String CATEGORY_TRANSPORT

Notification category: media transport control for playback.

Constant Value: "transport"

COLOR_DEFAULT

Added in API level 21
int COLOR_DEFAULT

Special value of color telling the system not to decorate this notification with any special color but instead use default colors when presenting this notification.

Constant Value: 0 (0x00000000)

DEFAULT_ALL

Added in API level 1
int DEFAULT_ALL

Use all default values (where applicable).

Constant Value: -1 (0xffffffff)

DEFAULT_LIGHTS

Added in API level 1
int DEFAULT_LIGHTS

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

See also:

Constant Value: 4 (0x00000004)

DEFAULT_SOUND

Added in API level 1
int DEFAULT_SOUND

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

A notification that is noisy is more likely to be presented as a heads-up notification.

See also:

Constant Value: 1 (0x00000001)

DEFAULT_VIBRATE

Added in API level 1
int DEFAULT_VIBRATE

Use the default notification vibrate. This will ignore any given vibrate. Using phone vibration requires the VIBRATE permission.

A notification that vibrates is more likely to be presented as a heads-up notification.

See also:

Constant Value: 2 (0x00000002)

EXTRA_BACKGROUND_IMAGE_URI

Added in API level 21
String EXTRA_BACKGROUND_IMAGE_URI

extras key: A content URI pointing to an image that can be displayed in the background when the notification is selected. The URI must point to an image stream suitable for passing into BitmapFactory.decodeStream; all other content types will be ignored. The content provider URI used for this purpose must require no permissions to read the image data.

Constant Value: "android.backgroundImageUri"

EXTRA_BIG_TEXT

Added in API level 21
String EXTRA_BIG_TEXT

extras key: this is the longer text shown in the big form of a Notification.BigTextStyle notification, as supplied to bigText(CharSequence).

Constant Value: "android.bigText"

EXTRA_CHRONOMETER_COUNT_DOWN

Added in API level 24
String EXTRA_CHRONOMETER_COUNT_DOWN

extras key: whether the chronometer set on the notification should count down instead of counting up. Is only relevant if key EXTRA_SHOW_CHRONOMETER is present. This extra is a boolean. The default is false.

Constant Value: "android.chronometerCountDown"

EXTRA_COMPACT_ACTIONS

Added in API level 21
String EXTRA_COMPACT_ACTIONS

extras key: the indices of actions to be shown in the compact view, as supplied to (e.g.) setShowActionsInCompactView(int).

Constant Value: "android.compactActions"

EXTRA_CONVERSATION_TITLE

Added in API level 24
String EXTRA_CONVERSATION_TITLE

extras key: a CharSequence to be displayed as the title to a conversation represented by a Notification.MessagingStyle

Constant Value: "android.conversationTitle"

EXTRA_INFO_TEXT

Added in API level 19
String EXTRA_INFO_TEXT

extras key: this is a small piece of additional text as supplied to setContentInfo(CharSequence).

Constant Value: "android.infoText"

EXTRA_LARGE_ICON

Added in API level 19
String EXTRA_LARGE_ICON

extras key: this is a bitmap to be used instead of the small icon when showing the notification payload, as supplied to setLargeIcon(android.graphics.Bitmap).

Constant Value: "android.largeIcon"

EXTRA_LARGE_ICON_BIG

Added in API level 19
String EXTRA_LARGE_ICON_BIG

extras key: this is a bitmap to be used instead of the one from setLargeIcon(android.graphics.Bitmap) when the notification is shown in its expanded form, as supplied to bigLargeIcon(android.graphics.Bitmap).

Constant Value: "android.largeIcon.big"

EXTRA_MEDIA_SESSION

Added in API level 21
String EXTRA_MEDIA_SESSION

extras key: A MediaSession.Token associated with a Notification.MediaStyle notification.

Constant Value: "android.mediaSession"

EXTRA_MESSAGES

Added in API level 24
String EXTRA_MESSAGES

extras key: an array of Notification.MessagingStyle.Message bundles provided by a Notification.MessagingStyle notification. This extra is a parcelable array of bundles.

Constant Value: "android.messages"

EXTRA_PEOPLE

Added in API level 19
String EXTRA_PEOPLE

extras key: A String array containing the people that this notification relates to, each of which was supplied to addPerson(String).

Constant Value: "android.people"

EXTRA_PICTURE

Added in API level 19
String EXTRA_PICTURE

extras key: this is a bitmap to be shown in Notification.BigPictureStyle expanded notifications, supplied to bigPicture(android.graphics.Bitmap).

Constant Value: "android.picture"

EXTRA_PROGRESS

Added in API level 19
String EXTRA_PROGRESS

extras key: this is the progress value supplied to setProgress(int, int, boolean).

Constant Value: "android.progress"

EXTRA_PROGRESS_INDETERMINATE

Added in API level 19
String EXTRA_PROGRESS_INDETERMINATE

extras key: whether the progress bar is indeterminate, supplied to setProgress(int, int, boolean).

Constant Value: "android.progressIndeterminate"

EXTRA_PROGRESS_MAX

Added in API level 19
String EXTRA_PROGRESS_MAX

extras key: this is the maximum value supplied to setProgress(int, int, boolean).

Constant Value: "android.progressMax"

EXTRA_REMOTE_INPUT_HISTORY

Added in API level 24
String EXTRA_REMOTE_INPUT_HISTORY

extras key: this is the remote input history, as supplied to setRemoteInputHistory(CharSequence[]). Apps can fill this through setRemoteInputHistory(CharSequence[]) with the most recent inputs that have been sent through a RemoteInput of this Notification and are expected to clear it once the it is no longer relevant (e.g. for chat notifications once the other party has responded). The extra with this key is of type CharSequence[] and contains the most recent entry at the 0 index, the second most recent at the 1 index, etc.

See also:

Constant Value: "android.remoteInputHistory"

EXTRA_SELF_DISPLAY_NAME

Added in API level 24
String EXTRA_SELF_DISPLAY_NAME

extras key: the username to be displayed for all messages sent by the user including direct replies Notification.MessagingStyle notification. This extra is a CharSequence

Constant Value: "android.selfDisplayName"

EXTRA_SHOW_CHRONOMETER

Added in API level 19
String EXTRA_SHOW_CHRONOMETER

extras key: whether when should be shown as a count-up timer (specifically a Chronometer) instead of a timestamp, as supplied to setUsesChronometer(boolean).

Constant Value: "android.showChronometer"

EXTRA_SHOW_WHEN

Added in API level 19
String EXTRA_SHOW_WHEN

extras key: whether when should be shown, as supplied to setShowWhen(boolean).

Constant Value: "android.showWhen"

EXTRA_SMALL_ICON

Added in API level 19
String EXTRA_SMALL_ICON

extras key: this is the resource ID of the notification's main small icon, as supplied to setSmallIcon(int).

Constant Value: "android.icon"

EXTRA_SUB_TEXT

Added in API level 19
String EXTRA_SUB_TEXT

extras key: this is a third line of text, as supplied to setSubText(CharSequence).

Constant Value: "android.subText"

EXTRA_SUMMARY_TEXT

Added in API level 19
String EXTRA_SUMMARY_TEXT

extras key: this is a line of summary information intended to be shown alongside expanded notifications, as supplied to (e.g.) setSummaryText(CharSequence).

Constant Value: "android.summaryText"

EXTRA_TEMPLATE

Added in API level 21
String EXTRA_TEMPLATE

extras key: A string representing the name of the specific Notification.Style used to create this notification.

Constant Value: "android.template"

EXTRA_TEXT

Added in API level 19
String EXTRA_TEXT

extras key: this is the main text payload, as supplied to setContentText(CharSequence).

Constant Value: "android.text"

EXTRA_TEXT_LINES

Added in API level 19
String EXTRA_TEXT_LINES

extras key: An array of CharSequences to show in Notification.InboxStyle expanded notifications, each of which was supplied to addLine(CharSequence).

Constant Value: "android.textLines"

EXTRA_TITLE

Added in API level 19
String EXTRA_TITLE

extras key: this is the title of the notification, as supplied to setContentTitle(CharSequence).

Constant Value: "android.title"

EXTRA_TITLE_BIG

Added in API level 19
String EXTRA_TITLE_BIG

extras key: this is the title of the notification when shown in expanded form, e.g. as supplied to setBigContentTitle(CharSequence).

Constant Value: "android.title.big"

FLAG_AUTO_CANCEL

Added in API level 1
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.

Constant Value: 16 (0x00000010)

FLAG_FOREGROUND_SERVICE

Added in API level 5
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. This will normally be set for you by startForeground(int, Notification).

Constant Value: 64 (0x00000040)

FLAG_GROUP_SUMMARY

Added in API level 20
int FLAG_GROUP_SUMMARY

Bit to be bitswise-ored into the flags field that should be set if this notification is the group summary for a group of notifications. Grouped notifications may display in a cluster or stack on devices which support such rendering. Requires a group key also be set using setGroup(String).

Constant Value: 512 (0x00000200)

FLAG_HIGH_PRIORITY

Added in API level 11
int FLAG_HIGH_PRIORITY

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.

Constant Value: 128 (0x00000080)

FLAG_INSISTENT

Added in API level 1
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.

Constant Value: 4 (0x00000004)

FLAG_LOCAL_ONLY

Added in API level 20
int FLAG_LOCAL_ONLY

Bit to be bitswise-ored into the flags field that should be set if this notification is relevant to the current device only and it is not recommended that it bridge to other devices.

Constant Value: 256 (0x00000100)

FLAG_NO_CLEAR

Added in API level 1
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.

Constant Value: 32 (0x00000020)

FLAG_ONGOING_EVENT

Added in API level 1
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.

Constant Value: 2 (0x00000002)

FLAG_ONLY_ALERT_ONCE

Added in API level 1
int FLAG_ONLY_ALERT_ONCE

Bit to be bitwise-ored into the flags field that should be set if you would only like the sound, vibrate and ticker to be played if the notification was not already showing.

Constant Value: 8 (0x00000008)

FLAG_SHOW_LIGHTS

Added in API level 1
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.

Constant Value: 1 (0x00000001)

INTENT_CATEGORY_NOTIFICATION_PREFERENCES

Added in API level 21
String INTENT_CATEGORY_NOTIFICATION_PREFERENCES

An activity that provides a user interface for adjusting notification preferences for its containing application. Optional but recommended for apps that post Notifications.

Constant Value: "android.intent.category.NOTIFICATION_PREFERENCES"

PRIORITY_DEFAULT

Added in API level 16
int PRIORITY_DEFAULT

Default notification priority. If your application does not prioritize its own notifications, use this value for all notifications.

Constant Value: 0 (0x00000000)

PRIORITY_HIGH

Added in API level 16
int PRIORITY_HIGH

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.

Constant Value: 1 (0x00000001)

PRIORITY_LOW

Added in API level 16
int PRIORITY_LOW

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.

Constant Value: -1 (0xffffffff)

PRIORITY_MAX

Added in API level 16
int PRIORITY_MAX

Highest priority, for your application's most important items that require the user's prompt attention or input.

Constant Value: 2 (0x00000002)

PRIORITY_MIN

Added in API level 16
int PRIORITY_MIN

Lowest priority; these items might not be shown to the user except under special circumstances, such as detailed notification logs.

Constant Value: -2 (0xfffffffe)

STREAM_DEFAULT

Added in API level 1
int STREAM_DEFAULT

This constant was deprecated in API level 21.
Use audioAttributes instead.

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.

Constant Value: -1 (0xffffffff)

VISIBILITY_PRIVATE

Added in API level 21
int VISIBILITY_PRIVATE

Notification visibility: Show this notification on all lockscreens, but conceal sensitive or private information on secure lockscreens.

See also:

Constant Value: 0 (0x00000000)

VISIBILITY_PUBLIC

Added in API level 21
int VISIBILITY_PUBLIC

Notification visibility: Show this notification in its entirety on all lockscreens.

See also:

Constant Value: 1 (0x00000001)

VISIBILITY_SECRET

Added in API level 21
int VISIBILITY_SECRET

Notification visibility: Do not reveal any part of this notification on a secure lockscreen.

See also:

Constant Value: -1 (0xffffffff)

Fields

AUDIO_ATTRIBUTES_DEFAULT

Added in API level 21
AudioAttributes AUDIO_ATTRIBUTES_DEFAULT

The default value of audioAttributes.

CREATOR

Added in API level 1
Creator<Notification> CREATOR

Parcelable.Creator that instantiates Notification objects

actions

Added in API level 19
Action[] actions

Array of all Notification.Action structures attached to this notification by addAction(int, CharSequence, PendingIntent). Mostly useful for instances of NotificationListenerService that provide an alternative interface for invoking actions.

audioAttributes

Added in API level 21
AudioAttributes audioAttributes

The audio attributes to use when playing the sound.

audioStreamType

Added in API level 1
int audioStreamType

This field was deprecated in API level 21.
Use audioAttributes instead.

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

bigContentView

Added in API level 16
RemoteViews bigContentView

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. As of N, this field may be null. The expanded notification view is determined by the inputs to Notification.Builder; a custom RemoteViews can optionally be supplied with setCustomBigContentView(RemoteViews).

category

Added in API level 21
String category

One of the predefined notification categories (see the CATEGORY_* constants) that best describes this Notification. May be used by the system for ranking and filtering.

color

Added in API level 21
int color

Accent color (an ARGB integer like the constants in Color) to be applied by the standard Style templates when presenting this notification. The current template design constructs a colorful header image by overlaying the icon image (stenciled in white) atop a field of this color. Alpha components are ignored.

contentIntent

Added in API level 1
PendingIntent contentIntent

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.

contentView

Added in API level 1
RemoteViews contentView

The view that will represent this notification in the notification list (which is pulled down from the status bar). As of N, this field may be null. The notification view is determined by the inputs to Notification.Builder; a custom RemoteViews can optionally be supplied with setCustomContentView(RemoteViews).

defaults

Added in API level 1
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.

deleteIntent

Added in API level 1
PendingIntent 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. This probably shouldn't be launching an activity since several of those will be sent at the same time.

extras

Added in API level 19
Bundle extras

Additional semantic data to be carried around with this Notification.

The extras keys defined here are intended to capture the original inputs to Notification.Builder APIs, and are intended to be used by NotificationListenerService implementations to extract detailed information from notification objects.

flags

Added in API level 1
int flags

fullScreenIntent

Added in API level 9
PendingIntent fullScreenIntent

An intent to launch instead of posting the notification to the status bar.

The system UI may choose to display a heads-up notification, instead of launching this intent, while the user is using the device.

See also:

headsUpContentView

Added in API level 21
RemoteViews headsUpContentView

A medium-format version of contentView, providing the Notification an opportunity to add action buttons to contentView. At its discretion, the system UI may choose to show this as a heads-up notification, which will pop up so the user can see it without leaving their current activity. As of N, this field may be null. The heads-up notification view is determined by the inputs to Notification.Builder; a custom RemoteViews can optionally be supplied with setCustomHeadsUpContentView(RemoteViews).

icon

Added in API level 1
int icon

This field was deprecated in API level 23.
Use setSmallIcon(Icon) instead.

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

iconLevel

Added in API level 1
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:

largeIcon

Added in API level 11
Bitmap largeIcon

This field was deprecated in API level 23.
Use setLargeIcon(Icon) instead.

A large bitmap to be shown in the notification content area.

ledARGB

Added in API level 1
int ledARGB

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

See also:

ledOffMS

Added in API level 1
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:

ledOnMS

Added in API level 1
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:

number

Added in API level 1
int number

This field was deprecated in API level 24.
this number is not shown anymore

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.

priority

Added in API level 16
int priority

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.

A notification that is at least PRIORITY_HIGH is more likely to be presented as a heads-up notification.

publicVersion

Added in API level 21
Notification publicVersion

Replacement version of this notification whose content will be shown in an insecure context such as atop a secure keyguard. See visibility and VISIBILITY_PUBLIC.

sound

Added in API level 1
Uri sound

The sound to play.

A notification that is noisy is more likely to be presented as a heads-up notification.

To play the default notification sound, see defaults.

tickerText

Added in API level 1
CharSequence tickerText

Text that summarizes this notification for accessibility services. As of the L release, this text is no longer shown on screen, but it is still useful to accessibility services (where it serves as an audible announcement of the notification's appearance).

See also:

tickerView

Added in API level 11
RemoteViews tickerView

Formerly, a view showing the tickerText. No longer displayed in the status bar as of API 21.

vibrate

Added in API level 1
long[] vibrate

The pattern with which to vibrate.

To vibrate the default pattern, see defaults.

A notification that vibrates is more likely to be presented as a heads-up notification.

See also:

visibility

Added in API level 21
int visibility

Sphere of visibility of this notification, which affects how and when the SystemUI reveals the notification's presence and contents in untrusted situations (namely, on the secure lockscreen). The default level, VISIBILITY_PRIVATE, behaves exactly as notifications have always done on Android: The notification's icon and tickerText (if available) are shown in all situations, but the contents are only available if the device is unlocked for the appropriate user. A more permissive policy can be expressed by VISIBILITY_PUBLIC; such a notification can be read even in an "insecure" context (that is, above a secure lockscreen). To modify the public version of this notification—for example, to redact some portions—see setPublicVersion(Notification). Finally, a notification can be made VISIBILITY_SECRET, which will suppress its icon and ticker until the user has bypassed the lockscreen.

when

Added in API level 1
long when

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:

  • Notification of a new chat message should be stamped when the message was received.
  • Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.
  • Notification of a completed file download should be stamped when the download finished.
  • Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).
  • Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time.
  • Notification of an ongoing countdown timer should be stamped with the timer's end time.
For apps targeting N and above, this time is not shown anymore by default and must be opted into by using setShowWhen(boolean)

Public constructors

Notification

Added in API level 1
Notification ()

Constructs a Notification object with default values. You might want to consider using Notification.Builder instead.

Notification

Added in API level 1
Notification (int icon, 
                CharSequence tickerText, 
                long when)

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.

Parameters
icon int: The resource id of the icon to put in the status bar.
tickerText CharSequence: The text that flows by in the status bar when the notification first activates.
when long: The time to show in the time field. In the System.currentTimeMillis timebase.

Notification

Added in API level 1
Notification (Parcel parcel)

Unflatten the notification from a parcel.

Parameters
parcel Parcel

Public methods

clone

Added in API level 1
Notification 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.

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
Notification a clone of this instance.

describeContents

Added in API level 1
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.

getGroup

Added in API level 20
String getGroup ()

Get the key used to group this notification into a cluster or stack with other notifications on devices which support such rendering.

Returns
String

getLargeIcon

Added in API level 23
Icon getLargeIcon ()

The large icon shown in this notification's content view.

Returns
Icon

See also:

getSmallIcon

Added in API level 23
Icon getSmallIcon ()

The small icon representing this notification in the status bar and content view.

Returns
Icon the small icon representing this notification.

See also:

getSortKey

Added in API level 20
String getSortKey ()

Get a sort key that orders this notification among other notifications from the same package. This can be useful if an external sort was already applied and an app would like to preserve this. Notifications will be sorted lexicographically using this value, although providing different priorities in addition to providing sort key may cause this value to be ignored.

This sort key can also be used to order members of a notification group. See setGroup(String).

Returns
String

See also:

toString

Added in API level 1
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.

writeToParcel

Added in API level 1
void writeToParcel (Parcel parcel, 
                int flags)

Flatten this notification into a parcel.

Parameters
parcel 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.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.