[**react-native-notify-kit**](react-native/reference/index) --- [react-native-notify-kit](react-native/reference/index) / AndroidChannel # Interface: AndroidChannel Defined in: [packages/react-native/src/types/NotificationAndroid.ts:892](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L892) 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](/react-native/android/channels) documentation to learn more. ## Platform android ## Extended by - [`NativeAndroidChannel`](react-native/reference/Interface.NativeAndroidChannel) ## Properties ### badge? > `optional` **badge?**: `boolean` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:915](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L915) Sets whether badges are enabled for the channel. View the [Badges](/react-native/android/appearance#badges) documentation to learn more. Defaults to `true`. This setting cannot be overridden once the channel is created. --- ### bypassDnd? > `optional` **bypassDnd?**: `boolean` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:927](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L927) 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. #### Platform android API Level >= 29 --- ### description? > `optional` **description?**: `string` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:938](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L938) 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. #### Platform android API Level >= 28 --- ### groupId? > `optional` **groupId?**: `string` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:965](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L965) Sets what group this channel belongs to. Group information is only used for presentation, not for behavior. Groups can be created via via [`createChannelGroup`](/react-native/reference/createchannelgroup). This setting cannot be overridden once the channel is created. --- ### id > **id**: `string` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:896](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L896) The unique channel ID. --- ### importance? > `optional` **importance?**: [`AndroidImportance`](react-native/reference/Enumeration.AndroidImportance) Defined in: [packages/react-native/src/types/NotificationAndroid.ts:974](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L974) 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? > `optional` **lightColor?**: `string` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:982](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L982) 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? > `optional` **lights?**: `boolean` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:947](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L947) 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` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:904](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L904) 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? > `optional` **sound?**: `string` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:1010](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1010) 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? > `optional` **soundURI?**: `string` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:1017](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1017) 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? > `optional` **vibration?**: `boolean` Defined in: [packages/react-native/src/types/NotificationAndroid.ts:956](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L956) Sets whether notification posted to this channel should vibrate. Defaults to `true`. This setting cannot be overridden once the channel is created. --- ### vibrationPattern? > `optional` **vibrationPattern?**: `number`\[] Defined in: [packages/react-native/src/types/NotificationAndroid.ts:1001](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1001) 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? > `optional` **visibility?**: [`AndroidVisibility`](react-native/reference/Enumeration.AndroidVisibility) Defined in: [packages/react-native/src/types/NotificationAndroid.ts:992](https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L992) 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.