NotificationChannelCompat

Added in 1.5.0

class NotificationChannelCompat


A representation of settings that apply to a collection of similarly themed notifications. Setters return this to allow chaining. This class doesn't do anything on older SDKs which don't support Notification Channels.

Summary

Nested types

Builder class for NotificationChannelCompat objects.

Constants

const String!
DEFAULT_CHANNEL_ID = "miscellaneous"

The id of the default channel for an app.

Public functions

Boolean

Returns whether notifications posted to this channel are allowed to display outside of the notification shade, in a floating window on top of other apps.

Boolean

Whether or not notifications posted to this channel can bypass the Do Not Disturb INTERRUPTION_FILTER_PRIORITY mode.

Boolean

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

AudioAttributes?

Returns the audio attributes for sound played by notifications posted to this channel.

String?

Returns the id of the conversation backing this channel, if it's associated with a conversation.

String?

Returns the user visible description of this channel.

String?

Returns what group this channel belongs to.

String

Returns the id of this channel.

Int

Returns the user specified importance e.g. IMPORTANCE_LOW for notifications posted to this channel.

Int

Returns the notification light color for notifications posted to this channel.

Int

Returns whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.

CharSequence?

Returns the user visible name of this channel.

String?

Returns the id of the parent notification channel to this channel, if it's a conversation related channel.

Uri?

Returns the notification sound for this channel.

LongArray<Long>?

Returns the vibration pattern for notifications posted to this channel.

Boolean

Whether or not notifications in this conversation are considered important.

Boolean

Returns whether notifications posted to this channel trigger notification lights.

Boolean

Returns whether notifications posted to this channel always vibrate.

NotificationChannelCompat.Builder

Creates a Builder instance with all the writeable property values of this instance.

Constants

DEFAULT_CHANNEL_ID

Added in 1.5.0
const val DEFAULT_CHANNEL_ID = "miscellaneous": String!

The id of the default channel for an app. This id is reserved by the system. All notifications posted from apps targeting N_MR1 or earlier without a notification channel specified are posted to this channel.

Public functions

canBubble

Added in 1.5.0
fun canBubble(): Boolean

Returns whether notifications posted to this channel are allowed to display outside of the notification shade, in a floating window on top of other apps.

This is a read-only property which is only valid on instances fetched from the NotificationManagerCompat.

canBypassDnd

Added in 1.5.0
fun canBypassDnd(): Boolean

Whether or not notifications posted to this channel can bypass the Do Not Disturb INTERRUPTION_FILTER_PRIORITY mode.

This is a read-only property which is only valid on instances fetched from the NotificationManagerCompat.

canShowBadge

Added in 1.5.0
fun canShowBadge(): Boolean

Returns whether notifications posted to this channel can appear as badges in a Launcher application. Note that badging may be disabled for other reasons.

getAudioAttributes

Added in 1.5.0
fun getAudioAttributes(): AudioAttributes?

Returns the audio attributes for sound played by notifications posted to this channel.

getConversationId

Added in 1.5.0
fun getConversationId(): String?

Returns the id of the conversation backing this channel, if it's associated with a conversation. See setConversationId.

getDescription

Added in 1.5.0
fun getDescription(): String?

Returns the user visible description of this channel.

getGroup

Added in 1.5.0
fun getGroup(): String?

Returns what group this channel belongs to. This is used only for visually grouping channels in the UI.

getId

Added in 1.5.0
fun getId(): String

Returns the id of this channel.

getImportance

Added in 1.5.0
fun getImportance(): Int

Returns the user specified importance e.g. IMPORTANCE_LOW for notifications posted to this channel. Note: This value might be >IMPORTANCE_NONE, but notifications posted to this channel will not be shown to the user if the parent NotificationChannelGroup or app is blocked. See isBlocked and areNotificationsEnabled.

getLightColor

Added in 1.5.0
fun getLightColor(): Int

Returns the notification light color for notifications posted to this channel. Irrelevant unless shouldShowLights.

getLockscreenVisibility

Added in 1.5.0
fun getLockscreenVisibility(): Int

Returns whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.

This is a read-only property which is only valid on instances fetched from the NotificationManagerCompat.

getName

Added in 1.5.0
fun getName(): CharSequence?

Returns the user visible name of this channel.

getParentChannelId

Added in 1.5.0
fun getParentChannelId(): String?

Returns the id of the parent notification channel to this channel, if it's a conversation related channel. See setConversationId.

getSound

Added in 1.5.0
fun getSound(): Uri?

Returns the notification sound for this channel.

getVibrationPattern

Added in 1.5.0
fun getVibrationPattern(): LongArray<Long>?

Returns the vibration pattern for notifications posted to this channel. Will be ignored if vibration is not enabled (shouldVibrate.

isImportantConversation

Added in 1.5.0
fun isImportantConversation(): Boolean

Whether or not notifications in this conversation are considered important.

Important conversations may get special visual treatment, and might be able to bypass DND.

This is only valid for channels that represent conversations, that is, those with a valid conversation id.

This is a read-only property which is only valid on instances fetched from the NotificationManagerCompat.

shouldShowLights

Added in 1.5.0
fun shouldShowLights(): Boolean

Returns whether notifications posted to this channel trigger notification lights.

shouldVibrate

Added in 1.5.0
fun shouldVibrate(): Boolean

Returns whether notifications posted to this channel always vibrate.

toBuilder

Added in 1.5.0
fun toBuilder(): NotificationChannelCompat.Builder

Creates a Builder instance with all the writeable property values of this instance.