Stay organized with collections Save and categorize content based on your preferences.
added in version 22.1.0
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1

NotificationCompat

public class NotificationCompat
extends Object

java.lang.Object
   ↳ android.support.v4.app.NotificationCompat


Helper for accessing features in Notification.

Summary

Nested classes

class NotificationCompat.Action

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

class NotificationCompat.BigPictureStyle

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

class NotificationCompat.BigTextStyle

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

class NotificationCompat.Builder

Builder class for NotificationCompat objects. 

class NotificationCompat.CarExtender

Helper class to add Android Auto extensions to notifications. 

class NotificationCompat.DecoratedCustomViewStyle

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

interface NotificationCompat.Extender

Extender interface for use with extend(NotificationCompat.Extender)

class NotificationCompat.InboxStyle

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

class NotificationCompat.MessagingStyle

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

class NotificationCompat.Style

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

class NotificationCompat.WearableExtender

Helper class to add wearable extensions to notifications. 

Constants

int BADGE_ICON_LARGE

If this notification is being shown as a badge, use the icon provided to {@link Builder#setLargeIcon(Bitmap) 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 icon provided to setSmallIcon(int) 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_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

Value of color equal to 0 (also known as Color.TRANSPARENT), 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_AUDIO_CONTENTS_URI

Keys into the getExtras(Notification) Bundle: the audio contents of this notification.

String EXTRA_BACKGROUND_IMAGE_URI

Notification 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

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

String EXTRA_COMPACT_ACTIONS

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

String EXTRA_CONVERSATION_TITLE

Notification key: a String to be displayed as the title to a conversation represented by a NotificationCompat.MessagingStyle

String EXTRA_INFO_TEXT

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

String EXTRA_IS_GROUP_CONVERSATION

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

String EXTRA_LARGE_ICON

Notification 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

Notification 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

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

String EXTRA_MESSAGES

Notification key: an array of Bundle objects representing NotificationCompat.MessagingStyle.Message objects for a NotificationCompat.MessagingStyle notification.

String EXTRA_PEOPLE

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

String EXTRA_PICTURE

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

String EXTRA_PROGRESS

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

String EXTRA_PROGRESS_INDETERMINATE

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

String EXTRA_PROGRESS_MAX

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

String EXTRA_REMOTE_INPUT_HISTORY

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

String EXTRA_SELF_DISPLAY_NAME

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

String EXTRA_SHOW_CHRONOMETER

Notification extras key: whether the when field set using setWhen(long) should be shown as a count-up timer (specifically a Chronometer) instead of a timestamp, as supplied to setUsesChronometer(boolean).

String EXTRA_SHOW_WHEN

Notification extras key: whether the when field set using setWhen(long) should be shown, as supplied to setShowWhen(boolean).

String EXTRA_SMALL_ICON

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

String EXTRA_SUB_TEXT

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

String EXTRA_SUMMARY_TEXT

Notification 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

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

String EXTRA_TEXT

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

String EXTRA_TEXT_LINES

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

String EXTRA_TITLE

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

String EXTRA_TITLE_BIG

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

int FLAG_AUTO_CANCEL

Bit set in the Notification flags field if the notification should be canceled when it is clicked by the user.

int FLAG_FOREGROUND_SERVICE

Bit set in the Notification flags field if this notification represents a currently running service.

int FLAG_GROUP_SUMMARY

Bit set in the Notification flags field if this notification is the group summary for a group of notifications.

int FLAG_HIGH_PRIORITY

This constant was deprecated in API level 22.1.0. Use setPriority(int) with a positive value.

int FLAG_INSISTENT

Bit set in the Notification flags field if the audio will be repeated until the notification is cancelled or the notification window is opened.

int FLAG_LOCAL_ONLY

Bit set in the Notification flags field 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 set in the Notification flags field if the notification should not be canceled when the user clicks the Clear all button.

int FLAG_ONGOING_EVENT

Bit set in the Notification flags field if this notification is in reference to something that is ongoing, like a phone call.

int FLAG_ONLY_ALERT_ONCE

Bit set in the Notification flags field if the notification's sound, vibrate and ticker should only be played if the notification is not already showing.

int FLAG_SHOW_LIGHTS

Bit set in the Notification flags field when LEDs should be turned on for this notification.

int GROUP_ALERT_ALL

Constant for 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 setGroupAlertBehavior(int), meaning that the summary notification in a group should be silenced (no sound or vibration) even if they would otherwise make sound or vibrate.

int GROUP_ALERT_SUMMARY

Constant for setGroupAlertBehavior(int), meaning that all children notification in a group should be silenced (no sound or vibration) even if they would otherwise make sound or vibrate.

int PRIORITY_DEFAULT

Default notification priority for setPriority(int).

int PRIORITY_HIGH

Higher notification priority for setPriority(int), for more important notifications or alerts.

int PRIORITY_LOW

Lower notification priority for setPriority(int), for items that are less important.

int PRIORITY_MAX

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

int PRIORITY_MIN

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

int STREAM_DEFAULT

Use this constant as the value for audioStreamType to request that the default stream type for notifications be used.

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.

Public constructors

NotificationCompat()

Public methods

static NotificationCompat.Action getAction(Notification notification, int actionIndex)

Get an action on this notification in a backwards compatible manner.

static int getActionCount(Notification notification)

Get the number of actions in this notification in a backwards compatible manner.

static int getBadgeIconType(Notification notification)

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

static String getCategory(Notification notification)

Get the category of this notification in a backwards compatible manner.

static String getChannelId(Notification notification)
static Bundle getExtras(Notification notification)

Gets the extras field from a notification in a backwards compatible manner.

static String getGroup(Notification notification)

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

static int getGroupAlertBehavior(Notification notification)

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

static List<NotificationCompat.Action> getInvisibleActions(Notification notification)

Returns the invisible actions contained within the given notification.

static boolean getLocalOnly(Notification notification)

Get whether or not this notification is only relevant to the current device.

static String getShortcutId(Notification notification)

Returns the id that this notification supersedes, if any.

static String getSortKey(Notification notification)

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

static long getTimeoutAfter(Notification notification)

Returns the time at which this notification should be canceled by the system, if it's not canceled already.

static boolean isGroupSummary(Notification notification)

Get whether this notification to be the group summary for a group of notifications.

Inherited methods

From class java.lang.Object

Constants

BADGE_ICON_LARGE

added in version 26.1.0
int BADGE_ICON_LARGE

If this notification is being shown as a badge, use the icon provided to {@link Builder#setLargeIcon(Bitmap) to represent this notification.

Constant Value: 2 (0x00000002)

BADGE_ICON_NONE

added in version 26.1.0
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 version 26.1.0
int BADGE_ICON_SMALL

If this notification is being shown as a badge, use the icon provided to setSmallIcon(int) to represent this notification.

Constant Value: 1 (0x00000001)

CATEGORY_ALARM

added in version 22.1.0
String CATEGORY_ALARM

Notification category: alarm or timer.

Constant Value: "alarm"

CATEGORY_CALL

added in version 22.1.0
String CATEGORY_CALL

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

Constant Value: "call"

CATEGORY_EMAIL

added in version 22.1.0
String CATEGORY_EMAIL

Notification category: asynchronous bulk message (email).

Constant Value: "email"

CATEGORY_ERROR

added in version 22.1.0
String CATEGORY_ERROR

Notification category: error in background operation or authentication status.

Constant Value: "err"

CATEGORY_EVENT

added in version 22.1.0
String CATEGORY_EVENT

Notification category: calendar event.

Constant Value: "event"

CATEGORY_MESSAGE

added in version 22.1.0
String CATEGORY_MESSAGE

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

Constant Value: "msg"

CATEGORY_PROGRESS

added in version 22.1.0
String CATEGORY_PROGRESS

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

Constant Value: "progress"

CATEGORY_PROMO

added in version 22.1.0
String CATEGORY_PROMO

Notification category: promotion or advertisement.

Constant Value: "promo"

CATEGORY_RECOMMENDATION

added in version 22.1.0
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 version 24.1.0
String CATEGORY_REMINDER

Notification category: user-scheduled reminder.

Constant Value: "reminder"

CATEGORY_SERVICE

added in version 22.1.0
String CATEGORY_SERVICE

Notification category: indication of running background service.

Constant Value: "service"

CATEGORY_SOCIAL

added in version 22.1.0
String CATEGORY_SOCIAL

Notification category: social network or sharing update.

Constant Value: "social"

CATEGORY_STATUS

added in version 22.1.0
String CATEGORY_STATUS

Notification category: ongoing information about device or contextual status.

Constant Value: "status"

CATEGORY_SYSTEM

added in version 22.1.0
String CATEGORY_SYSTEM

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

Constant Value: "sys"

CATEGORY_TRANSPORT

added in version 22.1.0
String CATEGORY_TRANSPORT

Notification category: media transport control for playback.

Constant Value: "transport"

COLOR_DEFAULT

added in version 22.1.0
int COLOR_DEFAULT

Value of color equal to 0 (also known as Color.TRANSPARENT), 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 version 22.1.0
int DEFAULT_ALL

Use all default values (where applicable).

Constant Value: -1 (0xffffffff)

DEFAULT_LIGHTS

added in version 22.1.0
int DEFAULT_LIGHTS

Use the default notification lights. This will ignore the FLAG_SHOW_LIGHTS bit, and values set with setLights(int, int, int).

See also:

Constant Value: 4 (0x00000004)