NotificationCompat

Kotlin |Java

open class NotificationCompat

kotlin.Any
↳	androidx.core.app.NotificationCompat

Helper for accessing features in android.app.Notification.

Summary

Nested classes
open	Action Structure to encapsulate a named action that can be shown as part of this notification.
open	BigPictureStyle Helper class for generating large-format notifications that include a large image attachment.
open	BigTextStyle Helper class for generating large-format notifications that include a lot of text.
	BubbleMetadata Encapsulates the information needed to display a notification as a bubble.
open	Builder Builder class for NotificationCompat objects.
	CarExtender Helper class to add Android Auto extensions to notifications.
open	DecoratedCustomViewStyle Notification style for custom views that are decorated by the system.
abstract	Extender Extender interface for use with Builder#extend.
open	InboxStyle Helper class for generating large-format notifications that include a list of (up to 5) strings.
open	MessagingStyle Helper class for generating large-format notifications that include multiple back-and-forth messages of varying types between any number of people.
abstract	Style An object that can apply a rich notification style to a Notification.Builder object.
	WearableExtender Helper class to add wearable extensions to notifications.

Constants
static Int	BADGE_ICON_LARGE If this notification is being shown as a badge, use the icon provided to Builder#setLargeIcon(Bitmap) to represent this notification.
static Int	BADGE_ICON_NONE If this notification is being shown as a badge, always show as a number.
static Int	BADGE_ICON_SMALL If this notification is being shown as a badge, use the icon provided to Builder#setSmallIcon(int) to represent this notification.
static String	CATEGORY_ALARM Notification category: alarm or timer.
static String	CATEGORY_CALL Notification category: incoming call (voice or video) or similar synchronous communication request.
static String	CATEGORY_EMAIL Notification category: asynchronous bulk message (email).
static String	CATEGORY_ERROR Notification category: error in background operation or authentication status.
static String	CATEGORY_EVENT Notification category: calendar event.
static String	CATEGORY_LOCATION_SHARING Notification category: temporarily sharing location.
static String	CATEGORY_MESSAGE Notification category: incoming direct message (SMS, instant message, etc.).
static String	CATEGORY_MISSED_CALL Notification category: missed call.
static String	CATEGORY_NAVIGATION Notification category: map turn-by-turn navigation.
static String	CATEGORY_PROGRESS Notification category: progress of a long-running background operation.
static String	CATEGORY_PROMO Notification category: promotion or advertisement.
static String	CATEGORY_RECOMMENDATION Notification category: a specific, timely recommendation for a single thing.
static String	CATEGORY_REMINDER Notification category: user-scheduled reminder.
static String	CATEGORY_SERVICE Notification category: indication of running background service.
static String	CATEGORY_SOCIAL Notification category: social network or sharing update.
static String	CATEGORY_STATUS Notification category: ongoing information about device or contextual status.
static String	CATEGORY_STOPWATCH Notification category: running stopwatch.
static String	CATEGORY_SYSTEM Notification category: system or device status update.
static String	CATEGORY_TRANSPORT Notification category: media transport control for playback.
static String	CATEGORY_WORKOUT Notification category: tracking a user's workout.
static Int	COLOR_DEFAULT Value of Notification#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.
static Int	DEFAULT_ALL Use all default values (where applicable).
static Int	DEFAULT_LIGHTS Use the default notification lights.
static Int	DEFAULT_SOUND Use the default notification sound.
static Int	DEFAULT_VIBRATE Use the default notification vibrate.
static String	EXTRA_AUDIO_CONTENTS_URI Keys into the getExtras Bundle: the audio contents of this notification.
static 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.
static String	EXTRA_BIG_TEXT extras key: this is the longer text shown in the big form of a BigTextStyle notification, as supplied to BigTextStyle#bigText(CharSequence).
static String	EXTRA_CHANNEL_GROUP_ID Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.
static String	EXTRA_CHANNEL_ID Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.
static String	EXTRA_CHRONOMETER_COUNT_DOWN extras key: whether the chronometer set on the notification should count down instead of counting up.
static String	EXTRA_COLORIZED extras key: whether the notification should be colorized as supplied to Builder#setColorized(boolean).
static String	EXTRA_COMPACT_ACTIONS extras key: the indices of actions to be shown in the compact view, as supplied to (e.g.)
static String	EXTRA_COMPAT_TEMPLATE extras key: A string representing the name of the specific NotificationCompat.Style used to create this notification.
static String	EXTRA_CONVERSATION_TITLE extras key: a String to be displayed as the title to a conversation represented by a MessagingStyle.
static String	EXTRA_HIDDEN_CONVERSATION_TITLE Key for compat's MessagingStyle#getConversationTitle().
static String	EXTRA_HISTORIC_MESSAGES extras key: an array of historic MessagingStyle.Message bundles provided by a MessagingStyle notification.
static String	EXTRA_INFO_TEXT extras key: this is a small piece of additional text as supplied to Builder#setContentInfo(CharSequence).
static String	EXTRA_IS_GROUP_CONVERSATION extras key: whether the NotificationCompat.MessagingStyle notification represents a group conversation.
static 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 Builder#setLargeIcon(android.graphics.Bitmap).
static 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).
static String	EXTRA_MEDIA_SESSION Notification key: A android.media.session.MediaSession.Token associated with a android.app.Notification.MediaStyle notification.
static String	EXTRA_MESSAGES extras key: an array of MessagingStyle.Message bundles provided by a android.app.Notification.MessagingStyle notification.
static String	EXTRA_MESSAGING_STYLE_USER extras key: the person to display for all messages sent by the user, including direct replies to MessagingStyle notifications.
static String	EXTRA_NOTIFICATION_ID Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.
static String	EXTRA_NOTIFICATION_TAG Optional extra for INTENT_CATEGORY_NOTIFICATION_PREFERENCES.
static String	EXTRA_PEOPLE extras key: A String array containing the people that this notification relates to, each of which was supplied to Builder#addPerson(String).
static String	EXTRA_PEOPLE_LIST extras key: : An arrayList of Person objects containing the people that this notification relates to, each of which was supplied to Builder#addPerson(Person).
static String	EXTRA_PICTURE extras key: this is a bitmap to be shown in BigPictureStyle expanded notifications, supplied to BigPictureStyle#bigPicture(android.graphics.Bitmap).
static String	EXTRA_PROGRESS extras key: this is the progress value supplied to Builder#setProgress(int, int, boolean).
static String	EXTRA_PROGRESS_INDETERMINATE extras key: whether the progress bar is indeterminate, supplied to Builder#setProgress(int, int, boolean).
static String	EXTRA_PROGRESS_MAX extras key: this is the maximum value supplied to Builder#setProgress(int, int, boolean).
static String	EXTRA_REMOTE_INPUT_HISTORY extras key: this is the remote input history, as supplied to Builder#setRemoteInputHistory(CharSequence[]).
static String	EXTRA_SELF_DISPLAY_NAME