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

Encapsulates the information needed to display a notification as a bridged notification. 

class Notification.BubbleMetadata

Encapsulates the information needed to display a notification as a bubble. 

class Notification.Builder

Builder class for Notification objects. 

class Notification.CallStyle

Helper class for generating large-format notifications that include a caller and required actions, such as an incoming call with answer / decline. 

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 Builder.extend. 

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

A metric, used with MetricStyle, and which has a value and a label. 

class Notification.MetricStyle

A notification style which shows up to 3 metrics when expanded. 

class Notification.ProgressStyle

A Notification Style used to define a notification whose expanded state includes a highly customizable progress bar with segments, points, a custom tracker icon, and custom icons at the start and end of the progress bar. 

class Notification.ProjectedExtender

Helper class to add projection-specific extensions to a notification. 

class Notification.Style

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

class Notification.TvExtender

Helper class to add Android TV extensions to notifications. 

class Notification.WearableExtender

Helper class to add wearable extensions to notifications. 

Constants

String ACTION_BRIDGED_NOTIFICATION_PREFERENCES

An activity that provides a user interface for adjusting notification preferences for its bridged notification which originated on another device.

int BADGE_ICON_LARGE

If this notification is being shown as a badge, use the getLargeIcon() to represent this notification.

int BADGE_ICON_NONE

If this notification is being shown as a badge, always show as a number.

int BADGE_ICON_SMALL

If this notification is being shown as a badge, use the getSmallIcon() to represent this notification.

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_LOCATION_SHARING

Notification category: temporarily sharing location.

String CATEGORY_MESSAGE

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

String CATEGORY_MISSED_CALL

Notification category: missed call.

String CATEGORY_NAVIGATION

Notification category: map turn-by-turn navigation.

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_STOPWATCH

Notification category: running stopwatch.

String CATEGORY_SYSTEM

Notification category: system or device status update.

String CATEGORY_TRANSPORT

Notification category: media transport control for playback.

String CATEGORY_VOICEMAIL

Notification category: voicemail.

String CATEGORY_WORKOUT

Notification category: tracking a user's workout.

int COLOR_DEFAULT

Special value of color telling the system not to decorate this element with any special color (but instead use default system colors).

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_ANSWER_COLOR

extras key: the color used as a hint for the Answer action button of a Notification.CallStyle notification.

String EXTRA_ANSWER_INTENT

extras key: the intent to be sent when the users answers a Notification.CallStyle notification.

String EXTRA_AUDIO_CONTENTS_URI

extras key: the audio contents of this notification.

String EXTRA_BACKGROUND_IMAGE_URI

extras key: flat String representation of 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 expanded form of a BigTextStyle notification, as supplied to BigTextStyle.bigText(CharSequence).

String EXTRA_CALL_IS_VIDEO

extras key: whether the Notification.CallStyle notification is for a call that will activate video when answered.

String EXTRA_CALL_PERSON

extras key: the person to be displayed as calling for the Notification.CallStyle notification.

String EXTRA_CALL_TYPE

extras key: the type of call represented by the Notification.CallStyle notification.

String EXTRA_CHANNEL_GROUP_ID

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.

String EXTRA_CHANNEL_ID

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.

String EXTRA_CHRONOMETER_COUNT_DOWN

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

String EXTRA_COLORIZED

extras key: whether the notification should be colorized as supplied to Builder.setColorized(boolean).

String EXTRA_COMPACT_ACTIONS

extras key: the indices of actions to be shown in the compact view, as supplied to (e.g.) MediaStyle.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_DECLINE_COLOR

extras key: the color used as a hint for the Decline or Hang Up action button of a Notification.CallStyle notification.

String EXTRA_DECLINE_INTENT

extras key: the intent to be sent when the users declines a Notification.CallStyle notification.

String EXTRA_HANG_UP_INTENT

extras key: the intent to be sent when the users hangs up a Notification.CallStyle notification.

String EXTRA_HISTORIC_MESSAGES

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

String EXTRA_INFO_TEXT

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

String EXTRA_IS_GROUP_CONVERSATION

extras key: whether the Notification.MessagingStyle notification represents a group conversation.

String EXTRA_LARGE_ICON

This constant was deprecated in API level 26. Use getLargeIcon(), which supports a wider variety of icon sources.

String EXTRA_LARGE_ICON_BIG

extras key: this is a bitmap to be used instead of the one from Builder.setLargeIcon(android.graphics.Bitmap) when the notification is shown in its expanded form, as supplied to BigPictureStyle.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_MESSAGING_PERSON

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

String EXTRA_NOTIFICATION_ID

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.

String EXTRA_NOTIFICATION_TAG

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.

String EXTRA_PEOPLE

This constant was deprecated in API level 28. the actual objects are now in EXTRA_PEOPLE_LIST

String EXTRA_PEOPLE_LIST

extras key: An arrayList of Person objects containing the people that this notification relates to.

String EXTRA_PICTURE

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

String EXTRA_PICTURE_CONTENT_DESCRIPTION

extras key: this is a content description of the big picture supplied from BigPictureStyle.bigPicture(Bitmap), supplied to BigPictureStyle.setContentDescription(CharSequence).

String EXTRA_PICTURE_ICON

extras key: this is an Icon of an image to be shown in BigPictureStyle expanded notifications, supplied to BigPictureStyle.bigPicture(Icon).

