@notifee/react-native / AndroidChannel
Interface: AndroidChannel
An interface for describing an Android Channel.
Channels override any individual notification preferences (e.g. lights/vibration) and the user has final control over the setting. Once created, only channel metadata can be updated (e.g. name).
View the Channels & Groups documentation to learn more.
badge?
optionalbadge:boolean
Sets whether badges are enabled for the channel.
View the Badges documentation to learn more.
Defaults to true.
This setting cannot be overridden once the channel is created.
bypassDnd?
optionalbypassDnd:boolean
Sets whether or not notifications posted to this channel can interrupt the user in 'Do Not Disturb' mode.
Defaults to false.
This setting cannot be overridden once the channel is created.
description?
optionaldescription:string
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.
This setting can be updated after creation.
groupId?
optionalgroupId:string
Sets what group this channel belongs to. Group information is only used for presentation, not for behavior.
Groups can be created via via createChannelGroup.
This setting cannot be overridden once the channel is created.
importance?
optionalimportance:AndroidImportance
Sets the level of interruption of this notification channel.
Defaults to AndroidImportance.DEFAULT.
This setting can only be set to a lower importance level once set.
lightColor?
optionallightColor:string
If lights are enabled (via lights), sets/overrides the light color for notifications
posted to this channel.
This setting cannot be overridden once the channel is created.
lights?
optionallights:boolean
Sets whether notifications posted to this channel should display notification lights, on devices that support that feature.
Defaults to true.
This setting cannot be overridden once the channel is created.
name
name:
string
The channel name. This is shown to the user so must be descriptive and relate to the notifications which will be delivered under this channel.
This setting can be updated after creation.
sound?
optionalsound:string
Overrides the sound the notification is displayed with.
The default value is to play no sound. To play the default system sound use 'default'.
This setting cannot be overridden once the channel is created.
soundURI?
optionalsoundURI:string
The URI of the notification sound associated with the channel, if any.
This is a read-only value, and is under user control after the channel is created
vibration?
optionalvibration:boolean
Sets whether notification posted to this channel should vibrate.
Defaults to true.
This setting cannot be overridden once the channel is created.
vibrationPattern?
optionalvibrationPattern:number[]
Sets/overrides the vibration pattern for notifications posted to this channel.
The pattern in milliseconds. Must be an even amount of numbers.
This setting cannot be overridden once the channel is created.
visibility?
optionalvisibility:AndroidVisibility
Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form.
Defaults to AndroidVisibility.PRIVATE.
This setting cannot be overridden once the channel is created.