Private subchannel overview
Community channels support creating private subchannels, enabling scenarios where only designated users can communicate within a subchannel.
Known limitations
Current limitations:
If a user is not on the private subchannel member list but still attempts to send a message to the subchannel, the message fails to reach the server but is saved to the local database (except on Web), and may create a channel entry.
Recommended workaround: Maintain a copy of the private subchannel member list on your app server. If a user is not on the list, prevent them from sending messages to the private subchannel.
Understanding private subchannels
Community channel subchannels are classified as public or private. Public subchannels are open to all community channel members (no explicit join required) — all members receive messages in public subchannels. Private subchannels are accessible only to users on the subchannel's member list — only those members can send and receive messages and receive notifications about subchannel state changes. A private subchannel can be switched to public at any time, and vice versa.
For example, an administrator creates a new subchannel as private, then invites specific community members. Only invited members can browse, send, and receive messages in that subchannel.
Changing the subchannel type affects access to server-side message history:
- Public to private: Only users on the current private subchannel member list can retrieve message history (including messages from when the subchannel was public).
- Private to public: All community channel members can retrieve message history (including messages from when the subchannel was private).
Manage subchannels using these APIs:
| Action | Client API | Server API |
|---|---|---|
| Create a private subchannel | Not available | Create a subchannel |
| Delete a private subchannel | Not available | Delete a subchannel |
| List subchannels | Not available | List subchannels |
| Change subchannel type | Not available | Change subchannel type |
Understanding the private subchannel member list
When a subchannel is private, only users on the member list can send and receive messages and receive state notifications within the subchannel.
When a private subchannel is switched to public, the member list data is retained but no longer enforced. If the subchannel is switched back to private, the existing member list is re-activated.
You can also create a member list for a public subchannel. Once the subchannel type is changed to private, the list takes effect immediately.
- Deleting a subchannel clears its private subchannel member list.
- When a member leaves the community channel, they are automatically removed from all private subchannel member lists.
Manage the private subchannel member list using these APIs:
| Action | Client API | Server API |
|---|---|---|
| Add to private subchannel member list | Not available | Add private subchannel members |
| Remove from private subchannel member list | Not available | Remove private subchannel members |
| Query private subchannel member list | Not available | Query private subchannel members |