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.ActionStructure to encapsulate a named action that can be shown as part of this notification. | 
| 
        
        
        
        
        class | Notification.BigPictureStyleHelper class for generating large-format notifications that include a large image attachment. | 
| 
        
        
        
        
        class | Notification.BigTextStyleHelper class for generating large-format notifications that include a lot of text. | 
| 
        
        
        
        
        class | Notification.BubbleMetadataEncapsulates the information needed to display a notification as a bubble. | 
| 
        
        
        
        
        class | Notification.BuilderBuilder class for  | 
| 
        
        
        
        
        class | Notification.CallStyleHelper class for generating large-format notifications that include a caller and required actions, such as an incoming call with answer / decline. | 
| 
        
        
        
        
        class | Notification.CarExtenderHelper class to add Android Auto extensions to notifications. | 
| 
        
        
        
        
        class | Notification.DecoratedCustomViewStyleNotification 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.DecoratedMediaCustomViewStyleNotification 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.ExtenderExtender interface for use with  | 
| 
        
        
        
        
        class | Notification.InboxStyleHelper class for generating large-format notifications that include a list of (up to 5) strings. | 
| 
        
        
        
        
        class | Notification.MediaStyleNotification style for media playback notifications. | 
| 
        
        
        
        
        class | Notification.MessagingStyleHelper class for generating large-format notifications that include multiple back-and-forth messages of varying types between any number of people. | 
| 
        
        
        
        
        class | Notification.ProgressStyleA 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.StyleAn object that can apply a rich notification style to a  | 
| 
        
        
        
        
        class | Notification.TvExtenderHelper class to add Android TV extensions to notifications. | 
| 
        
        
        
        
        class | Notification.WearableExtenderHelper class to add wearable extensions to notifications. | 
| Constants | |
|---|---|
| int | BADGE_ICON_LARGEIf this notification is being shown as a badge, use the  | 
| int | BADGE_ICON_NONEIf this notification is being shown as a badge, always show as a number. | 
| int | BADGE_ICON_SMALLIf this notification is being shown as a badge, use the  | 
| String | CATEGORY_ALARMNotification category: alarm or timer. | 
| String | CATEGORY_CALLNotification category: incoming call (voice or video) or similar synchronous communication request. | 
| String | CATEGORY_EMAILNotification category: asynchronous bulk message (email). | 
| String | CATEGORY_ERRORNotification category: error in background operation or authentication status. | 
| String | CATEGORY_EVENTNotification category: calendar event. | 
| String | CATEGORY_LOCATION_SHARINGNotification category: temporarily sharing location. | 
| String | CATEGORY_MESSAGENotification category: incoming direct message (SMS, instant message, etc.). | 
| String | CATEGORY_MISSED_CALLNotification category: missed call. | 
| String | CATEGORY_NAVIGATIONNotification category: map turn-by-turn navigation. | 
| String | CATEGORY_PROGRESSNotification category: progress of a long-running background operation. | 
| String | CATEGORY_PROMONotification category: promotion or advertisement. | 
| String | CATEGORY_RECOMMENDATIONNotification category: a specific, timely recommendation for a single thing. | 
| String | CATEGORY_REMINDERNotification category: user-scheduled reminder. | 
| String | CATEGORY_SERVICENotification category: indication of running background service. | 
| String | CATEGORY_SOCIALNotification category: social network or sharing update. | 
| String | CATEGORY_STATUSNotification category: ongoing information about device or contextual status. | 
| String | CATEGORY_STOPWATCHNotification category: running stopwatch. | 
| String | CATEGORY_SYSTEMNotification category: system or device status update. | 
| String | CATEGORY_TRANSPORTNotification category: media transport control for playback. | 
| String | CATEGORY_VOICEMAILNotification category: voicemail. | 
| String | CATEGORY_WORKOUTNotification category: tracking a user's workout. | 
| int | COLOR_DEFAULTSpecial value of  | 
| int | DEFAULT_ALLUse all default values (where applicable). | 
| int | DEFAULT_LIGHTSUse the default notification lights. | 
| int | DEFAULT_SOUNDUse the default notification sound. | 
| int | DEFAULT_VIBRATEUse the default notification vibrate. | 
| String | EXTRA_ANSWER_COLOR
 | 
| String | EXTRA_ANSWER_INTENT
 | 
