The documentation is currently a work in progress whilst the product is in alpha.

NativeAndroidChannel

Android Only

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


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

Properties

badge

Sets whether badges are enabled for the channel.

badge?: undefined | false | true;

View the Badges documentation to learn more.

Defaults to true.

This setting cannot be overridden once the channel is created.

blocked

blocked: boolean;

bypassDnd

Android Only

Sets whether or not notifications posted to this channel can interrupt the user in 'Do Not Disturb' mode.

bypassDnd?: undefined | false | true;

Defaults to false.

This setting cannot be overridden once the channel is created.

description

Android Only

Sets the user visible description of this channel.

description?: undefined | string;

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

Sets what group this channel belongs to. Group information is only used for presentation, not for behavior.

groupId?: undefined | string;

Groups can be created via via createChannelGroup.

This setting cannot be overridden once the channel is created.

id

The unique channel ID.

id: string;

importance

Sets the level of interruption of this notification channel.

importance?: AndroidImportance;

Defaults to AndroidImportance.DEFAULT.

This setting can only be set to a lower importance level once set.

lightColor

If lights are enabled (via lights), sets/overrides the light color for notifications posted to this channel.

lightColor?: AndroidColor | string;

This setting cannot be overridden once the channel is created.

lights

Sets whether notifications posted to this channel should display notification lights, on devices that support that feature.

lights?: undefined | false | true;

Defaults to true.

This setting cannot be overridden once the channel is created.

name

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.

name: string;

This setting can be updated after creation.

sound

Overrides the sound the notification is displayed with.

sound?: undefined | string;

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.

vibration

Sets whether notification posted to this channel should vibrate.

vibration?: undefined | false | true;

Defaults to true.

This setting cannot be overridden once the channel is created.

vibrationPattern

Sets/overrides the vibration pattern for notifications posted to this channel.

vibrationPattern?: number[];

The pattern in milliseconds. Must be an even amount of numbers.

This setting cannot be overridden once the channel is created.

visibility

Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form.

visibility?: AndroidVisibility;

Defaults to AndroidVisibility.PRIVATE.

This setting cannot be overridden once the channel is created.


Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.