NotificationCompat.Builder

Builder(context: Context, channelId: String)

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

Builder(context: Context, notification: Notification)

Creates a NotificationCompat.Builder which can be used to build a notification that is equivalent to the given one, such that updates can be made to an existing notification with the NotificationCompat.Builder API.

fun addAction(action: NotificationCompat.Action?): NotificationCompat.Builder

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 android.app.Activity that starts when a user clicks the notification (see setContentIntent()), and then enhance the notification by implementing the same functionality with addAction().

fun addAction(icon: Int, title: CharSequence?, intent: PendingIntent?): NotificationCompat.Builder

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 android.app.Activity that starts when a user clicks the notification (see setContentIntent()), and then enhance the notification by implementing the same functionality with addAction().

fun addExtras(extras: Bundle?): NotificationCompat.Builder

Merge additional metadata into this notification.

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

@RequiresApi(value = 21)
fun addInvisibleAction(action: NotificationCompat.Action?): NotificationCompat.Builder

Add an invisible action to this notification. Invisible actions are never displayed by the system, but can be retrieved and used by other application listening to system notifications. Invisible actions are supported from Android 4.4.4 (API 20) and can be retrieved using getInvisibleActions.

@RequiresApi(value = 21)
fun addInvisibleAction(icon: Int, title: CharSequence?, intent: PendingIntent?): NotificationCompat.Builder

Add an invisible action to this notification. Invisible actions are never displayed by the system, but can be retrieved and used by other application listening to system notifications. Invisible actions are supported from Android 4.4.4 (API 20) and can be retrieved using getInvisibleActions.

fun addPerson(person: Person?): NotificationCompat.Builder

Add a person that is relevant to this notification.

Depending on user preferences, this annotation may allow the notification to pass through interruption filters, if this notification is of category CATEGORY_CALL or CATEGORY_MESSAGE. The addition of people may also cause this notification to appear more prominently in the user interface.

A person should usually contain a uri in order to benefit from the ranking boost. However, even if no uri is provided, it's beneficial to provide other people in the notification, such that listeners and voice only devices can announce and handle them properly.

fun addPerson(uri: String?): NotificationCompat.Builder

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 android.provider.ContactsContract.PhoneLookup.

fun build(): Notification

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

fun clearActions(): NotificationCompat.Builder

Clear any actions added via addAction

fun clearInvisibleActions(): NotificationCompat.Builder

Clear any invisible actions added via addInvisibleAction

fun clearPeople(): NotificationCompat.Builder

Clear any people added via either addPerson or addPerson

fun createBigContentView(): RemoteViews?

Construct a RemoteViews for the final big notification layout.

fun createContentView(): RemoteViews?

Construct a RemoteViews for the final notification layout.

fun createHeadsUpContentView(): RemoteViews?

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

fun extend(extender: NotificationCompat.Extender): NotificationCompat.Builder

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

fun getExtras(): Bundle

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.

fun setAllowSystemGeneratedContextualActions(allowed: Boolean): NotificationCompat.Builder

Determines whether the platform can generate contextual actions for a notification. By default this is true.

fun setAutoCancel(autoCancel: Boolean): NotificationCompat.Builder

Setting this flag will make it so the notification is automatically canceled when the user clicks it in the panel.

fun setBadgeIconType(icon: Int): NotificationCompat.Builder

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.

fun setBubbleMetadata(data: NotificationCompat.BubbleMetadata?): NotificationCompat.Builder

Sets the BubbleMetadata that will be used to display app content in a floating window over the existing foreground activity.

This data will be ignored unless the notification is posted to a channel that allows bubbles.

Notifications allowed to bubble that have valid bubble metadata will display in collapsed state outside of the notification shade on unlocked devices. When a user interacts with the collapsed state, the bubble intent will be invoked and displayed.

fun setCategory(category: String?): NotificationCompat.Builder

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.

fun setChannelId(channelId: String): NotificationCompat.Builder

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

@RequiresApi(value = 24)
fun setChronometerCountDown(countsDown: Boolean): NotificationCompat.Builder

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.

fun setColor(argb: @ColorInt Int): NotificationCompat.Builder

Sets color.

fun setColorized(colorize: Boolean): NotificationCompat.Builder

Set whether this notification should be colorized. When set, the color set with setColor 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.

fun setContent(views: RemoteViews?): NotificationCompat.Builder

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

fun setContentInfo(info: CharSequence?): NotificationCompat.Builder

A small piece of additional information pertaining to this notification. Where this text is displayed varies between platform versions. Use setSubText 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.