| String | EXTRA_AUDIO_CONTENTS_URI
 | 
| String | EXTRA_BACKGROUND_IMAGE_URI
 | 
| String | EXTRA_BIG_TEXT
 | 
| String | EXTRA_CALL_IS_VIDEO
 | 
| String | EXTRA_CALL_PERSON
 | 
| String | EXTRA_CALL_TYPE
 | 
| String | EXTRA_CHANNEL_GROUP_IDOptional extra for  | 
| String | EXTRA_CHANNEL_IDOptional extra for  | 
| String | EXTRA_CHRONOMETER_COUNT_DOWN
 | 
| String | EXTRA_COLORIZED
 | 
| String | EXTRA_COMPACT_ACTIONS
 | 
| String | EXTRA_CONVERSATION_TITLE
 | 
| String | EXTRA_DECLINE_COLOR
 | 
| String | EXTRA_DECLINE_INTENT
 | 
| String | EXTRA_HANG_UP_INTENT
 | 
| String | EXTRA_HISTORIC_MESSAGES
 | 
| String | EXTRA_INFO_TEXT
 | 
| String | EXTRA_IS_GROUP_CONVERSATION
 | 
| String | EXTRA_LARGE_ICON
      This constant was deprecated
      in API level 26.
    Use  | 
| String | EXTRA_LARGE_ICON_BIG
 | 
| String | EXTRA_MEDIA_SESSION
 | 
| String | EXTRA_MESSAGES
 | 
| String | EXTRA_MESSAGING_PERSON
 | 
| String | EXTRA_NOTIFICATION_IDOptional extra for  | 
| String | EXTRA_NOTIFICATION_TAGOptional extra for  | 
| String | EXTRA_PEOPLE
      This constant was deprecated
      in API level 28.
    the actual objects are now in  | 
| String | EXTRA_PEOPLE_LIST
 | 
| String | EXTRA_PICTURE
 | 
| String | EXTRA_PICTURE_CONTENT_DESCRIPTION
 | 
| String | EXTRA_PICTURE_ICON
 | 
| String | EXTRA_PROGRESS
 | 
| String | EXTRA_PROGRESS_INDETERMINATE
 | 
| String | EXTRA_PROGRESS_MAX
 | 
| String | EXTRA_REMOTE_INPUT_DRAFTIf 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  | 
| String | EXTRA_REMOTE_INPUT_HISTORY
 | 
| String | EXTRA_REQUEST_PROMOTED_ONGOING
 | 
| String | EXTRA_SELF_DISPLAY_NAME
      This constant was deprecated
      in API level 28.
    use  | 
| String | EXTRA_SHOW_BIG_PICTURE_WHEN_COLLAPSED
 | 
| String | EXTRA_SHOW_CHRONOMETER
 | 
| String | EXTRA_SHOW_WHEN
 | 
| String | EXTRA_SMALL_ICON
      This constant was deprecated
      in API level 26.
    Use  | 
| String | EXTRA_SUB_TEXT
 | 
| String | EXTRA_SUMMARY_TEXT
 | 
| String | EXTRA_TEMPLATE
 | 
| String | EXTRA_TEXT
 | 
| String | EXTRA_TEXT_LINES
 | 
| String | EXTRA_TITLE
 | 
| String | EXTRA_TITLE_BIG
 | 
| String | EXTRA_VERIFICATION_ICON
 | 
| String | EXTRA_VERIFICATION_TEXT
 | 
| int | FLAG_AUTO_CANCELBit to be bitwise-ORed into the  | 
| int | FLAG_BUBBLEBit to be bitwise-ORed into the  | 
| int | FLAG_FOREGROUND_SERVICEBit to be bitwise-ORed into the  | 
| int | FLAG_GROUP_SUMMARYBit to be bitwise-ORed into the  | 
| int | FLAG_HIGH_PRIORITY
      This constant was deprecated
      in API level 16.
    Use  | 
| int | FLAG_INSISTENTBit to be bitwise-ORed into the  | 
| int | FLAG_LOCAL_ONLYBit to be bitwise-ORed into the  | 
| int | FLAG_NO_CLEARBit to be bitwise-ORed into the  | 
| int | FLAG_ONGOING_EVENTBit to be bitwise-ORed into the  | 
| int | FLAG_ONLY_ALERT_ONCEBit to be bitwise-ORed into the  | 
| int | FLAG_PROMOTED_ONGOINGBit to be bitwise-ORed into the  | 
| int | FLAG_SHOW_LIGHTS
      This constant was deprecated
      in API level 26.
    use  | 
