Notification.Builder

Notification.Builder

Notification.Builder (Context context)

Constructs a new Builder with the defaults:

addAction

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

This method was deprecated in API level 23.
Use addAction(Action) instead.

Add an action to this notification. Actions are typically displayed by the system as a button adjacent to the notification content.

Every action must have an icon (32dp square and matching the Holo Dark action bar visual style), a textual label, and a PendingIntent.

A notification in its expanded form can display up to 3 actions, from left to right in the order they were added. Actions will not be displayed when the notification is collapsed, however, so be sure that any essential functions may be accessed by the user in some other way (for example, in the Activity pointed to by contentIntent).

addAction

Notification.Builder addAction (Notification.Action action)

Add an action to this notification. Actions are typically displayed by the system as a button adjacent to the notification content.

Every action must have an icon (32dp square and matching the Holo Dark action bar visual style), a textual label, and a PendingIntent.

A notification in its expanded form can display up to 3 actions, from left to right in the order they were added. Actions will not be displayed when the notification is collapsed, however, so be sure that any essential functions may be accessed by the user in some other way (for example, in the Activity pointed to by contentIntent).

addExtras

Notification.Builder addExtras (Bundle extras)

Merge additional metadata into this notification.

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

addPerson

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

createBigContentView

RemoteViews createBigContentView ()

Construct a RemoteViews for the final big notification layout.

createContentView

RemoteViews createContentView ()

Construct a RemoteViews for the final 1U notification layout. In order: 1. Custom contentView from the caller 2. Style's proposed content view 3. Standard template view

createHeadsUpContentView

RemoteViews createHeadsUpContentView ()

Construct a RemoteViews for the final heads-up notification layout.

extend

