NotificationChannelCompat.Builder

Added in 1.5.0

class NotificationChannelCompat.Builder


Builder class for NotificationChannelCompat objects.

Summary

Public constructors

Builder(id: String, importance: Int)

Creates a notification channel builder.

Public functions

NotificationChannelCompat

Creates a NotificationChannelCompat instance.

NotificationChannelCompat.Builder
setConversationId(parentChannelId: String, conversationId: String)

Sets this channel as being conversation-centric.

NotificationChannelCompat.Builder
setDescription(description: String?)

Sets the user visible description of this channel.

NotificationChannelCompat.Builder
setGroup(groupId: String?)

Sets what group this channel belongs to.

NotificationChannelCompat.Builder
setImportance(importance: Int)

Sets the level of interruption of this notification channel.

NotificationChannelCompat.Builder

Sets the notification light color for notifications posted to this channel, if lights are enabled on this channel and the device supports that feature.

NotificationChannelCompat.Builder

Sets whether notifications posted to this channel should display notification lights, on devices that support that feature.

NotificationChannelCompat.Builder

Sets the user visible name of this channel.

NotificationChannelCompat.Builder
setShowBadge(showBadge: Boolean)

Sets whether notifications posted to this channel can appear as application icon badges in a Launcher.

NotificationChannelCompat.Builder
setSound(sound: Uri?, audioAttributes: AudioAttributes?)

Sets the sound that should be played for notifications posted to this channel and its audio attributes.

NotificationChannelCompat.Builder

Sets whether notification posted to this channel should vibrate.

NotificationChannelCompat.Builder
setVibrationPattern(vibrationPattern: LongArray?)

Sets the vibration pattern for notifications posted to this channel.

Public constructors

Builder

Added in 1.5.0
Builder(id: String, importance: Int)

Creates a notification channel builder.

Parameters
id: String

The id of the channel. Must be unique per package. The value may be truncated if it is too long.

importance: Int

The importance of the channel. This controls how interruptive notifications posted to this channel are.

Public functions

build

Added in 1.5.0
fun build(): NotificationChannelCompat

Creates a NotificationChannelCompat instance.

setConversationId

Added in 1.5.0
fun setConversationId(parentChannelId: String, conversationId: String): NotificationChannelCompat.Builder

Sets this channel as being conversation-centric. Different settings and functionality may be exposed for conversation-centric channels. Calling this on SDKs that do not support conversations will have no effect on the built channel. As a result, this channel will not be linked to the channel with the parentChannelId. That means that this channel must be published to directly to be used; it cannot be published to by publishing to the parentChannelId with the shortcutId.

Parameters
parentChannelId: String

The getId id} of the generic channel that notifications of this type would be posted to in absence of a specific conversation id. For example, if this channel represents 'Messages from Person A', the parent channel would be 'Messages.'

conversationId: String

The getId of the shortcut representing this channel's conversation.

setDescription

Added in 1.5.0
fun setDescription(description: String?): NotificationChannelCompat.Builder

Sets the user visible description of this channel.

The recommended maximum length is 300 characters; the value may be truncated if it is too long.

setGroup

Added in 1.5.0
fun setGroup(groupId: String?): NotificationChannelCompat.Builder

Sets what group this channel belongs to. Group information is only used for presentation, not for behavior. Only modifiable before the channel is submitted to createNotificationChannel, unless the channel is not currently part of a group.

Parameters
groupId: String?

the id of a group created by createNotificationChannelGroup.

setImportance

Added in 1.5.0
fun setImportance(importance: Int): NotificationChannelCompat.Builder

Sets the level of interruption of this notification channel. Only modifiable before the channel is submitted to createNotificationChannel.

Parameters
importance: Int

the amount the user should be interrupted by notifications from this channel.

setLightColor

Added in 1.5.0
fun setLightColor(argb: Int): NotificationChannelCompat.Builder

Sets the notification light color for notifications posted to this channel, if lights are enabled on this channel and the device supports that feature. Only modifiable before the channel is submitted to createNotificationChannel.

setLightsEnabled

Added in 1.5.0
fun setLightsEnabled(lights: Boolean): NotificationChannelCompat.Builder

Sets whether notifications posted to this channel should display notification lights, on devices that support that feature. Only modifiable before the channel is submitted to createNotificationChannel.

setName

Added in 1.5.0
fun setName(name: CharSequence?): NotificationChannelCompat.Builder

Sets the user visible name of this channel. You can rename this channel when the system locale changes by listening for the ACTION_LOCALE_CHANGED broadcast.

The recommended maximum length is 40 characters; the value may be truncated if it is too long.

setShowBadge

Added in 1.5.0
fun setShowBadge(showBadge: Boolean): NotificationChannelCompat.Builder

Sets whether notifications posted to this channel can appear as application icon badges in a Launcher. Only modifiable before the channel is submitted to createNotificationChannel.

Parameters
showBadge: Boolean

true if badges should be allowed to be shown.

setSound

Added in 1.5.0
fun setSound(sound: Uri?, audioAttributes: AudioAttributes?): NotificationChannelCompat.Builder

Sets the sound that should be played for notifications posted to this channel and its audio attributes. Notification channels with an setImportance importance} of at least IMPORTANCE_DEFAULT should have a sound. Only modifiable before the channel is submitted to createNotificationChannel.

setVibrationEnabled

Added in 1.5.0
fun setVibrationEnabled(vibration: Boolean): NotificationChannelCompat.Builder

Sets whether notification posted to this channel should vibrate. The vibration pattern can be set with setVibrationPattern. Only modifiable before the channel is submitted to createNotificationChannel.

setVibrationPattern

Added in 1.5.0
fun setVibrationPattern(vibrationPattern: LongArray?): NotificationChannelCompat.Builder

Sets the vibration pattern for notifications posted to this channel. If the provided pattern is valid (non-null, non-empty), will setVibrationEnabled enable vibration} as well. Otherwise, vibration will be disabled. Only modifiable before the channel is submitted to createNotificationChannel.