| int | FOREGROUND_SERVICE_DEFAULTIf the Notification associated with starting a foreground service has been built using
  | 
| int | FOREGROUND_SERVICE_DEFERREDIf the Notification associated with starting a foreground service has been built using
  | 
| int | FOREGROUND_SERVICE_IMMEDIATEIf the Notification associated with starting a foreground service has been built using
  | 
| int | GROUP_ALERT_ALLConstant for  | 
| int | GROUP_ALERT_CHILDRENConstant for  | 
| int | GROUP_ALERT_SUMMARYConstant for  | 
| String | INTENT_CATEGORY_NOTIFICATION_PREFERENCESAn 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  | 
| int | PRIORITY_HIGH
      This constant was deprecated
      in API level 26.
    use  | 
| int | PRIORITY_LOW
      This constant was deprecated
      in API level 26.
    use  | 
| int | PRIORITY_MAX
      This constant was deprecated
      in API level 26.
    use  | 
| int | PRIORITY_MIN
      This constant was deprecated
      in API level 26.
    use  | 
| int | STREAM_DEFAULT
      This constant was deprecated
      in API level 21.
    Use  | 
| int | VISIBILITY_PRIVATENotification visibility: Show this notification on all lockscreens, but conceal sensitive or private information on secure lockscreens. | 
| int | VISIBILITY_PUBLICNotification visibility: Show this notification in its entirety on all lockscreens and while screen sharing. | 
| int | VISIBILITY_SECRETNotification 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_DEFAULTThe default value of  | 
| 
    public
    static
    final
    Creator<Notification> | CREATORParcelable.Creator that instantiates Notification objects | 
| 
    public
    
    
    Action[] | actionsArray of all  | 
| 
    public
    
    
    AudioAttributes | audioAttributes
      This field was deprecated
      in API level 26.
    use  | 
| 
    public
    
    
    int | audioStreamType
      This field was deprecated
      in API level 21.
    Use  | 
| 
    public
    
    
    RemoteViews | bigContentViewA large-format version of  | 
