Manage Channel Members

1. Invite Users

You can invite members to the channel even if you are not the owner.

Any member can add another member to channel.

const resp = await client.addChannelMembers({
    channelId: 'my_channel',
    members: ['new_user1', 'new_user_2'],
});

2. Remove Members

Only the channel owner can remove members.

const resp = await client.removeChannelMembers({
    channelId: 'my_channel',
    members: ['new_user1', 'new_user_2'],
});

3. Get Channel Member List

For super channel, this is the only way to get channel members.

const numOfRows = 5;

const resp = await client.getChannelMembers({
    channelId: 'my_channel',
});

if (resp.hasNext) {
    const lastUserId = resp.users[resp.users.length - 1].id;
    const moreResp = await client.getChannelMembers({lastUserId, limit: numOfRows});
}

4. Ban Users

• Only the channel owner can ban users.

• Banned users are immediately removed from the channel and cannot join the channel until unbanned by the channel owner.

await client.banChannelMembers({
    channelId: 'my_channel',
    members: ['bad_user_1', 'bad_user_2'],
});

5. Unban Users

Only the channel owner can unban users.

await client.unbanChannelMembers({
    channelId: 'my_channel',
    members: ['good_user_1', 'good_user_2'],
});

6. Get Banned User List

Only the channel owner can view this list.

const numOfRows = 5;

const resp = await client.getBannedChannelUsers({
    channelId: 'my_channel',
});

if (resp.hasNext) {
    const lastUserId = resp.users[resp.users.length - 1].id;
    const moreResp = await client.getBannedChannelUsers({lastUserId, limit: numOfRows});
}

7. Mute Members

Mute feature allows the channel owner to mute specific members in the channel. Muted members are not allowed to send messages.

• Only the channel owner can mute other members.

• expireInMinutes specifies when mute status is expired. Default value for expireInMinutes is 0 (no expiry).

await client.muteChannelMembers({
    channelId: 'some_public_channel',
    members: ['talkative_user1'],
});

8. Unmute Members

Only the channel owner can unmute other members.

await client.unmuteChannelMembers({
    channelId: 'some_public_channel',
    members: ['talkative_user1'],
});

9. Get Muted User List

Only the channel owner can view this list.

const numOfRows = 5;

const resp = await client.getMutedChannelMembers({
    channelId: 'my_channel',
});

if (resp.hasNext) {
    const lastUserId = resp.users[resp.users.length - 1].id;
    const moreResp = await client.getMutedChannelMembers({lastUserId, limit: numOfRows});
}

10. Peer Mute

You can 'peer mute' another member in the channel.

• Any user can 'peer mute' another member in the channel.

• If you 'peer mute' another member, you will stop seeing messages from that particular member in the channel but other users will continue to see messages from that member in the channel.

• There is no push notification or event handler for this event.

• expireInMinutes allows you to control when 'peer mute' status expires. Default value for expireInMinutes is 0 (no expiry).

const resp = await client.mutePeers({
    channelId: 'my_channel',
    members: ['other_user'],
    expireInMinutes: 5, // 5분 후 mute 해제
});

11. Get Peer Muted List

const numOfRows = 5;

const resp = await client.getMutedPeers({
    channelId: 'my_channel',
    limit: numOfRows,
});

if (resp.hasNext) {
    const lastUserId = resp.users[resp.members.length - 1].id;
    const moreResp = await client.getMutedPeers({lastUserId, limit: numOfRows});
}

12. Peer Mute

You can 'unmute peer' another member in the channel.

• There is no push notification or event handler for this event.

// unmute peers
const resp = await client.unmutePeers({
    channelId: 'my_channel',
    members: ['other_user'],
});