NotificationCompat.Builder

mPeople

ArrayList<String> mPeople

This field was deprecated in API level 27.1.0.
This field was not meant to be public.

NotificationCompat.Builder

NotificationCompat.Builder (Context context, 
                String channelId)

Constructor. Automatically sets the when field to System.currentTimeMillis() and the audio stream to the STREAM_DEFAULT.

NotificationCompat.Builder

NotificationCompat.Builder (Context context)

This constructor was deprecated in API level 26.1.0.
use NotificationCompat.Builder(Context, String) instead. All posted Notifications must specify a NotificationChannel Id.

addAction

NotificationCompat.Builder addAction (NotificationCompat.Action action)

Add an action to this notification. Actions are typically displayed by the system as a button adjacent to the notification content.
Action buttons won't appear on platforms prior to Android 4.1. Action buttons depend on expanded notifications, which are only available in Android 4.1 and later. To ensure that an action button's functionality is always available, first implement the functionality in the Activity that starts when a user clicks the notification (see setContentIntent()), and then enhance the notification by implementing the same functionality with addAction().

addAction

NotificationCompat.Builder addAction (int icon, 
                CharSequence title, 
                PendingIntent intent)

Add an action to this notification. Actions are typically displayed by the system as a button adjacent to the notification content.
Action buttons won't appear on platforms prior to Android 4.1. Action buttons depend on expanded notifications, which are only available in Android 4.1 and later. To ensure that an action button's functionality is always available, first implement the functionality in the Activity that starts when a user clicks the notification (see setContentIntent()), and then enhance the notification by implementing the same functionality with addAction().

addExtras

NotificationCompat.Builder addExtras (Bundle extras)

Merge additional metadata into this notification.

Values within the Bundle will replace existing extras values in this Builder.

addPerson

NotificationCompat.Builder addPerson (String uri)

Add a person that is relevant to this notification.

Depending on user preferences, this annotation may allow the notification to pass through interruption filters, and to appear more prominently in the user interface.

The person should be specified by the String representation of a CONTENT_LOOKUP_URI.

The system will also attempt to resolve mailto: and tel: schema URIs. The path part of these URIs must exist in the contacts database, in the appropriate column, or the reference will be discarded as invalid. Telephone schema URIs will be resolved by ContactsContract.PhoneLookup.

build

Notification build ()

Combine all of the options that have been set and return a new Notification object.

extend

NotificationCompat.Builder extend (NotificationCompat.Extender extender)

Apply an extender to this notification builder. Extenders may be used to add metadata or change options on this builder.

getExtras

Bundle getExtras ()

Get the current metadata Bundle used by this notification Builder.

The returned Bundle is shared with this Builder.

The current contents of this Bundle are copied into the Notification each time build() is called.

getNotification

Notification getNotification ()

This method was deprecated in API level 22.1.0.
Use build() instead.

setAutoCancel

NotificationCompat.Builder setAutoCancel (boolean autoCancel)

Setting this flag will make it so the notification is automatically canceled when the user clicks it in the panel. The PendingIntent set with setDeleteIntent(PendingIntent) will be broadcast when the notification is canceled.

setBadgeIconType

NotificationCompat.Builder setBadgeIconType (int icon)

Sets which icon to display as a badge for this notification.

Must be one of BADGE_ICON_NONE, BADGE_ICON_SMALL, BADGE_ICON_LARGE.

Note: This value might be ignored, for launchers that don't support badge icons.

setCategory

NotificationCompat.Builder setCategory (String category)

Set the notification category.

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

setChannelId

NotificationCompat.Builder setChannelId (String channelId)

Specifies the channel the notification should be delivered on. No-op on versions prior to O .

setColor

NotificationCompat.Builder setColor (int argb)

Sets color.

setColorized

NotificationCompat.Builder setColorized (boolean colorize)

Set whether this notification should be colorized. When set, the color set with setColor(int) will be used as the background color of this notification.

This should only be used for high priority ongoing tasks like navigation, an ongoing call, or other similarly high-priority events for the user.

For most styles, the coloring will only be applied if the notification is for a foreground service notification.

However, for MediaStyle and DecoratedMediaCustomViewStyle notifications that have a media session attached there is no such requirement.

Calling this method on any version prior to O will not have an effect on the notification and it won't be colorized.

setContent

NotificationCompat.Builder setContent (RemoteViews views)

Supply a custom RemoteViews to use instead of the standard one.

setContentInfo

NotificationCompat.Builder setContentInfo (CharSequence info)

Set the large text at the right-hand side of the notification.

setContentIntent

NotificationCompat.Builder setContentIntent (PendingIntent intent)