| 
    public
    
    
    String | categoryOne of the predefined notification categories (see the  | 
| 
    public
    
    
    int | colorAccent color (an ARGB integer like the constants in  | 
| 
    public
    
    
    PendingIntent | contentIntentThe intent to execute when the expanded status entry is clicked. | 
| 
    public
    
    
    RemoteViews | contentViewThe 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  | 
| 
    public
    
    
    PendingIntent | deleteIntentThe 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 | extrasAdditional semantic data to be carried around with this Notification. | 
| 
    public
    
    
    int | flags
 | 
| 
    public
    
    
    PendingIntent | fullScreenIntentAn intent to launch instead of posting the notification to the status bar. | 
| 
    public
    
    
    RemoteViews | headsUpContentViewA medium-format version of  | 
| 
    public
    
    
    int | icon
      This field was deprecated
      in API level 23.
    Use  | 
| 
    public
    
    
    int | iconLevelIf 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  | 
| 
    public
    
    
    int | ledARGB
      This field was deprecated
      in API level 26.
    use  | 
| 
    public
    
    
    int | ledOffMS
      This field was deprecated
      in API level 26.
    use  | 
| 
    public
    
    
    int | ledOnMS
      This field was deprecated
      in API level 26.
    use  | 
| 
    public
    
    
    int | numberThe number of events that this notification represents. | 
| 
    public
    
    
    int | priority
      This field was deprecated
      in API level 26.
    use  | 
| 
    public
    
    
    Notification | publicVersionReplacement 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  | 
| 
    public
    
    
    CharSequence | tickerTextText that summarizes this notification for accessibility services. | 
| 
    public
    
    
    RemoteViews | tickerViewFormerly, a view showing the  | 
| 
    public
    
    
    long[] | vibrate
      This field was deprecated
      in API level 26.
    use  | 
| 
    public
    
    
    int | visibilitySphere 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 | whenA 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  | |
| Public methods | |
|---|---|
| 
        
        
        
        
        
        Notification | 
      clone()
      Creates and returns a copy of this object. | 
| 
        
        
        
        
        
        int | 
      describeContents()
      Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | 
| 
        
        
        
        
        
        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.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  | 
| 
        
        
        
        
        
        CharSequence | 
      getSettingsText()
      Returns the settings text provided to  | 
| 
        
        
        
        
        
        String | 
      getShortCriticalText()
      Returns the very short text summarizing the most critical information contained in the
 notification, or  | 
| 
        
        
        
        
        
        String | 
      getShortcutId()
      Returns the  | 
| 
        
        
        
        
        
        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
  | 
| 
        
        
        
        
        
        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
BADGE_ICON_LARGE
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
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
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
public static final String CATEGORY_ALARM
Notification category: alarm or timer.
Constant Value: "alarm"
CATEGORY_CALL
public static final String CATEGORY_CALL
Notification category: incoming call (voice or video) or similar synchronous communication request.
Constant Value: "call"
CATEGORY_EMAIL
public static final String CATEGORY_EMAIL
Notification category: asynchronous bulk message (email).
Constant Value: "email"
CATEGORY_ERROR
public static final String CATEGORY_ERROR
Notification category: error in background operation or authentication status.
Constant Value: "err"
CATEGORY_EVENT
public static final String CATEGORY_EVENT
Notification category: calendar event.
Constant Value: "event"
CATEGORY_LOCATION_SHARING
public static final String CATEGORY_LOCATION_SHARING
Notification category: temporarily sharing location.
Constant Value: "location_sharing"
CATEGORY_MESSAGE
public static final String CATEGORY_MESSAGE
Notification category: incoming direct message (SMS, instant message, etc.).
Constant Value: "msg"
CATEGORY_MISSED_CALL
public static final String CATEGORY_MISSED_CALL
Notification category: missed call.
Constant Value: "missed_call"
CATEGORY_NAVIGATION
public static final String CATEGORY_NAVIGATION
Notification category: map turn-by-turn navigation.
Constant Value: "navigation"
CATEGORY_PROGRESS
public static final String CATEGORY_PROGRESS
Notification category: progress of a long-running background operation.
Constant Value: "progress"
CATEGORY_PROMO
public static final String CATEGORY_PROMO
Notification category: promotion or advertisement.
Constant Value: "promo"
CATEGORY_RECOMMENDATION
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
public static final String CATEGORY_REMINDER
Notification category: user-scheduled reminder.
Constant Value: "reminder"
CATEGORY_SERVICE
public static final String CATEGORY_SERVICE
Notification category: indication of running background service.
Constant Value: "service"
CATEGORY_SOCIAL
public static final String CATEGORY_SOCIAL
Notification category: social network or sharing update.
Constant Value: "social"
CATEGORY_STATUS
public static final String CATEGORY_STATUS
Notification category: ongoing information about device or contextual status.
Constant Value: "status"
CATEGORY_STOPWATCH
public static final String CATEGORY_STOPWATCH
Notification category: running stopwatch.
Constant Value: "stopwatch"
CATEGORY_SYSTEM
public static final String CATEGORY_SYSTEM
Notification category: system or device status update. Reserved for system use.
Constant Value: "sys"
CATEGORY_TRANSPORT
public static final String CATEGORY_TRANSPORT
Notification category: media transport control for playback.
Constant Value: "transport"
CATEGORY_VOICEMAIL
public static final String CATEGORY_VOICEMAIL
Notification category: voicemail.
Constant Value: "voicemail"
CATEGORY_WORKOUT
public static final String CATEGORY_WORKOUT
Notification category: tracking a user's workout.
Constant Value: "workout"
COLOR_DEFAULT
public static final int COLOR_DEFAULT
Special value of color telling the system not to decorate this notification with
 any special color but instead use default colors when presenting this notification.
Constant Value: 0 (0x00000000)
DEFAULT_ALL
public static final int DEFAULT_ALL
Use all default values (where applicable).
Constant Value: -1 (0xffffffff)
DEFAULT_LIGHTS
public static final int DEFAULT_LIGHTS
Use the default notification lights. This will ignore the
 FLAG_SHOW_LIGHTS bit, and ledARGB, ledOffMS, or
 ledOnMS.
See also:
Constant Value: 4 (0x00000004)
DEFAULT_SOUND
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
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
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
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
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 Notification.MessagingStyle.Message.setData(String, Uri).
 
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
public static final String EXTRA_MEDIA_SESSION
extras key: A
 MediaSession.Token associated with a
 Notification.MediaStyle notification.
Constant Value: "android.mediaSession"
EXTRA_MESSAGES
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
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
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
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
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
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
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
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
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_PROGRESS
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 FOREGROUND_SERVICE_DEFAULT, FOREGROUND_SERVICE_IMMEDIATE, or FOREGROUND_SERVICE_DEFERRED
Constant Value: 0 (0x00000000)
FOREGROUND_SERVICE_DEFERRED
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 FOREGROUND_SERVICE_DEFAULT, FOREGROUND_SERVICE_IMMEDIATE, or FOREGROUND_SERVICE_DEFERRED
Constant Value: 2 (0x00000002)
FOREGROUND_SERVICE_IMMEDIATE
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 FOREGROUND_SERVICE_DEFAULT, FOREGROUND_SERVICE_IMMEDIATE, or FOREGROUND_SERVICE_DEFERRED
Constant Value: 1 (0x00000001)
GROUP_ALERT_ALL
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
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
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
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
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
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
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
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
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)
STREAM_DEFAULT
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
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
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
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
public static final AudioAttributes AUDIO_ATTRIBUTES_DEFAULT
The default value of audioAttributes.
CREATOR
public static final Creator<Notification> CREATOR
Parcelable.Creator that instantiates Notification objects
actions
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
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
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
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
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
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
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
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
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
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
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.
fullScreenIntent
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
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
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
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
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
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.
See also:
ledOffMS
public int ledOffMS
      This field was deprecated
      in API level 26.
    use NotificationChannel.shouldShowLights().
  
The number of milliseconds for the LED to be off while it's flashing. The hardware will do its best approximation.
See also:
ledOnMS
public int ledOnMS
      This field was deprecated
      in API level 26.
    use NotificationChannel.shouldShowLights().
  
The number of milliseconds for the LED to be on while it's flashing. The hardware will do its best approximation.
See also:
number
public int number
The number of events that this notification represents. For example, in a new mail notification, this could be the number of unread messages.
The system may or may not use this field to modify the appearance of the notification.
 Starting with Build.VERSION_CODES.O, the number may be displayed as a
 badge icon in Launchers that support badging.
priority
public int priority
      This field was deprecated
      in API level 26.
    use NotificationChannel.getImportance() instead.
  
Relative priority for this notification.
Priority is an indication of how much of the user's valuable attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The system will make a determination about how to interpret this priority when presenting the notification.
 A notification that is at least PRIORITY_HIGH is more likely to be presented
 as a heads-up notification.
 
Value is
PRIORITY_DEFAULT, PRIORITY_LOW, PRIORITY_MIN, PRIORITY_HIGH, or PRIORITY_MAX
    
publicVersion
public Notification publicVersion
Replacement version of this notification whose content will be shown
 in an insecure context such as atop a secure keyguard. See visibility
 and VISIBILITY_PUBLIC.
sound
public Uri sound
      This field was deprecated
      in API level 26.
    use NotificationChannel.getSound().
  
The sound to play.
A notification that is noisy is more likely to be presented as a heads-up notification.
To play the default notification sound, see defaults.
tickerText
public CharSequence tickerText
Text that summarizes this notification for accessibility services.
As of the L release, this text is no longer shown on screen, but it is still useful to accessibility services (where it serves as an audible announcement of the notification's appearance).
See also:
tickerView
public RemoteViews tickerView
Formerly, a view showing the tickerText.
 
No longer displayed in the status bar as of API 21.
vibrate
public long[] vibrate
      This field was deprecated
      in API level 26.
    use NotificationChannel.getVibrationPattern().
  
The pattern with which to vibrate.
To vibrate the default pattern, see defaults.
See also:
visibility
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).
The default level, VISIBILITY_PRIVATE, behaves exactly as notifications have
 always done on Android: The notification's icon and tickerText (if
 available) are shown in all situations, but the contents are only available if the device is
 unlocked for the appropriate user and there is no active screen sharing session.
 