String EXTRA_PREFER_SMALL_ICON

A boolean for extras requesting that the notification card show the small icon instead of the launcher app icon.

String EXTRA_PROGRESS

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

String EXTRA_PROGRESS_INDETERMINATE

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

String EXTRA_PROGRESS_MAX

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

String EXTRA_REMOTE_INPUT_DRAFT

If the notification contained an unsent draft for a RemoteInput when the user clicked on it, we're adding the draft as a String extra to the contentIntent using this key.

String EXTRA_REMOTE_INPUT_HISTORY

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

String EXTRA_REQUEST_PROMOTED_ONGOING

extras key: If provided, should contain a boolean indicating whether the notification is requesting promoted treatment.

String EXTRA_SELF_DISPLAY_NAME

This constant was deprecated in API level 28. use EXTRA_MESSAGING_PERSON

String EXTRA_SHOW_BIG_PICTURE_WHEN_COLLAPSED

extras key: this is a boolean to indicate that the big picture is to be shown in the collapsed state of a BigPictureStyle 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 Builder.setUsesChronometer(boolean).

String EXTRA_SHOW_WHEN

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

String EXTRA_SMALL_ICON

This constant was deprecated in API level 26. Use getSmallIcon(), which supports a wider variety of icon sources.

String EXTRA_SUB_TEXT

extras key: this is a third line of text, as supplied to Builder.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.) BigTextStyle.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 Builder.setContentText(CharSequence).

String EXTRA_TEXT_LINES

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

String EXTRA_TITLE

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

String EXTRA_TITLE_BIG

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

String EXTRA_VERIFICATION_ICON

extras key: the icon to be displayed as a verification status of the caller on a Notification.CallStyle notification.

String EXTRA_VERIFICATION_TEXT

extras key: the text to be displayed as a verification status of the caller on a Notification.CallStyle notification.

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_BUBBLE

Bit to be bitwise-ORed into the flags field that should be set by the system if this notification is showing as a bubble.

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 bitwise-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 bitwise-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_PROMOTED_ONGOING

Bit to be bitwise-ORed into the flags field that should be set by the system if this notification is a promoted ongoing notification, both because it hasPromotableCharacteristics() and the user has not disabled the feature for this app.

int FLAG_SHOW_LIGHTS

This constant was deprecated in API level 26. use NotificationChannel.shouldShowLights().

int FOREGROUND_SERVICE_DEFAULT

If the Notification associated with starting a foreground service has been built using Notification.Builder.setForegroundServiceBehavior(int) with this behavior, display of the notification will usually be suppressed for a short time to avoid visual disturbances to the user.

int FOREGROUND_SERVICE_DEFERRED

If the Notification associated with starting a foreground service has been built using Notification.Builder.setForegroundServiceBehavior(int) with this behavior, display of the notification will usually be suppressed for a short time to avoid visual disturbances to the user.

int FOREGROUND_SERVICE_IMMEDIATE

If the Notification associated with starting a foreground service has been built using Notification.Builder.setForegroundServiceBehavior(int) with this behavior, display of the notification will be immediate even if the default behavior would be to defer visibility for a short time.

int GROUP_ALERT_ALL

Constant for Builder.setGroupAlertBehavior(int), meaning that all notifications in a group with sound or vibration ought to make sound or vibrate (respectively), so this notification will not be muted when it is in a group.

int GROUP_ALERT_CHILDREN

Constant for Builder.setGroupAlertBehavior(int), meaning that the summary notification in a group should be silenced (no sound or vibration) even if they are posted to a NotificationChannel that has sound and/or vibration.

int GROUP_ALERT_SUMMARY

Constant for Builder.setGroupAlertBehavior(int), meaning that all children notification in a group should be silenced (no sound or vibration) even if they are posted to a NotificationChannel that has sound and/or vibration.

String INTENT_CATEGORY_NOTIFICATION_PREFERENCES

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

int PRIORITY_DEFAULT

This constant was deprecated in API level 26. use NotificationManager.IMPORTANCE_DEFAULT instead.

int PRIORITY_HIGH

This constant was deprecated in API level 26. use NotificationManager.IMPORTANCE_HIGH instead.

int PRIORITY_LOW

This constant was deprecated in API level 26. use NotificationManager.IMPORTANCE_LOW instead.

int PRIORITY_MAX

This constant was deprecated in API level 26. use NotificationManager.IMPORTANCE_HIGH instead.

int PRIORITY_MIN

This constant was deprecated in API level 26. use NotificationManager.IMPORTANCE_MIN instead.

int SEMANTIC_STYLE_CAUTION

This value is used to annotate an element as indicating caution, moderate urgency, tardiness, or another \u201cintermediate\u201d value on the semantic hierarchy.

int SEMANTIC_STYLE_DANGER

This value is used to annotate an element as indicating danger, extreme urgency or lateness, or another \u201cextreme\u201d value on the semantic hierarchy.

int SEMANTIC_STYLE_INFO

This value is used to annotate an element as indicating information that should stand out from other content, but which doesn\u2019t fall on a scale or hierarchy.

int SEMANTIC_STYLE_SAFE

This value is used to annotate an element as indicating safety, non-urgency, timeliness, or another \u201cmild\u201d value on the semantic hierarchy.

int SEMANTIC_STYLE_UNSPECIFIED