Supply a PendingIntent to send when the notification is clicked. If you do not supply an intent, you can now add PendingIntents to individual views to be launched when clicked by calling RemoteViews.setOnClickPendingIntent(int,PendingIntent). Be sure to read Notification.contentIntent for how to correctly use this.

setContentText

NotificationCompat.Builder setContentText (CharSequence text)

Set the text (second row) of the notification, in a standard notification.

setContentTitle

NotificationCompat.Builder setContentTitle (CharSequence title)

Set the title (first row) of the notification, in a standard notification.

setCustomBigContentView

NotificationCompat.Builder setCustomBigContentView (RemoteViews contentView)

Supply custom RemoteViews to use instead of the platform template in the expanded form. This will override the expanded layout that would otherwise be constructed by this Builder object. No-op on versions prior to JELLY_BEAN.

setCustomContentView

NotificationCompat.Builder setCustomContentView (RemoteViews contentView)

Supply custom RemoteViews to use instead of the platform template. This will override the layout that would otherwise be constructed by this Builder object.

setCustomHeadsUpContentView

NotificationCompat.Builder setCustomHeadsUpContentView (RemoteViews contentView)

Supply custom RemoteViews to use instead of the platform template in the heads up dialog. This will override the heads-up layout that would otherwise be constructed by this Builder object. No-op on versions prior to LOLLIPOP.

setDefaults

NotificationCompat.Builder setDefaults (int defaults)

Set the default notification options that will be used.

The value should be one or more of the following fields combined with bitwise-or: DEFAULT_SOUND, DEFAULT_VIBRATE, DEFAULT_LIGHTS.

For all default values, use DEFAULT_ALL.

setDeleteIntent

NotificationCompat.Builder setDeleteIntent (PendingIntent intent)

Supply a PendingIntent to send when the notification is cleared by the user directly from the notification panel. For example, this intent is sent when the user clicks the "Clear all" button, or the individual "X" buttons on notifications. This intent is not sent when the application calls NotificationManager.cancel(int).

setExtras

NotificationCompat.Builder setExtras (Bundle extras)

Set metadata for this notification.

A reference to the Bundle is held for the lifetime of this Builder, and the Bundle's current contents are copied into the Notification each time build() is called.

Replaces any existing extras values with those from the provided Bundle. Use addExtras(Bundle) to merge in metadata instead.

setFullScreenIntent

NotificationCompat.Builder setFullScreenIntent (PendingIntent intent, 
                boolean highPriority)

An intent to launch instead of posting the notification to the status bar. Only for use with extremely high-priority notifications demanding the user's immediate attention, such as an incoming phone call or alarm clock that the user has explicitly set to a particular time. If this facility is used for something else, please give the user an option to turn it off and use a normal notification, as this can be extremely disruptive.

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

setGroup

NotificationCompat.Builder setGroup (String groupKey)

Set this notification to be part of a group of notifications sharing the same key. Grouped notifications may display in a cluster or stack on devices which support such rendering.

To make this notification the summary for its group, also call setGroupSummary(boolean). A sort order can be specified for group members by using setSortKey(String).

setGroupAlertBehavior

NotificationCompat.Builder setGroupAlertBehavior (int groupAlertBehavior)

Sets the group alert behavior for this notification. Use this method to mute this notification if alerts for this notification's group should be handled by a different notification. This is only applicable for notifications that belong to a group. This must be called on all notifications you want to mute. For example, if you want only the summary of your group to make noise, all children in the group should have the group alert behavior GROUP_ALERT_SUMMARY.

The default value is GROUP_ALERT_ALL.

setGroupSummary

NotificationCompat.Builder setGroupSummary (boolean isGroupSummary)

Set this notification to be the group summary for a group of notifications. Grouped notifications may display in a cluster or stack on devices which support such rendering. Requires a group key also be set using setGroup(String).

setLargeIcon

NotificationCompat.Builder setLargeIcon (Bitmap icon)

Set the large icon that is shown in the ticker and notification.

setLights

NotificationCompat.Builder setLights (int argb, 
                int onMs, 
                int offMs)

Set the argb value that you would like the LED on the device to blink, as well as the rate. The rate is specified in terms of the number of milliseconds to be on and then the number of milliseconds to be off.

setLocalOnly

NotificationCompat.Builder setLocalOnly (boolean b)

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

Some notifications can be bridged to other devices for remote display. This hint can be set to recommend this notification not be bridged.

setNumber

NotificationCompat.Builder setNumber (int number)

Set the large number at the right-hand side of the notification. This is equivalent to setContentInfo, although it might show the number in a different font size for readability.

setOngoing

NotificationCompat.Builder setOngoing (boolean ongoing)

Set whether this is an ongoing notification.

Ongoing notifications differ from regular notifications in the following ways:

• Ongoing notifications are sorted above the regular notifications in the notification panel.
• Ongoing notifications do not have an 'X' close button, and are not affected by the "Clear all" button.

setOnlyAlertOnce

NotificationCompat.Builder setOnlyAlertOnce (boolean onlyAlertOnce)

Set this flag if you would only like the sound, vibrate and ticker to be played if the notification is not already showing.

setPriority

NotificationCompat.Builder setPriority (int pri)

Set the 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 sets a notification's priority based on various factors including the setPriority value. The effect may differ slightly on different platforms.

setProgress

NotificationCompat.Builder setProgress (int max, 
                int progress, 
                boolean indeterminate)

Set the progress this notification represents, which may be represented as a ProgressBar.

setPublicVersion

NotificationCompat.Builder setPublicVersion (Notification n)

Supply a replacement Notification whose contents should be shown in insecure contexts (i.e. atop the secure lockscreen). See visibility and VISIBILITY_PUBLIC.

setRemoteInputHistory

NotificationCompat.Builder setRemoteInputHistory (CharSequence[] text)

Set the remote input history. This should be set to the most recent inputs that have been sent through a RemoteInput of this Notification and cleared once the it is no longer relevant (e.g. for chat notifications once the other party has responded). The most recent input must be stored at the 0 index, the second most recent at the 1 index, etc. Note that the system will limit both how far back the inputs will be shown and how much of each individual input is shown.

Note: The reply text will only be shown on notifications that have least one action with a RemoteInput.

setShortcutId

NotificationCompat.Builder setShortcutId (String shortcutId)

If this notification is duplicative of a Launcher shortcut, sets the id of the shortcut, in case the Launcher wants to hide the shortcut.

Note:This field will be ignored by Launchers that don't support badging or shortcuts.

setShowWhen

NotificationCompat.Builder setShowWhen (boolean show)

Control whether the timestamp set with setWhen is shown in the content view.

setSmallIcon

NotificationCompat.Builder setSmallIcon (int icon, 
                int level)

A variant of setSmallIcon(int) that takes an additional level parameter for when the icon is a LevelListDrawable.

setSmallIcon

NotificationCompat.Builder setSmallIcon (int icon)

Set the small icon to use in the notification layouts. Different classes of devices may return different sizes. See the UX guidelines for more information on how to design these icons.

setSortKey

NotificationCompat.Builder setSortKey (String sortKey)

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

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

setSound

NotificationCompat.Builder setSound (Uri sound)

Set the sound to play. It will play on the default stream.

On some platforms, a notification that is noisy is more likely to be presented as a heads-up notification.

setSound

NotificationCompat.Builder setSound (Uri sound, 
                int streamType)

Set the sound to play. It will play on the stream you supply.

On some platforms, a notification that is noisy is more likely to be presented as a heads-up notification.

setStyle

NotificationCompat.Builder setStyle (NotificationCompat.Style style)

Add a rich notification style to be applied at build time.
If the platform does not provide rich notification styles, this method has no effect. The user will always see the normal notification style.

setSubText

NotificationCompat.Builder setSubText (CharSequence text)

Set the third line of text in the platform notification template. Don't use if you're also using setProgress(int, int, boolean); they occupy the same location in the standard template.
If the platform does not provide large-format notifications, this method has no effect. The third line of text only appears in expanded view.

setTicker

NotificationCompat.Builder setTicker (CharSequence tickerText, 
                RemoteViews views)

Sets the "ticker" text which is sent to accessibility services. Prior to LOLLIPOP, sets the text that is displayed in the status bar when the notification first arrives, and also a RemoteViews object that may be displayed instead on some devices.

setTicker

NotificationCompat.Builder setTicker (CharSequence tickerText)

Sets the "ticker" text which is sent to accessibility services. Prior to LOLLIPOP, sets the text that is displayed in the status bar when the notification first arrives.

setTimeoutAfter

NotificationCompat.Builder setTimeoutAfter (long durationMs)

Specifies the time at which this notification should be canceled, if it is not already canceled.

setUsesChronometer

NotificationCompat.Builder setUsesChronometer (boolean b)

Show the when field as a stopwatch. Instead of presenting when as a timestamp, the notification will show an automatically updating display of the minutes and seconds since when. Useful when showing an elapsed time (like an ongoing phone call).

setVibrate

NotificationCompat.Builder setVibrate (long[] pattern)

Set the vibration pattern to use.

On some platforms, a notification that vibrates is more likely to be presented as a heads-up notification.

setVisibility

NotificationCompat.Builder setVisibility (int visibility)

Sets visibility.

setWhen

NotificationCompat.Builder setWhen (long when)

Set the time that the event occurred. Notifications in the panel are sorted by this time.

limitCharSequenceLength

CharSequence limitCharSequenceLength (CharSequence cs)