fun setContentIntent(intent: PendingIntent?): NotificationCompat.Builder

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.

fun setContentText(text: CharSequence?): NotificationCompat.Builder

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

fun setContentTitle(title: CharSequence?): NotificationCompat.Builder

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

fun setCustomBigContentView(contentView: RemoteViews?): NotificationCompat.Builder

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.

fun setCustomContentView(contentView: RemoteViews?): NotificationCompat.Builder

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

fun setCustomHeadsUpContentView(contentView: RemoteViews?): NotificationCompat.Builder

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.

fun setDefaults(defaults: Int): NotificationCompat.Builder

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.

On platforms O and above this value is ignored in favor of the values set on the notification's channel. On older platforms, this value is still used, so it is still required for apps supporting those platforms.

fun setDeleteIntent(intent: PendingIntent?): NotificationCompat.Builder

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

fun setExtras(extras: Bundle?): NotificationCompat.Builder

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 to merge in metadata instead.

fun setForegroundServiceBehavior(behavior: Int): NotificationCompat.Builder

Specify a desired visibility policy for a Notification associated with a foreground service. The default value is FOREGROUND_SERVICE_DEFAULT, meaning the system can choose to defer visibility of the notification for a short time after the service is started. Pass FOREGROUND_SERVICE_IMMEDIATE to this method in order to guarantee that visibility is never deferred. Pass FOREGROUND_SERVICE_DEFERRED to request that visibility is deferred whenever possible.

Note that deferred visibility is not guaranteed. There may be some circumstances under which the system will show the foreground service's associated Notification immediately even when the app has used this method to explicitly request deferred display.

fun setFullScreenIntent(intent: PendingIntent?, highPriority: Boolean): NotificationCompat.Builder

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.

fun setGroup(groupKey: String?): NotificationCompat.Builder

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. A sort order can be specified for group members by using setSortKey.

fun setGroupAlertBehavior(groupAlertBehavior: Int): NotificationCompat.Builder

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.

fun setGroupSummary(isGroupSummary: Boolean): NotificationCompat.Builder

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.

fun setLargeIcon(icon: Bitmap?): NotificationCompat.Builder

Sets the large icon that is shown in the notification. Icons will be scaled on versions before API 27. Starting in API 27, the framework does this automatically.

@RequiresApi(value = 23)
fun setLargeIcon(icon: Icon?): NotificationCompat.Builder

Sets the large icon that is shown in the notification. Starting in API 27, the framework scales icons automatically. Before API 27, for safety, #reduceLargeIconSize should be called on bitmaps before putting them in an Icon and passing them into this function.

fun setLights(argb: @ColorInt Int, onMs: Int, offMs: Int): NotificationCompat.Builder

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.

On platforms O and above this value is ignored in favor of the value set on the notification's channel. On older platforms, this value is still used, so it is still required for apps supporting those platforms.

fun setLocalOnly(b: Boolean): NotificationCompat.Builder

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.

fun setLocusId(locusId: LocusIdCompat?): NotificationCompat.Builder

Sets the LocusIdCompat associated with this notification.

This method should be called when the LocusIdCompat is used in other places (such as androidx.core.content.pm.ShortcutInfoCompat and android.view.contentcapture.ContentCaptureContext) so the device's intelligence services can correlate them.

fun setNotificationSilent(): NotificationCompat.Builder

Silences this instance of the notification, regardless of the sounds or vibrations set on the notification or notification channel.

fun setNumber(number: Int): NotificationCompat.Builder

Sets the number of items this notification represents. On the latest platforms, this may be displayed as a badge count for Launchers that support badging. Prior to O it could be shown in the header. And prior to N this was shown in the notification on the right side.

fun setOngoing(ongoing: Boolean): NotificationCompat.Builder

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

fun setOnlyAlertOnce(onlyAlertOnce: Boolean): NotificationCompat.Builder

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

fun setPriority(pri: Int): NotificationCompat.Builder

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.

On platforms O and above this value is ignored in favor of the importance value set on the notification's channel. On older platforms, this value is still used, so it is still required for apps supporting those platforms.

fun setProgress(max: Int, progress: Int, indeterminate: Boolean): NotificationCompat.Builder

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

fun setPublicVersion(n: Notification?): NotificationCompat.Builder

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

fun setRemoteInputHistory(text: Array<CharSequence!>?): NotificationCompat.Builder

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.

fun setRequestPromotedOngoing(requestPromotedOngoing: Boolean): NotificationCompat.Builder