This is the default value for semantic style, signaling no particular semantics.

int STREAM_DEFAULT

This constant was deprecated in API level 21. Use NotificationChannel.getAudioAttributes() 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 and while screen sharing.

int VISIBILITY_SECRET

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

Inherited constants

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 Action structures attached to this notification by Builder.addAction(int,CharSequence,PendingIntent).

public AudioAttributes audioAttributes

This field was deprecated in API level 26. use NotificationChannel.getAudioAttributes() instead.

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 when expanded.

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

This field was deprecated in API level 26. use NotificationChannel.getSound() and NotificationChannel.shouldShowLights() and NotificationChannel.shouldVibrate().

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 Builder.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 Builder.setLargeIcon(Icon) instead.

public int ledARGB

This field was deprecated in API level 26. use NotificationChannel.shouldShowLights().

public int ledOffMS

This field was deprecated in API level 26. use NotificationChannel.shouldShowLights().

public int ledOnMS

This field was deprecated in API level 26. use NotificationChannel.shouldShowLights().

public int number

The number of events that this notification represents.

public int priority

This field was deprecated in API level 26. use NotificationChannel.getImportance() instead.

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

This field was deprecated in API level 26. use NotificationChannel.getSound().

public CharSequence tickerText

Text that summarizes this notification for accessibility services.

public RemoteViews tickerView

Formerly, a view showing the tickerText.

public long[] vibrate

This field was deprecated in API level 26. use NotificationChannel.getVibrationPattern().

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 and during screen sharing).

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(Parcel parcel)

Unflatten the notification from a parcel.

Notification(int icon, CharSequence tickerText, long when)

This constructor is deprecated. Use Builder instead.

Public methods

Notification clone()

Creates and returns a copy of this object.

static Annotation createSemanticStyleAnnotation(int semanticStyle)

Constructs an Annotation that can be used to span text in a Spanned CharSequence in some Notification text fields, and which may then be converted into styling of that section of text in order to indicate the semantic style.

int describeContents()

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

Pair<RemoteInput, Notification.Action> findRemoteInputActionPair(boolean requiresFreeform)

Finds and returns a remote input and its corresponding action.

boolean getAllowSystemGeneratedContextualActions()

Returns whether the platform is allowed (by the app developer) to generate contextual actions for this notification.

int getBadgeIconType()

Returns what icon should be shown for this notification if it is being displayed in a Launcher that supports badging.

Notification.BridgedNotificationMetadata getBridgedNotificationMetadata()

Returns the metadata associated with a notification originating on another device.

Notification.BubbleMetadata getBubbleMetadata()

Returns the bubble metadata that will be used to display app content in a floating window over the existing foreground activity.

String getChannelId()

Returns the id of the channel this notification posts to.

List<Notification.Action> getContextualActions()

Returns the actions that are contextual (that is, suggested because of the content of the notification) out of the actions in this notification.

String getGroup()

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

int getGroupAlertBehavior()

Returns which type of notifications in a group are responsible for audibly alerting the user.

Icon getLargeIcon()

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

LocusId getLocusId()

Gets the LocusId associated with this notification.

CharSequence getSettingsText()

Returns the settings text provided to Builder.setSettingsText(CharSequence).

String getShortCriticalText()

Returns the very short text summarizing the most critical information contained in the notification, or null if this field was not set.

String getShortcutId()

Returns the id that this notification supersedes, if any.

Icon getSmallIcon()

The small icon representing this notification in the status bar.

String getSortKey()

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

long getTimeoutAfter()

Returns the duration from posting after which this notification should be canceled by the system, if it's not canceled already.

boolean hasImage()
boolean hasPromotableCharacteristics()

Returns whether the notification has all the characteristics that make it eligible for FLAG_PROMOTED_ONGOING.

boolean hasSummarizedContent()

Returns whether this notification contains computationally summarized text.

boolean isRequestPromotedOngoing()

Returns whether this notification has requested to be a promoted ongoing notification.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this notification into a parcel.

Inherited methods

Constants

ACTION_BRIDGED_NOTIFICATION_PREFERENCES

Added in API level 37 
public static final String ACTION_BRIDGED_NOTIFICATION_PREFERENCES

An activity that provides a user interface for adjusting notification preferences for its bridged notification which originated on another device.

Constant Value: "android.app.action.BRIDGED_NOTIFICATION_PREFERENCES"

BADGE_ICON_LARGE

Added in API level 26 
public static final int BADGE_ICON_LARGE

If this notification is being shown as a badge, use the getLargeIcon() to represent this notification.

Constant Value: 2 (0x00000002)

BADGE_ICON_NONE

Added in API level 26 
public static final int BADGE_ICON_NONE

If this notification is being shown as a badge, always show as a number.

Constant Value: 0 (0x00000000)

BADGE_ICON_SMALL

Added in API level 26 
public static final int BADGE_ICON_SMALL

If this notification is being shown as a badge, use the getSmallIcon() to represent this notification.

Constant Value: 1 (0x00000001)

CATEGORY_ALARM

Added in API level 21 
public static final String CATEGORY_ALARM

Notification category: alarm or timer.

Constant Value: "alarm"

CATEGORY_CALL

Added in API level 21 
public static final 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 
public static final String CATEGORY_EMAIL

Notification category: asynchronous bulk message (email).

Constant Value: "email"

CATEGORY_ERROR