A more permissive policy can be expressed by VISIBILITY_PUBLIC; such a
 notification can be read even in an "insecure" context (that is, above a secure lockscreen or
 while screen sharing with a remote viewer).
 To modify the public version of this notification\u2014for example, to redact some portions\u2014see
 Builder.setPublicVersion(Notification).
 
Finally, a notification can be made VISIBILITY_SECRET, which will suppress its
 icon and ticker until the user has bypassed the lockscreen.
 
 Value is VISIBILITY_PUBLIC, VISIBILITY_PRIVATE, or VISIBILITY_SECRET
when
public long when
A timestamp related to this notification, in milliseconds since the epoch.
Default value: Now.
 
Choose a timestamp that will be most relevant to the user. For most finite events, this corresponds to the time the event happened (or will happen, in the case of events that have yet to occur but about which the user is being informed). Indefinite events should be timestamped according to when the activity began.
Some examples:
- Notification of a new chat message should be stamped when the message was received.
- Notification of an ongoing file download (with a progress bar, for example) should be stamped when the download started.
- Notification of a completed file download should be stamped when the download finished.
- Notification of an upcoming meeting should be stamped with the time the meeting will begin (that is, in the future).
- Notification of an ongoing stopwatch (increasing timer) should be stamped with the watch's start time.
- Notification of an ongoing countdown timer should be stamped with the timer's end time.
For apps targeting Build.VERSION_CODES.N and above, this time is not
 shown anymore by default and must be opted into by using
 Notification.Builder.setShowWhen(boolean)
