Updating Channel Members

Adding & Removing Channel Members

Using the addMembers() method adds the given users as members, while removeMembers() removes them.

await channel.addMembers(['thierry', 'josh']);
await channel.removeMembers(['tommaso']);

// Add user to the channel with role set
await channel.addMembers([{user_id:"james_bond", channel_role:"channel_moderator"}]);

// Add new channel member with custom data
await channel.addMembers([{user_id:"james_bond", code_name:"007"}]);

Note: You can only add/remove up to 100 members at once.

Members can also be added while creating the channel.

const channel = client.channel('messaging', randomID, {
  members: [
    { user_id: "james_bond", code_name: "007" },
    { user_id: "alec_trevelyan", code_name: "006" },
    { user_id: "bill_fairbanks", code_name: "002" },
});
await channel.create();

Stream Chat has a soft cap of 3000 channel memberships per user. If your use case requires >3000 channel memberships per user, consider removing users from channels or using elevated permissions to allow a user to access channels without membership if your use case allows

Message parameter

You can optionally include a message object that client-side SDKs will use to populate a system message. This works for both add and remove members

// using client-side client
await channel.addMembers(['tommaso'], { text: 'Tommaso joined the channel.' }); 
// using server-side client
await channel.addMembers(['tommaso'], { text: 'Tommaso joined the channel.', user_id: 'tommaso' });

Hide history

When members join a channel you can specify if they have access to the history or not. The history will be shown by default, set true to hide_history parameter to hide it for new members.

await channel.addMembers(['thierry'], undefined, { hide_history: true });

Leaving a channel

It is possible for user to leave the channel without moderator-level permissions. Make sure channel members have Leave Own Channel permission.

// remove own channel membership
await channel.removeMembers(['my_user_id']);

You can familiarize yourself with all permissions in Permissions section

Adding & Removing Moderators to a Channel

Using the addModerators() method adds the given users as moderators (or updates their role to moderator if already members), while demoteModerators() removes the moderator status.

await channel.addModerators(['thierry', 'josh']);
await channel.demoteModerators(['tommaso']);

These operations can only be performed server-side and up to 100 moderators can be added or removed at once.

© Getstream.io, Inc. All Rights Reserved.