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

deleteChannelGroup

Android Only

API used to delete a channel group by ID on supported Android devices.



deleteChannelGroup(channelGroupId: string): Promise<void>;

Channel groups can be deleted using this API by providing the channel ID. Channel information (including the ID) can be retrieved from the getChannels API.

Deleting a group does not delete channels which are assigned to the group, they will instead be unassigned the group and continue to function as expected.

View the Channels & Groups documentation for more information.


PropertyDescriptionOptional
channelGroupId

The unique channel group ID to delete.


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.