Public constructors
Notification
public Notification ()
Constructs a Notification object with default values.
 You should use Builder instead.
Notification
public Notification (Parcel parcel)
Unflatten the notification from a parcel.
| Parameters | |
|---|---|
| parcel | Parcel | 
Notification
public Notification (int icon, 
                CharSequence tickerText, 
                long when)
      This constructor is deprecated.
    Use Builder instead.
  
Constructs a Notification object with the information needed to have a status bar icon without the standard expanded view.
| Parameters | |
|---|---|
| icon | int: the resource id of the icon to put in the status bar | 
| tickerText | CharSequence: the text that flows by in the status bar when the notification first
                   activates | 
| when | long: the time to show in the time field, in theSystem.currentTimeMillistimebase | 
Public methods
clone
public Notification clone ()
Creates and returns a copy of this object.  The precise meaning
 of "copy" may depend on the class of the object. The general
 intent is that, for any object x, the expression:
 
will be true, and that the expression:
will be
true, but these are not absolute requirements.
 While it is typically the case that:
 will be
true, this is not an absolute requirement.
 
 By convention, the returned object should be obtained by calling
 super.clone.  If a class and all of its superclasses (except
 Object) obey this convention, it will be the case that
 x.clone().getClass() == x.getClass().
 
 By convention, the object returned by this method should be independent
 of this object (which is being cloned).  To achieve this independence,
 it may be necessary to modify one or more fields of the object returned
 by super.clone before returning it.  Typically, this means
 copying any mutable objects that comprise the internal "deep structure"
 of the object being cloned and replacing the references to these
 objects with references to the copies.  If a class contains only
 primitive fields or references to immutable objects, then it is usually
 the case that no fields in the object returned by super.clone
 need to be modified.
| Returns | |
|---|---|
| Notification | a clone of this instance. | 
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
 instance's marshaled representation. For example, if the object will
 include a file descriptor in the output of writeToParcel(android.os.Parcel, int),
 the return value of this method must include the
 CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
| int | a bitmask indicating the set of special object types marshaled
 by this Parcelable object instance.
 Value is either 0orCONTENTS_FILE_DESCRIPTOR | 
findRemoteInputActionPair
public Pair<RemoteInput, Notification.Action> findRemoteInputActionPair (boolean requiresFreeform)
Finds and returns a remote input and its corresponding action.
| Parameters | |
|---|---|
| requiresFreeform | boolean: requires the remoteinput to allow freeform or not | 
| Returns | |
|---|---|
| Pair<RemoteInput, Notification.Action> | the result pair, nullif no result is found | 
getAllowSystemGeneratedContextualActions
public boolean getAllowSystemGeneratedContextualActions ()
Returns whether the platform is allowed (by the app developer) to generate contextual actions for this notification.
| Returns | |
|---|---|
| boolean | |
getBadgeIconType
public int getBadgeIconType ()
Returns what icon should be shown for this notification if it is being displayed in a
 Launcher that supports badging. Will be one of BADGE_ICON_NONE,
 BADGE_ICON_SMALL, or BADGE_ICON_LARGE.