Added in API level 21 
public static final String CATEGORY_ERROR

Notification category: error in background operation or authentication status.

Constant Value: "err"

CATEGORY_EVENT

Added in API level 21 
public static final String CATEGORY_EVENT

Notification category: calendar event.

Constant Value: "event"

CATEGORY_LOCATION_SHARING

Added in API level 31 
public static final String CATEGORY_LOCATION_SHARING

Notification category: temporarily sharing location.

Constant Value: "location_sharing"

CATEGORY_MESSAGE

Added in API level 21 
public static final String CATEGORY_MESSAGE

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

Constant Value: "msg"

CATEGORY_MISSED_CALL

Added in API level 31 
public static final String CATEGORY_MISSED_CALL

Notification category: missed call.

Constant Value: "missed_call"

CATEGORY_NAVIGATION

Added in API level 28 
public static final String CATEGORY_NAVIGATION

Notification category: map turn-by-turn navigation.

Constant Value: "navigation"

CATEGORY_PROGRESS

Added in API level 21 
public static final String CATEGORY_PROGRESS

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

Constant Value: "progress"

CATEGORY_PROMO

Added in API level 21 
public static final String CATEGORY_PROMO

Notification category: promotion or advertisement.

Constant Value: "promo"

CATEGORY_RECOMMENDATION

Added in API level 21 
public static final 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 
public static final String CATEGORY_REMINDER

Notification category: user-scheduled reminder.

Constant Value: "reminder"

CATEGORY_SERVICE

Added in API level 21 
public static final String CATEGORY_SERVICE

Notification category: indication of running background service.

Constant Value: "service"

CATEGORY_SOCIAL

Added in API level 21 
public static final String CATEGORY_SOCIAL

Notification category: social network or sharing update.

Constant Value: "social"

CATEGORY_STATUS

Added in API level 21 
public static final String CATEGORY_STATUS

Notification category: ongoing information about device or contextual status.

Constant Value: "status"

CATEGORY_STOPWATCH

Added in API level 31 
public static final String CATEGORY_STOPWATCH

Notification category: running stopwatch.

Constant Value: "stopwatch"

CATEGORY_SYSTEM

Added in API level 21 
public static final String CATEGORY_SYSTEM

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

Constant Value: "sys"

CATEGORY_TRANSPORT

Added in API level 21 
public static final String CATEGORY_TRANSPORT

Notification category: media transport control for playback.

Constant Value: "transport"

CATEGORY_VOICEMAIL

Added in API level 35 
public static final String CATEGORY_VOICEMAIL

Notification category: voicemail.

Constant Value: "voicemail"

CATEGORY_WORKOUT

Added in API level 31 
public static final String CATEGORY_WORKOUT

Notification category: tracking a user's workout.

Constant Value: "workout"

COLOR_DEFAULT

Added in API level 21 
public static final int COLOR_DEFAULT

Special value of color telling the system not to decorate this element with any special color (but instead use default system colors).

Constant Value: 0 (0x00000000)

DEFAULT_ALL

Added in API level 1 
public static final int DEFAULT_ALL

Use all default values (where applicable).

Constant Value: -1 (0xffffffff)

DEFAULT_LIGHTS

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

Constant Value: 4 (0x00000004)

DEFAULT_SOUND

Added in API level 1 
public static final 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 
public static final 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_ANSWER_COLOR

Added in API level 31 
public static final String EXTRA_ANSWER_COLOR

extras key: the color used as a hint for the Answer action button of a Notification.CallStyle notification. This extra is a ColorInt.

Constant Value: "android.answerColor"

EXTRA_ANSWER_INTENT

Added in API level 31 
public static final String EXTRA_ANSWER_INTENT

extras key: the intent to be sent when the users answers a Notification.CallStyle notification. This extra is a PendingIntent.

Constant Value: "android.answerIntent"

EXTRA_AUDIO_CONTENTS_URI

Added in API level 26 
public static final String EXTRA_AUDIO_CONTENTS_URI

extras key: the audio contents of this notification.

This is for use when rendering the notification on an audio-focused interface; the audio contents are a complete sound sample that contains the contents/body of the notification. This may be used in substitute of a Text-to-Speech reading of the notification. For example if the notification represents a voice message this should point to the audio of that message.

The data stored under this key should be a String representation of a Uri that contains the audio contents in one of the following formats: WAV, PCM 16-bit, AMR-WB.

This extra is unnecessary if you are using MessagingStyle since each MessagingStyle.Message has a field for holding data URI. That field can be used for audio. See MessagingStyle.Message.setData.

Example usage: 

 Notification.Builder myBuilder = (build your Notification as normal);
 myBuilder.getExtras().putString(EXTRA_AUDIO_CONTENTS_URI, myAudioUri.toString());

Constant Value: "android.audioContents"

EXTRA_BACKGROUND_IMAGE_URI

Added in API level 21 
public static final String EXTRA_BACKGROUND_IMAGE_URI

extras key: flat String representation of a content URI pointing to an image that can be displayed in the background when the notification is selected. Used on television platforms. The URI must point to an image stream suitable for passing into BitmapFactory.decodeStream; all other content types will be ignored.

Constant Value: "android.backgroundImageUri"

EXTRA_BIG_TEXT

Added in API level 21 
public static final String EXTRA_BIG_TEXT

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

