NotificationChannelCompat
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 |
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 |
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 |
String? |
Returns the user visible description of this channel. |
String? |
getGroup()Returns what group this channel belongs to. |
String |
getId()Returns the id of this channel. |
Int |
Returns the user specified importance e.g. |
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? |
getName()Returns the user visible name of this channel. |
String? |
Returns the |
Uri? |
getSound()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 |
Constants
DEFAULT_CHANNEL_ID
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
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
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
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
fun getAudioAttributes(): AudioAttributes?
Returns the audio attributes for sound played by notifications posted to this channel.
getConversationId
fun getConversationId(): String?
Returns the id of the conversation backing this channel, if it's associated with a conversation. See setConversationId.
getDescription
fun getDescription(): String?
Returns the user visible description of this channel.
getGroup
fun getGroup(): String?
Returns what group this channel belongs to. This is used only for visually grouping channels in the UI.
getImportance
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
fun getLightColor(): Int
Returns the notification light color for notifications posted to this channel. Irrelevant unless shouldShowLights.
getLockscreenVisibility
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.
getParentChannelId
fun getParentChannelId(): String?
Returns the id of the parent notification channel to this channel, if it's a conversation related channel. See setConversationId.
getVibrationPattern
fun getVibrationPattern(): LongArray<Long>?
Returns the vibration pattern for notifications posted to this channel. Will be ignored if vibration is not enabled (shouldVibrate.
isImportantConversation
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
fun shouldShowLights(): Boolean
Returns whether notifications posted to this channel trigger notification lights.
shouldVibrate
fun shouldVibrate(): Boolean
Returns whether notifications posted to this channel always vibrate.
toBuilder
fun toBuilder(): NotificationChannelCompat.Builder
Creates a Builder instance with all the writeable property values of this instance.