Android APIs
public static class

NotificationCompat.Builder

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

Class Overview

Builder class for NotificationCompat objects. Allows easier control over all the flags, as well as help constructing the typical notification layouts.

On platform versions that don't offer expanded notifications, methods that depend on expanded notifications have no effect.

For example, 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.

For this reason, you should always ensure that UI controls in a notification are also available in an Activity in your app, and you should always start that Activity when users click the notification. To do this, use the setContentIntent() method.

Summary

Public Constructors
NotificationCompat.Builder(Context context)
Constructor.
Public Methods
NotificationCompat.Builder addAction(NotificationCompat.Action action)
Add an action to this notification.
NotificationCompat.Builder addAction(int icon, CharSequence title, PendingIntent intent)
Add an action to this notification.
NotificationCompat.Builder addExtras(Bundle extras)
Merge additional metadata into this notification.
Notification build()
Combine all of the options that have been set and return a new Notification object.
NotificationCompat.Builder extend(NotificationCompat.Extender extender)
Apply an extender to this notification builder.
Bundle getExtras()
Get the current metadata Bundle used by this notification Builder.
Notification getNotification()
This method is deprecated. Use build() instead.
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.
NotificationCompat.Builder setContent(RemoteViews views)
Supply a custom RemoteViews to use instead of the standard one.
NotificationCompat.Builder setContentInfo(CharSequence info)
Set the large text at the right-hand side of the notification.
NotificationCompat.Builder setContentIntent(PendingIntent intent)
Supply a PendingIntent to send when the notification is clicked.
NotificationCompat.Builder setContentText(CharSequence text)
Set the text (second row) of the notification, in a standard notification.
NotificationCompat.Builder setContentTitle(CharSequence title)
Set the title (first row) of the notification, in a standard notification.
NotificationCompat.Builder setDefaults(int defaults)
Set the default notification options that will be used.
NotificationCompat.Builder setDeleteIntent(PendingIntent intent)
Supply a PendingIntent to send when the notification is cleared by the user directly from the notification panel.
NotificationCompat.Builder setExtras(Bundle extras)
Set metadata for this notification.
NotificationCompat.Builder setFullScreenIntent(PendingIntent intent, boolean highPriority)
An intent to launch instead of posting the notification to the status bar.
NotificationCompat.Builder setGroup(String groupKey)
Set this notification to be part of a group of notifications sharing the same key.
NotificationCompat.Builder setGroupSummary(boolean isGroupSummary)
Set this notification to be the group summary for a group of notifications.
NotificationCompat.Builder setLargeIcon(Bitmap icon)
Set the large icon that is shown in the ticker and notification.
NotificationCompat.Builder setLights(int argb, int onMs, int offMs)
Set the argb value that you would like the LED on the device to blnk, as well as the rate.
NotificationCompat.Builder setLocalOnly(boolean b)
Set whether or not this notification is only relevant to the current device.
NotificationCompat.Builder setNumber(int number)
Set the large number at the right-hand side of the notification.
NotificationCompat.Builder setOngoing(boolean ongoing)
Set whether this is an ongoing notification.
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.
NotificationCompat.Builder setPriority(int pri)
Set the relative priority for this notification.
NotificationCompat.Builder setProgress(int max, int progress, boolean indeterminate)
Set the progress this notification represents, which may be represented as a ProgressBar.
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.
NotificationCompat.Builder setSmallIcon(int icon)
Set the small icon to use in the notification layouts.
NotificationCompat.Builder setSortKey(String sortKey)
Set a sort key that orders this notification among other notifications from the same package.
NotificationCompat.Builder setSound(Uri sound)
Set the sound to play.
NotificationCompat.Builder setSound(Uri sound, int streamType)
Set the sound to play.
NotificationCompat.Builder setStyle(NotificationCompat.Style style)
Add a rich notification style to be applied at build time.
NotificationCompat.Builder setSubText(CharSequence text)
Set the third line of text in the platform notification template.
NotificationCompat.Builder setTicker(CharSequence tickerText, RemoteViews views)
Set 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.
NotificationCompat.Builder setTicker(CharSequence tickerText)
Set the text that is displayed in the status bar when the notification first arrives.
NotificationCompat.Builder setUsesChronometer(boolean b)
Show the when field as a stopwatch.
NotificationCompat.Builder setVibrate(long[] pattern)
Set the vibration pattern to use.
NotificationCompat.Builder setWhen(long when)
Set the time that the event occurred.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public NotificationCompat.Builder (Context context)

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

Parameters
context A Context that will be used to construct the RemoteViews. The Context will not be held past the lifetime of this Builder object.

Public Methods

public 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().

Parameters
action The action to add.

public 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().

Parameters
icon Resource ID of a drawable that represents the action.
title Text describing the action.
intent PendingIntent to be fired when the action is invoked.

public NotificationCompat.Builder addExtras (Bundle extras)

Merge additional metadata into this notification.

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

See Also

public Notification build ()

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

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

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

See Also

public Notification getNotification ()

This method is deprecated.
Use build() instead.

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

public NotificationCompat.Builder setContent (RemoteViews views)

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

public NotificationCompat.Builder setContentInfo (CharSequence info)

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

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

public NotificationCompat.Builder setContentText (CharSequence text)

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

public NotificationCompat.Builder setContentTitle (CharSequence title)

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

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

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

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

See Also

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

Parameters
intent The pending intent to launch.
highPriority Passing true will cause this notification to be sent even if other notifications are suppressed.

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

Parameters
groupKey The group key of the group.
Returns
  • this object for method chaining

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

Parameters
isGroupSummary Whether this notification should be a group summary.
Returns
  • this object for method chaining

public NotificationCompat.Builder setLargeIcon (Bitmap icon)

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

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

Set the argb value that you would like the LED on the device to blnk, 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.

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

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

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

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

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

Parameters
pri Relative priority for this notification. Must be one of the priority constants defined by NotificationCompat. Acceptable values range from PRIORITY_MIN (-2) to PRIORITY_MAX (2).

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

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

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

Parameters
icon A resource ID in the application's package of the drawble to use.
level The level to use for the icon.

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

Parameters
icon A resource ID in the application's package of the drawble to use.

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

public NotificationCompat.Builder setSound (Uri sound)

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

public NotificationCompat.Builder setSound (Uri sound, int streamType)

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

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

Parameters
style Object responsible for modifying the notification style.

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

public NotificationCompat.Builder setTicker (CharSequence tickerText, RemoteViews views)

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

public NotificationCompat.Builder setTicker (CharSequence tickerText)

Set the text that is displayed in the status bar when the notification first arrives.

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

See Also

public NotificationCompat.Builder setVibrate (long[] pattern)

Set the vibration pattern to use.

public NotificationCompat.Builder setWhen (long when)

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