Constant Value: "android.bigText"

EXTRA_CALL_IS_VIDEO

Added in API level 31 
public static final String EXTRA_CALL_IS_VIDEO

extras key: whether the Notification.CallStyle notification is for a call that will activate video when answered. This extra is a boolean.

Constant Value: "android.callIsVideo"

EXTRA_CALL_PERSON

Added in API level 31 
public static final String EXTRA_CALL_PERSON

extras key: the person to be displayed as calling for the Notification.CallStyle notification. This extra is a Person.

Constant Value: "android.callPerson"

EXTRA_CALL_TYPE

Added in API level 34 
public static final String EXTRA_CALL_TYPE

extras key: the type of call represented by the Notification.CallStyle notification. This extra is an int.

Constant Value: "android.callType"

EXTRA_CHANNEL_GROUP_ID

Added in API level 28 
public static final String EXTRA_CHANNEL_GROUP_ID

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES. If provided, will contain a group id that can be used to narrow down what settings should be shown in the target app.

Constant Value: "android.intent.extra.CHANNEL_GROUP_ID"

EXTRA_CHANNEL_ID

Added in API level 26 
public static final String EXTRA_CHANNEL_ID

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES. If provided, will contain a channel id that can be used to narrow down what settings should be shown in the target app.

Constant Value: "android.intent.extra.CHANNEL_ID"

EXTRA_CHRONOMETER_COUNT_DOWN

Added in API level 24 
public static final 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_COLORIZED

Added in API level 26 
public static final String EXTRA_COLORIZED

extras key: whether the notification should be colorized as supplied to Builder.setColorized(boolean).

Constant Value: "android.colorized"

EXTRA_COMPACT_ACTIONS

Added in API level 21 
public static final String EXTRA_COMPACT_ACTIONS

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

Constant Value: "android.compactActions"

EXTRA_CONVERSATION_TITLE

Added in API level 24 
public static final 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_DECLINE_COLOR

Added in API level 31 
public static final String EXTRA_DECLINE_COLOR

extras key: the color used as a hint for the Decline or Hang Up action button of a Notification.CallStyle notification. This extra is a ColorInt.

Constant Value: "android.declineColor"

EXTRA_DECLINE_INTENT

Added in API level 31 
public static final String EXTRA_DECLINE_INTENT

extras key: the intent to be sent when the users declines a Notification.CallStyle notification. This extra is a PendingIntent.

Constant Value: "android.declineIntent"

EXTRA_HANG_UP_INTENT

Added in API level 31 
public static final String EXTRA_HANG_UP_INTENT

extras key: the intent to be sent when the users hangs up a Notification.CallStyle notification. This extra is a PendingIntent.

Constant Value: "android.hangUpIntent"

EXTRA_HISTORIC_MESSAGES

Added in API level 26 
public static final String EXTRA_HISTORIC_MESSAGES

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

Constant Value: "android.messages.historic"

EXTRA_INFO_TEXT

Added in API level 19 
public static final String EXTRA_INFO_TEXT

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

Constant Value: "android.infoText"

EXTRA_IS_GROUP_CONVERSATION

Added in API level 28 
public static final String EXTRA_IS_GROUP_CONVERSATION

extras key: whether the Notification.MessagingStyle notification represents a group conversation.

Constant Value: "android.isGroupConversation"

EXTRA_LARGE_ICON

Added in API level 19
Deprecated in API level 26 
public static final String EXTRA_LARGE_ICON

This constant was deprecated in API level 26.
Use getLargeIcon(), which supports a wider variety of icon sources.

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

Constant Value: "android.largeIcon"

EXTRA_LARGE_ICON_BIG

Added in API level 19 
public static final String EXTRA_LARGE_ICON_BIG

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

Constant Value: "android.largeIcon.big"

EXTRA_MEDIA_SESSION

Added in API level 21 
public static final 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 
public static final 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_MESSAGING_PERSON

Added in API level 28 
public static final String EXTRA_MESSAGING_PERSON

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

Constant Value: "android.messagingUser"

EXTRA_NOTIFICATION_ID

Added in API level 26 
public static final String EXTRA_NOTIFICATION_ID

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES. If provided, will contain the id provided to NotificationManager.notify(String,int,Notification) that can be used to narrow down what settings should be shown in the target app.

Constant Value: "android.intent.extra.NOTIFICATION_ID"

EXTRA_NOTIFICATION_TAG

Added in API level 26 
public static final String EXTRA_NOTIFICATION_TAG

Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES. If provided, will contain the tag provided to NotificationManager.notify(String,int,Notification) that can be used to narrow down what settings should be shown in the target app.

Constant Value: "android.intent.extra.NOTIFICATION_TAG"

EXTRA_PEOPLE

Added in API level 19
Deprecated in API level 28 
public static final String EXTRA_PEOPLE

This constant was deprecated in API level 28.
the actual objects are now in EXTRA_PEOPLE_LIST

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

Constant Value: "android.people"

EXTRA_PEOPLE_LIST

Added in API level 28 
public static final String EXTRA_PEOPLE_LIST

extras key: An arrayList of Person objects containing the people that this notification relates to.

Constant Value: "android.people.list"

EXTRA_PICTURE

Added in API level 19 
public static final String EXTRA_PICTURE

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

Constant Value: "android.picture"

EXTRA_PICTURE_CONTENT_DESCRIPTION