| Returns | |
|---|---|
| int | |
getBubbleMetadata
public Notification.BubbleMetadata getBubbleMetadata ()
Returns the bubble metadata that will be used to display app content in a floating window over the existing foreground activity.
| Returns | |
|---|---|
| Notification.BubbleMetadata | This value may be null. | 
getChannelId
public String getChannelId ()
Returns the id of the channel this notification posts to.
| Returns | |
|---|---|
| String | |
getContextualActions
public 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.
| Returns | |
|---|---|
| List<Notification.Action> | This value cannot be null. | 
getGroup
public String getGroup ()
Get the key used to group this notification into a cluster or stack with other notifications on devices which support such rendering.
| Returns | |
|---|---|
| String | |
getGroupAlertBehavior
public int getGroupAlertBehavior ()
Returns which type of notifications in a group are responsible for audibly alerting the user.
| Returns | |
|---|---|
| int | Value is GROUP_ALERT_ALL,GROUP_ALERT_CHILDREN, orGROUP_ALERT_SUMMARY | 
getLargeIcon
public Icon getLargeIcon ()
The large icon shown in this notification's content view.
| Returns | |
|---|---|
| Icon | |
getLocusId
public LocusId getLocusId ()
Gets the LocusId associated with this notification.
 
Used by the device's intelligence services to correlate objects (such as
 ShortcutInfo and ContentCaptureContext) that are correlated.
| Returns | |
|---|---|
| LocusId | This value may be null. | 
getSettingsText
public CharSequence getSettingsText ()
Returns the settings text provided to Builder.setSettingsText(CharSequence).
| Returns | |
|---|---|
| CharSequence | |
getShortCriticalText
public String getShortCriticalText ()
Returns the very short text summarizing the most critical information contained in the
 notification, or null if this field was not set.
| Returns | |
|---|---|
| String | |
getShortcutId
public String getShortcutId ()
Returns the id that this notification supersedes, if any.
 
Used by some Launchers that display notification content to hide shortcuts that duplicate notifications.
| Returns | |
|---|---|
| String | |
getSmallIcon
public Icon getSmallIcon ()
The small icon representing this notification in the status bar.
| Returns | |
|---|---|
| Icon | the small icon representing this notification | 
getSortKey
public String getSortKey ()
Get a sort key that orders this notification among other notifications from the same package. This can be useful if an external sort was already applied and an app would like to preserve this. Notifications will be sorted lexicographically using this value, although providing different priorities in addition to providing sort key may cause this value to be ignored.
This sort key can also be used to order members of a notification group. See
 Builder.setGroup.
| Returns | |
|---|---|
| String | |
See also:
getTimeoutAfter
public long getTimeoutAfter ()
Returns the duration from posting after which this notification should be canceled by the system, if it's not canceled already.
| Returns | |
|---|---|
| long | |
hasImage
public boolean hasImage ()
| Returns | |
|---|---|
| boolean | trueif the notification has an image | 
hasPromotableCharacteristics
public boolean hasPromotableCharacteristics ()
Returns whether the notification has all the characteristics that make it eligible for
 FLAG_PROMOTED_ONGOING. This method does not factor in other criteria such user
 preferences for the app or channel. If this returns true, it does not guarantee that
 the notification will be assigned FLAG_PROMOTED_ONGOING by the system, but if this
 returns false, it will not.
| Returns | |
|---|---|
| boolean | |
hasSummarizedContent
public boolean hasSummarizedContent ()
Returns whether this notification contains computationally summarized text. The OS may choose to display this content instead of the original notification content on some surfaces and may add styling to indicate to the user that this was computationally generated.
| Returns | |
|---|---|
| boolean | |
isRequestPromotedOngoing
public boolean isRequestPromotedOngoing ()
Returns whether this notification has requested to be a promoted ongoing notification.
| Returns | |
|---|---|
| boolean | |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
| String | a string representation of the object. | 
writeToParcel
public void writeToParcel (Parcel parcel, int flags)
Flatten this notification into a parcel.
| Parameters | |
|---|---|
| parcel | Parcel: The Parcel in which the object should be written.
 This value cannot benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-09-17 UTC.
