@notifee/react-native

@notifee/react-native / NativeAndroidChannelGroup

Interface: NativeAndroidChannelGroup

An interface which describes a channel group which has been fetched from the device.

Contains additional information which is only available when fetching the channel group from the device.

Platform

android API Level >= 26

Properties

blocked

blocked: boolean

Returns whether or not notifications posted to a Channel belonging to this group are blocked by the user.

On API levels < 28, returns false.

View the Listening to channel events documentation to learn more about subscribing to when a channel is blocked by the user.

Platform

android API Level >= 28

channels

channels: NativeAndroidChannel[]

Returns a list of channels assigned to this channel group.

description?

optional description: string

An optional description of the group. This is visible to the user.

On Android APIs less than 28 this will always be undefined.

Platform

android API Level >= 28

id

id: string

Unique id for this channel group.

Inherited from

AndroidChannelGroup.id

name

name: string

The name of the group. This is visible to the user so should be a descriptive name which categorizes other channels (e.g. reminders).

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

Inherited from

AndroidChannelGroup.name