Added in API level 31 
public static final String EXTRA_PICTURE_CONTENT_DESCRIPTION

extras key: this is a content description of the big picture supplied from BigPictureStyle.bigPicture(Bitmap), supplied to BigPictureStyle.setContentDescription(CharSequence).

Constant Value: "android.pictureContentDescription"

EXTRA_PICTURE_ICON

Added in API level 31 
public static final String EXTRA_PICTURE_ICON

extras key: this is an Icon of an image to be shown in BigPictureStyle expanded notifications, supplied to BigPictureStyle.bigPicture(Icon).

Constant Value: "android.pictureIcon"

EXTRA_PREFER_SMALL_ICON

Added in API level 37 
public static final String EXTRA_PREFER_SMALL_ICON

A boolean for extras requesting that the notification card show the small icon instead of the launcher app icon.

Constant Value: "android.app.preferSmallIcon"

EXTRA_PROGRESS

Added in API level 19 
public static final String EXTRA_PROGRESS

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

Constant Value: "android.progress"

EXTRA_PROGRESS_INDETERMINATE

Added in API level 19 
public static final String EXTRA_PROGRESS_INDETERMINATE

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

Constant Value: "android.progressIndeterminate"

EXTRA_PROGRESS_MAX

Added in API level 19 
public static final String EXTRA_PROGRESS_MAX

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

Constant Value: "android.progressMax"

EXTRA_REMOTE_INPUT_DRAFT

Added in API level 28 
public static final String EXTRA_REMOTE_INPUT_DRAFT

If the notification contained an unsent draft for a RemoteInput when the user clicked on it, we're adding the draft as a String extra to the contentIntent using this key.

Apps may use this extra to prepopulate text fields in the app, where the user usually sends messages.

Constant Value: "android.remoteInputDraft"

EXTRA_REMOTE_INPUT_HISTORY

Added in API level 24 
public static final String EXTRA_REMOTE_INPUT_HISTORY

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

Apps can fill this through Builder.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.

Constant Value: "android.remoteInputHistory"

EXTRA_REQUEST_PROMOTED_ONGOING

Added in version 36.1 
public static final String EXTRA_REQUEST_PROMOTED_ONGOING

extras key: If provided, should contain a boolean indicating whether the notification is requesting promoted treatment.

Constant Value: "android.requestPromotedOngoing"

EXTRA_SELF_DISPLAY_NAME

Added in API level 24
Deprecated in API level 28 
public static final String EXTRA_SELF_DISPLAY_NAME

This constant was deprecated in API level 28.
use EXTRA_MESSAGING_PERSON

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_BIG_PICTURE_WHEN_COLLAPSED

Added in API level 31 
public static final String EXTRA_SHOW_BIG_PICTURE_WHEN_COLLAPSED

extras key: this is a boolean to indicate that the big picture is to be shown in the collapsed state of a BigPictureStyle notification. This will replace a large icon in that state if one was provided.

Constant Value: "android.showBigPictureWhenCollapsed"

EXTRA_SHOW_CHRONOMETER

Added in API level 19 
public static final 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 Builder.setUsesChronometer(boolean).

Constant Value: "android.showChronometer"

EXTRA_SHOW_WHEN

Added in API level 19 
public static final String EXTRA_SHOW_WHEN

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

Constant Value: "android.showWhen"

EXTRA_SMALL_ICON

Added in API level 19
Deprecated in API level 26 
public static final String EXTRA_SMALL_ICON

This constant was deprecated in API level 26.
Use getSmallIcon(), which supports a wider variety of icon sources.

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

Constant Value: "android.icon"

EXTRA_SUB_TEXT

Added in API level 19 
public static final String EXTRA_SUB_TEXT

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

Constant Value: "android.subText"

EXTRA_SUMMARY_TEXT

Added in API level 19 
public static final 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.) BigTextStyle.setSummaryText(CharSequence).

Constant Value: "android.summaryText"

EXTRA_TEMPLATE

Added in API level 21 
public static final 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 
public static final String EXTRA_TEXT

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

Constant Value: "android.text"

EXTRA_TEXT_LINES

Added in API level 19 
public static final String EXTRA_TEXT_LINES

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

Constant Value: "android.textLines"

EXTRA_TITLE

Added in API level 19 
public static final String EXTRA_TITLE

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

Constant Value: "android.title"

EXTRA_TITLE_BIG

Added in API level 19 
public static final String EXTRA_TITLE_BIG

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

Constant Value: "android.title.big"

EXTRA_VERIFICATION_ICON

Added in API level 31 
public static final String EXTRA_VERIFICATION_ICON

extras key: the icon to be displayed as a verification status of the caller on a Notification.CallStyle notification. This extra is an Icon.

Constant Value: "android.verificationIcon"

EXTRA_VERIFICATION_TEXT

Added in API level 31 
public static final String EXTRA_VERIFICATION_TEXT

extras key: the text to be displayed as a verification status of the caller on a Notification.CallStyle notification. This extra is a CharSequence.

Constant Value: "android.verificationText"

FLAG_AUTO_CANCEL

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

Constant Value: 16 (0x00000010)

FLAG_BUBBLE

Added in API level 29 
public static final int FLAG_BUBBLE

Bit to be bitwise-ORed into the flags field that should be set by the system if this notification is showing as a bubble.

