Skip to main content

Private subchannel overview

Community channels support private subchannels — subchannels that are only accessible to designated members.

How private subchannels work

Community subchannels can be either public or private:

  • Public subchannels are visible to all community members. All members receive messages from public subchannels.
  • Private subchannels are only accessible to members on the subchannel's member list. Only listed members can send and receive messages and see the subchannel.

You can switch a subchannel between public and private at any time. The default NCDefault subchannel cannot be made private.

Impact of type changes

  • Public to private: Only members on the private subchannel's member list can fetch message history (including messages sent when the subchannel was public).
  • Private to public: All community members can fetch message history (including messages sent when the subchannel was private).

Manage private subchannels (server API)

The client SDK does not provide APIs for creating or managing private subchannels. Use the Server API:

ActionServer API
Create a subchannelCreate subchannel
Delete a subchannelDelete subchannel
List subchannelsList subchannels
Change subchannel typeChange type

Manage private subchannel members (server API)

ActionServer API
Add membersAdd members
Remove membersRemove members
List membersList members
info
  • When a subchannel is deleted, its member list is also deleted.
  • When a user leaves the community, they are automatically removed from all private subchannel member lists.
  • You can pre-create a member list for a public subchannel. The list takes effect immediately when the subchannel is changed to private.