Set whether this notification is requesting to be a promoted ongoing notification.

This is the first requirement of hasPromotableCharacteristics.

fun setSettingsText(text: CharSequence?): NotificationCompat.Builder

Provides text that will appear as a link to your application's settings.

This text does not appear within notification templates but may appear when the user uses an affordance to learn more about the notification. Additionally, this text will not appear unless you provide a valid link target by handling INTENT_CATEGORY_NOTIFICATION_PREFERENCES.

This text is meant to be concise description about what the user can customize when they click on this link. The recommended maximum length is 40 characters.

Prior to O this field has no effect.

fun setShortCriticalText(shortCriticalText: String?): NotificationCompat.Builder

Sets a very short string summarizing the most critical information contained in the notification. Suggested max length is 7 characters, and there is no guarantee how much or how little of this text will be shown.

fun setShortcutId(shortcutId: String?): NotificationCompat.Builder

From Android 11, messaging notifications (those that use MessagingStyle) that use this method to link to a published long-lived sharing shortcut may appear in a dedicated Conversation section of the shade and may show configuration options that are unique to conversations. This behavior should be reserved for person to person(s) conversations where there is a likely social obligation for an individual to respond.

For example, the following are some examples of notifications that belong in the conversation space:

• 1:1 conversations between two individuals
• Group conversations between individuals where everyone can contribute

• Advertisements from a bot (even if personal and contextualized)
• Engagement notifications from a bot
• Directional conversations where there is an active speaker and many passive individuals
• Stream / posting updates from other individuals
• Email, document comments, or other conversation types that are not real-time

Additionally, this method can be used for all types of notifications to mark this notification as duplicative of a Launcher shortcut. Launchers that show badges or notification content may then suppress the shortcut in favor of the content of this notification.

If this notification has BubbleMetadata attached that was created with a shortcutId a check will be performed to ensure the shortcutId supplied to bubble metadata matches the shortcutId set here, if one was set. If the shortcutId's were specified but do not match, an exception is thrown.

fun setShortcutInfo(shortcutInfo: ShortcutInfoCompat?): NotificationCompat.Builder

Populates this notification with given ShortcutInfoCompat.

Sets shortcutId based on the given shortcut. In addition, it also sets locusId and contentTitle if they were empty.

fun setShowWhen(show: Boolean): NotificationCompat.Builder

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

fun setSilent(silent: Boolean): NotificationCompat.Builder

If true, silences this instance of the notification, regardless of the sounds or vibrations set on the notification or notification channel. If false, then the normal sound and vibration logic applies. Defaults to false.

@RequiresApi(value = 23)
fun setSmallIcon(icon: IconCompat): NotificationCompat.Builder

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.

fun setSmallIcon(icon: Int): NotificationCompat.Builder

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.

fun setSmallIcon(icon: Int, level: Int): NotificationCompat.Builder

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

fun setSortKey(sortKey: String?): NotificationCompat.Builder

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.

fun setSound(sound: Uri?): NotificationCompat.Builder

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.

On platforms O and above this value is ignored in favor of the value set on the notification's channel. On older platforms, this value is still used, so it is still required for apps supporting those platforms.

fun setSound(sound: Uri?, streamType: Int): NotificationCompat.Builder

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.

On platforms O and above this value is ignored in favor of the value set on the notification's channel. On older platforms, this value is still used, so it is still required for apps supporting those platforms.

fun setStyle(style: NotificationCompat.Style?): NotificationCompat.Builder

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.

fun setSubText(text: CharSequence?): NotificationCompat.Builder

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 at the same time on those versions; they occupy the same place.

fun setTicker(tickerText: CharSequence?): NotificationCompat.Builder

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.

fun setTicker(tickerText: CharSequence?, views: RemoteViews?): NotificationCompat.Builder

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.

fun setTimeoutAfter(durationMs: Long): NotificationCompat.Builder

Specifies the time at which this notification should be canceled, if it is not already canceled. No-op on versions prior to O.

fun setUsesChronometer(b: Boolean): NotificationCompat.Builder

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

fun setVibrate(pattern: LongArray?): NotificationCompat.Builder

Set the vibration pattern to use.

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

On platforms O and above this value is ignored in favor of the value set on the notification's channel. On older platforms, this value is still used, so it is still required for apps supporting those platforms.

fun setVisibility(visibility: Int): NotificationCompat.Builder

Sets visibility.

fun setWhen(when: Long): NotificationCompat.Builder

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