Applications cannot set this flag directly; they should instead call Notification.Builder.setBubbleMetadata(BubbleMetadata) to request that a notification be displayed as a bubble, and then check this flag to see whether that request was honored by the system.

Constant Value: 4096 (0x00001000)

FLAG_FOREGROUND_SERVICE

Added in API level 5 
public static final 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 Service.startForeground.

Constant Value: 64 (0x00000040)

FLAG_GROUP_SUMMARY

Added in API level 20 
public static final int FLAG_GROUP_SUMMARY

Bit to be bitwise-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 Builder.setGroup.

Constant Value: 512 (0x00000200)

FLAG_HIGH_PRIORITY

Added in API level 11
Deprecated in API level 16 
public static final 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 
public static final 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 
public static final int FLAG_LOCAL_ONLY

Bit to be bitwise-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 
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.

Constant Value: 32 (0x00000020)

FLAG_ONGOING_EVENT

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

Constant Value: 2 (0x00000002)

FLAG_ONLY_ALERT_ONCE

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

Note that using this flag will stop any ongoing alerting behaviour such as sound, vibration or blinking notification LED.

Constant Value: 8 (0x00000008)

FLAG_PROMOTED_ONGOING

Added in API level 36 
public static final int FLAG_PROMOTED_ONGOING

Bit to be bitwise-ORed into the flags field that should be set by the system if this notification is a promoted ongoing notification, both because it hasPromotableCharacteristics() and the user has not disabled the feature for this app.

Applications cannot set this flag directly, but the posting app and NotificationListenerService can read it.

Constant Value: 262144 (0x00040000)

FLAG_SHOW_LIGHTS

Added in API level 1
Deprecated in API level 26 
public static final int FLAG_SHOW_LIGHTS

This constant was deprecated in API level 26.
use NotificationChannel.shouldShowLights().

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 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)

FOREGROUND_SERVICE_DEFAULT

Added in API level 31 
public static final int FOREGROUND_SERVICE_DEFAULT

If the Notification associated with starting a foreground service has been built using Notification.Builder.setForegroundServiceBehavior(int) with this behavior, display of the notification will usually be suppressed for a short time to avoid visual disturbances to the user.
Value is one of the following:

FOREGROUND_SERVICE_DEFERRED

Added in API level 31 
public static final int FOREGROUND_SERVICE_DEFERRED

If the Notification associated with starting a foreground service has been built using Notification.Builder.setForegroundServiceBehavior(int) with this behavior, display of the notification will usually be suppressed for a short time to avoid visual disturbances to the user.
Value is one of the following:

FOREGROUND_SERVICE_IMMEDIATE

Added in API level 31 
public static final int FOREGROUND_SERVICE_IMMEDIATE

If the Notification associated with starting a foreground service has been built using Notification.Builder.setForegroundServiceBehavior(int) with this behavior, display of the notification will be immediate even if the default behavior would be to defer visibility for a short time.
Value is one of the following:

GROUP_ALERT_ALL

Added in API level 26 
public static final int GROUP_ALERT_ALL

Constant for Builder.setGroupAlertBehavior(int), meaning that all notifications in a group with sound or vibration ought to make sound or vibrate (respectively), so this notification will not be muted when it is in a group.

Constant Value: 0 (0x00000000)

GROUP_ALERT_CHILDREN

Added in API level 26 
public static final int GROUP_ALERT_CHILDREN

Constant for Builder.setGroupAlertBehavior(int), meaning that the summary notification in a group should be silenced (no sound or vibration) even if they are posted to a NotificationChannel that has sound and/or vibration. Use this constant to mute this notification if this notification is a group summary.

For example, you might want to use this constant if only the children notifications in your group have content and the summary is only used to visually group notifications rather than to alert the user that new information is available.

Constant Value: 2 (0x00000002)

GROUP_ALERT_SUMMARY

Added in API level 26 
public static final int GROUP_ALERT_SUMMARY

Constant for Builder.setGroupAlertBehavior(int), meaning that all children notification in a group should be silenced (no sound or vibration) even if they are posted to a NotificationChannel that has sound and/or vibration. Use this constant to mute this notification if this notification is a group child. This must be applied to all children notifications you want to mute.

For example, you might want to use this constant if you post a number of children notifications at once (say, after a periodic sync), and only need to notify the user audibly once.

Constant Value: 1 (0x00000001)

INTENT_CATEGORY_NOTIFICATION_PREFERENCES

Added in API level 21 
public static final String INTENT_CATEGORY_NOTIFICATION_PREFERENCES

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

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

PRIORITY_DEFAULT

Added in API level 16
Deprecated in API level 26 
public static final int PRIORITY_DEFAULT

This constant was deprecated in API level 26.
use NotificationManager.IMPORTANCE_DEFAULT instead.

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
Deprecated in API level 26 
public static final int PRIORITY_HIGH

This constant was deprecated in API level 26.
use NotificationManager.IMPORTANCE_HIGH instead.

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
Deprecated in API level 26 
public static final int PRIORITY_LOW

This constant was deprecated in API level 26.
use NotificationManager.IMPORTANCE_LOW instead.

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
Deprecated in API level 26 
public static final int PRIORITY_MAX

This constant was deprecated in API level 26.
use NotificationManager.IMPORTANCE_HIGH instead.

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
Deprecated in API level 26 
public static final int PRIORITY_MIN

