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

getChannelGroup

Android Only

API used to return a channel group on supported Android devices.



getChannelGroup(channelGroupId: string): Promise<NativeAndroidChannelGroup | null>;

This API is used to return an NativeAndroidChannelGroup. Returns null if no channel could be matched to the given ID.

A "native channel group" also includes additional properties about the channel group at the time it's retrieved from the device. View the NativeAndroidChannelGroup documentation for more information.

View the Channels & Groups documentation for more information.


PropertyDescriptionOptional
channelGroupId

The channel ID created with createChannelGroup. If a unknown channel group ID is provided, null is returned.


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.