Notification.Builder extend (Notification.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 16.
Use build() instead.

recoverBuilder

Notification.Builder recoverBuilder (Context context, 
                Notification n)

Creates a Builder from an existing notification so further changes can be made.

setActions

Notification.Builder setActions (Action... actions)

Alter the complete list of actions attached to this notification.

setAutoCancel

Notification.Builder setAutoCancel (boolean autoCancel)

Make this notification automatically dismissed when the user touches it. The PendingIntent set with setDeleteIntent(PendingIntent) will be sent when this happens.

setCategory

Notification.Builder setCategory (String category)

Set the notification category.

setChronometerCountDown

Notification.Builder setChronometerCountDown (boolean countDown)

Sets the Chronometer to count down instead of counting up.

This is only relevant if setUsesChronometer(boolean) has been set to true. If it isn't set the chronometer will count up.

setColor

Notification.Builder setColor (int argb)

Sets color.

setContent

Notification.Builder setContent (RemoteViews views)

Supply a custom RemoteViews to use instead of the platform template. Use setCustomContentView(RemoteViews) instead.

setContentInfo

Notification.Builder setContentInfo (CharSequence info)

This method was deprecated in API level 24.
use setSubText(CharSequence) instead to set a text in the header. For legacy apps targeting a version below N this field will still show up, but the subtext will take precedence.

A small piece of additional information pertaining to this notification. The platform template will draw this on the last line of the notification, at the far right (to the right of a smallIcon if it has been placed there).

setContentIntent

Notification.Builder setContentIntent (PendingIntent intent)

Supply a PendingIntent to be sent when the notification is clicked. As of HONEYCOMB, if this field is unset and you have specified a custom RemoteViews with setContent(RemoteViews), you can use RemoteViews.setOnClickPendingIntent(int,PendingIntent) to assign PendingIntents to individual views in that custom layout (i.e., to create clickable buttons inside the notification view).

setContentText

Notification.Builder setContentText (CharSequence text)

Set the second line of text in the platform notification template.

setContentTitle

Notification.Builder setContentTitle (CharSequence title)

Set the first line of text in the platform notification template.

setCustomBigContentView

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

setCustomContentView

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

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

setDefaults

Notification.Builder setDefaults (int defaults)

Set which notification properties will be inherited from system defaults.

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

Notification.Builder setDeleteIntent (PendingIntent intent)

Supply a PendingIntent to send when the notification is cleared explicitly by the user.

setExtras

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

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

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

setGroup

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

setGroupSummary

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

Notification.Builder setLargeIcon (Bitmap b)

Add a large icon to the notification content view. In the platform template, this image will be shown on the left of the notification view in place of the small icon (which will be placed in a small badge atop the large icon).

setLargeIcon

Notification.Builder setLargeIcon (Icon icon)

Add a large icon to the notification content view. In the platform template, this image will be shown on the left of the notification view in place of the small icon (which will be placed in a small badge atop the large icon).

setLights

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

Set the desired color for the indicator LED on the device, as well as the blink duty cycle (specified in milliseconds). Not all devices will honor all (or even any) of these values.

setLocalOnly

Notification.Builder setLocalOnly (boolean localOnly)

Set whether or not this notification should not bridge to other devices.

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

setNumber

Notification.Builder setNumber (int number)

This method was deprecated in API level 24.
this number is not shown anywhere anymore

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

Notification.Builder setOngoing (boolean ongoing)

Set whether this is an "ongoing" notification. Ongoing notifications cannot be dismissed by the user, so your application or service must take care of canceling them. They are typically used to indicate a background task that the user is actively engaged with (e.g., playing music) or is pending in some way and therefore occupying the device (e.g., a file download, sync operation, active network connection).

setOnlyAlertOnce

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

Notification.Builder setPriority (int pri)

Set the priority of this notification.

setProgress

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

Set the progress this notification represents. The platform template will represent this using a ProgressBar.

setPublicVersion

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

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

setShowWhen

Notification.Builder setShowWhen (boolean show)

Control whether the timestamp set with setWhen is shown in the content view. For apps targeting N and above, this defaults to false. For earlier apps, the default is true.

setSmallIcon

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

Notification.Builder setSmallIcon (int icon)

Set the small icon resource, which will be used to represent the notification in the status bar. The platform template for the expanded view will draw this icon in the left, unless a large icon has also been specified, in which case the small icon will be moved to the right-hand side.

setSmallIcon

Notification.Builder setSmallIcon (Icon icon)

Set the small icon, which will be used to represent the notification in the status bar and content view (unless overriden there by a large icon).

setSortKey

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

Notification.Builder setSound (Uri sound, 
                AudioAttributes audioAttributes)

Set the sound to play, along with specific audio attributes to use during playback.

A notification that is noisy is more likely to be presented as a heads-up notification.

setSound

Notification.Builder setSound (Uri sound)

Set the sound to play. It will be played using the default audio attributes for notifications.

A notification that is noisy is more likely to be presented as a heads-up notification.

setSound

Notification.Builder setSound (Uri sound, 
                int streamType)

This method was deprecated in API level 21.
use setSound(Uri, AudioAttributes) instead.

Set the sound to play, along with a specific stream on which to play it. See AudioManager for the STREAM_ constants.

A notification that is noisy is more likely to be presented as a heads-up notification.

setStyle

Notification.Builder setStyle (Notification.Style style)

Add a rich notification style to be applied at build time.

setSubText

Notification.Builder setSubText (CharSequence text)

This provides some additional information that is displayed in the notification. No guarantees are given where exactly it is displayed.

This information should only be provided if it provides an essential benefit to the understanding of the notification. The more text you provide the less readable it becomes. For example, an email client should only provide the account name here if more than one email account has been added.

As of N this information is displayed in the notification header area. On Android versions before N this will be shown in the third line of text in the platform notification template. You should not be using setProgress(int, int, boolean) at the same time on those versions; they occupy the same place.

setTicker

Notification.Builder setTicker (CharSequence tickerText, 
                RemoteViews views)

Obsolete version of setTicker(CharSequence).

setTicker

Notification.Builder setTicker (CharSequence tickerText)

Set the "ticker" text which is sent to accessibility services.

setUsesChronometer

Notification.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). The counter can also be set to count down to when when using setChronometerCountDown(boolean).

setVibrate

Notification.Builder setVibrate (long[] pattern)

Set the vibration pattern to use. See vibrate(long[], int) for a discussion of the pattern parameter.

A notification that vibrates is more likely to be presented as a heads-up notification.

setVisibility

Notification.Builder setVisibility (int visibility)

Specify the value of visibility.

setWhen

Notification.Builder setWhen (long when)

Add a timestamp pertaining to the notification (usually the time the event occurred). For apps targeting N and above, this time is not shown anymore by default and must be opted into by using setShowWhen(boolean)