Summary: Ctors | Methods | Inherited Methods

NotificationChannelCompat.Builder

Kotlin |Java

public static class NotificationChannelCompat.Builder
extends Object

java.lang.Object
↳	androidx.core.app.NotificationChannelCompat.Builder

Builder class for NotificationChannelCompat objects.

Summary

Public constructors
`Builder(String id, int importance)` Creates a notification channel builder.

Public methods
`NotificationChannelCompat`	`build()` Creates a `NotificationChannelCompat` instance.
`NotificationChannelCompat.Builder`	`setConversationId(String parentChannelId, String conversationId)` Sets this channel as being conversation-centric.
`NotificationChannelCompat.Builder`	`setDescription(String description)` Sets the user visible description of this channel.
`NotificationChannelCompat.Builder`	`setGroup(String groupId)` Sets what group this channel belongs to.
`NotificationChannelCompat.Builder`	`setImportance(int importance)` Sets the level of interruption of this notification channel.
`NotificationChannelCompat.Builder`	`setLightColor(int argb)` 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`	`setLightsEnabled(boolean lights)` Sets whether notifications posted to this channel should display notification lights, on devices that support that feature.
`NotificationChannelCompat.Builder`	`setName(CharSequence name)` Sets the user visible name of this channel.
`NotificationChannelCompat.Builder`	`setShowBadge(boolean showBadge)` Sets whether notifications posted to this channel can appear as application icon badges in a Launcher.
`NotificationChannelCompat.Builder`	`setSound(Uri sound, AudioAttributes audioAttributes)` Sets the sound that should be played for notifications posted to this channel and its audio attributes.
`NotificationChannelCompat.Builder`	`setVibrationEnabled(boolean vibration)` Sets whether notification posted to this channel should vibrate.
`NotificationChannelCompat.Builder`	`setVibrationPattern(long[] vibrationPattern)` Sets the vibration pattern for notifications posted to this channel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

Builder

public Builder (String id, 
                int importance)

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 methods

build

public NotificationChannelCompat build ()

Creates a NotificationChannelCompat instance.

Returns
`NotificationChannelCompat`

setConversationId

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

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 `NotificationChannelCompat.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 `ShortcutInfoCompat.getId()` of the shortcut representing this channel's conversation.

Returns
`NotificationChannelCompat.Builder`

setDescription

public NotificationChannelCompat.Builder setDescription (String description)

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.

Parameters
`description`	`String`

Returns
`NotificationChannelCompat.Builder`

setGroup

public NotificationChannelCompat.Builder setGroup (String groupId)

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 NotificationManagerCompat.createNotificationChannel(NotificationChannelCompat), unless the channel is not currently part of a group.

Parameters
`groupId`	`String`: the id of a group created by `NotificationManagerCompat.createNotificationChannelGroup(NotificationChannelGroup)`.

Returns
`NotificationChannelCompat.Builder`

setImportance

public NotificationChannelCompat.Builder setImportance (int importance)

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

Parameters
`importance`	`int`: the amount the user should be interrupted by notifications from this channel.

Returns
`NotificationChannelCompat.Builder`

setLightColor

public NotificationChannelCompat.Builder setLightColor (int argb)

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 NotificationManagerCompat.createNotificationChannel(NotificationChannelCompat).

Parameters
`argb`	`int`

Returns
`NotificationChannelCompat.Builder`

setLightsEnabled

public NotificationChannelCompat.Builder setLightsEnabled (boolean lights)

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 NotificationManagerCompat.createNotificationChannel(NotificationChannelCompat).

Parameters
`lights`	`boolean`

Returns
`NotificationChannelCompat.Builder`

setName

public NotificationChannelCompat.Builder setName (CharSequence name)

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

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

Parameters
`name`	`CharSequence`

Returns
`NotificationChannelCompat.Builder`

setShowBadge

public NotificationChannelCompat.Builder setShowBadge (boolean showBadge)

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

Parameters
`showBadge`	`boolean`: true if badges should be allowed to be shown.

Returns
`NotificationChannelCompat.Builder`

setSound

public NotificationChannelCompat.Builder setSound (Uri sound, 
                AudioAttributes audioAttributes)

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

Parameters
`sound`	`Uri`
`audioAttributes`	`AudioAttributes`

Returns
`NotificationChannelCompat.Builder`

setVibrationEnabled

public NotificationChannelCompat.Builder setVibrationEnabled (boolean vibration)

Sets whether notification posted to this channel should vibrate. The vibration pattern can be set with setVibrationPattern(long[]). Only modifiable before the channel is submitted to NotificationManagerCompat.createNotificationChannel(NotificationChannelCompat).

Parameters
`vibration`	`boolean`

Returns
`NotificationChannelCompat.Builder`

setVibrationPattern

public NotificationChannelCompat.Builder setVibrationPattern (long[] vibrationPattern)

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

Parameters
`vibrationPattern`	`long`

Returns
`NotificationChannelCompat.Builder`