This constant was deprecated in API level 26.
use NotificationManager.IMPORTANCE_MIN instead.

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

Constant Value: -2 (0xfffffffe)

SEMANTIC_STYLE_CAUTION

Added in API level 37 
public static final int SEMANTIC_STYLE_CAUTION

This value is used to annotate an element as indicating caution, moderate urgency, tardiness, or another \u201cintermediate\u201d value on the semantic hierarchy.

Caution is generally represented to users by styling the element with a yellow or orange color.

Constant Value: 3 (0x00000003)

SEMANTIC_STYLE_DANGER

Added in API level 37 
public static final int SEMANTIC_STYLE_DANGER

This value is used to annotate an element as indicating danger, extreme urgency or lateness, or another \u201cextreme\u201d value on the semantic hierarchy.

Danger is generally represented to users by styling the element with a red color.

Constant Value: 4 (0x00000004)

SEMANTIC_STYLE_INFO

Added in API level 37 
public static final int SEMANTIC_STYLE_INFO

This value is used to annotate an element as indicating information that should stand out from other content, but which doesn\u2019t fall on a scale or hierarchy. This can be thought of as a more neutral value that may be used in cases where the element is intended to stand out against elements with the other semantic styles -- for example if a ProgressStyle bar uses semantic style to color segments, this style would be appropriate for segments where the semantic hierarchy is unhelpful to the user.

Info is generally represented to users by styling the element with a color (like blue) that is clearly distinct from the colors used for other styles.

Constant Value: 1 (0x00000001)

SEMANTIC_STYLE_SAFE

Added in API level 37 
public static final int SEMANTIC_STYLE_SAFE

This value is used to annotate an element as indicating safety, non-urgency, timeliness, or another \u201cmild\u201d value on the semantic hierarchy.

Safety is generally represented to users by styling the element with a green color.

Constant Value: 2 (0x00000002)

SEMANTIC_STYLE_UNSPECIFIED

Added in API level 37 
public static final int SEMANTIC_STYLE_UNSPECIFIED

This is the default value for semantic style, signaling no particular semantics. An Annotation with this style has no effect.

Constant Value: 0 (0x00000000)

STREAM_DEFAULT

Added in API level 1
Deprecated in API level 21 
public static final int STREAM_DEFAULT

This constant was deprecated in API level 21.
Use NotificationChannel.getAudioAttributes() 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 AudioManager.STREAM_NOTIFICATION.

Constant Value: -1 (0xffffffff)

VISIBILITY_PRIVATE

Added in API level 21 
public static final int VISIBILITY_PRIVATE

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

See also:

Constant Value: 0 (0x00000000)

VISIBILITY_PUBLIC

Added in API level 21 
public static final int VISIBILITY_PUBLIC

Notification visibility: Show this notification in its entirety on all lockscreens and while screen sharing.

See also:

Constant Value: 1 (0x00000001)

VISIBILITY_SECRET

Added in API level 21 
public static final int VISIBILITY_SECRET

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

See also:

Constant Value: -1 (0xffffffff)

Fields

AUDIO_ATTRIBUTES_DEFAULT

Added in API level 21 
public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT

The default value of audioAttributes.

CREATOR

Added in API level 1 
public static final Creator<Notification> CREATOR

Parcelable.Creator that instantiates Notification objects

actions

Added in API level 19 
public Action[] actions

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

audioAttributes

Added in API level 21
Deprecated in API level 26 
public AudioAttributes audioAttributes

This field was deprecated in API level 26.
use NotificationChannel.getAudioAttributes() instead.

The audio attributes to use when playing the sound.

audioStreamType

Added in API level 1
Deprecated in API level 21 
public 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
Deprecated in API level 24 
public RemoteViews bigContentView

A large-format version of contentView, giving the Notification an opportunity to show more detail when expanded. 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 Notification.Builder.setCustomBigContentView(RemoteViews).

category

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

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 
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 Tasks and Back Stack document. In particular, make sure to read the Start an Activity from a Notification page for the correct ways to launch an application from a notification.

contentView

Added in API level 1
Deprecated in API level 24 
public 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 Notification.Builder.setCustomContentView(RemoteViews).

defaults

Added in API level 1
Deprecated in API level 26 
public int defaults

This field was deprecated in API level 26.
use NotificationChannel.getSound() and NotificationChannel.shouldShowLights() and NotificationChannel.shouldVibrate().

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

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 
public 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 Builder APIs, and are intended to be used by NotificationListenerService implementations to extract detailed information from notification objects.

flags

Added in API level 1 
public int flags

fullScreenIntent

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

headsUpContentView

Added in API level 21
Deprecated in API level 24 
public 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 Notification.Builder.setCustomHeadsUpContentView(RemoteViews).

icon

Added in API level 1
Deprecated in API level 23 
public int icon

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

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

iconLevel

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

largeIcon

Added in API level 11
Deprecated in API level 23 
public Bitmap largeIcon

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

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

ledARGB

Added in API level 1
Deprecated in API level 26 
public int ledARGB

This field was deprecated in API level 26.
use NotificationChannel.shouldShowLights().

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

ledOffMS

Added in API level 1
Deprecated in API level 26 
public int ledOffMS

This field was deprecated in API level 26.
use NotificationChannel.shouldShowLights().

The number of milliseconds for the LED to be off