Channel members

// members can be added by passing an array of user IDs
const channel = client.channel('messaging', randomID, {
	members: ['userid1', 'userid2', 'userid3']
})

// or by passing objects
const channel = client.channel('messaging', randomID, {
	members: [
		{user_id: 'userid1'},
		{user_id: 'userid2'},
		{user_id: 'userid3'},
	]
})

await channel.addMembers(['userid1', 'userid2']);

// you can set channel_role in the meantime
await channel.addMembers([
	{user_id: 'userid1', channel_role: 'channel_moderator'}
]);

await channel.addMembers(['userid1'], { text: 'Tommaso joined the channel.' }); 

// using server-side client, you need to specify the sender user_id
await channel.addMembers(['userid1'], { text: 'Tommaso joined the channel.', user_id: 'userid2' })

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

// add custom data while creating the channel
const channel = client.channel('messaging', randomID, {
	members: [
		{user_id: 'userid1', key1: 'value1'},
		{user_id: 'userid2', key1: 'value1'},
		{user_id: 'userid3', key2: 'value2'},
	]
})

// add custom data with `addMembers` method
await channel.addMembers([
	{user_id: 'userid1', key1: 'value1'}
]);

await channel.removeMembers(['userid1', 'userid2']);

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

await channel.addModerators(['userid1', 'userid2']);

await channel.demoteModerators(['userid1']);

// set some fields
await channel.partialUpdateMember(user_id, {
	set: {
		key1: 'new value 1',
		key2: 'new value 2',
		channel_role: 'channel_moderator', 
	}
})

// unset some fields
await channel.partialUpdateMember(user_id, {
	unset: ['key1', 'key2']
})

// set / unset in the same call
await channel.partialUpdateMember(user_id, {
	set: {
		key1: 'new value 1',
		key2: 'new value 2',
	},
	unset: ['key3']
})

await channel.queryMembers({}, sort, {});

// returns up to 100 members ordered by created_at descending
let sort = {created_at: -1};
await channel.queryMembers({}, sort, {});

// returns up to 100 members ordered by user_id descending
sort = {user_id: -1};
await channel.queryMembers({}, sort, {});

// paginate by user_id in descending order
sort = {user_id: 1};
let options = {user_id_lt: lastMember.user_id};
await channel.queryMembers({}, sort, options);

// paginate by created at in ascending order
sort = {created_at: -1};
options = {created_at_before: lastMember.created_at};
await channel.queryMembers({}, sort, options);

// paginate using offset
options = {offset: 20}
await channel.queryMembers({}, sort, {});

// query members by user.name
channel.queryMembers({'name':'tommaso'})

// autocomplete members by user name
channel.queryMembers({name:{"$autocomplete":'tomm'}})

// query member by id
channel.queryMembers({user_id:'tommaso'})

// query multiple members by id
channel.queryMembers({user_id:{'$in:'['tommaso','thierry']}})

// query channel moderators
channel.queryMembers({is_moderator:true})

// query for banned members in channel
channel.queryMembers({banned:true})

// query members with pending invites
channel.queryMembers({invite:'pending'})

// query members who joined the channel directly or accepted an invite
channel.queryMembers({joined: true})

// query members who have rejected invite or have pending invite
channel.queryMembers({joined: false}

// query all the members 
channel.queryMembers({})

// order results by member created at descending
channel.queryMembers({}, {created_at:-1})

// query by user.email
client.queryMembers({ 'user.email':'awesome@getstream.io' })

// you can also query members by custom data
// subscription is a custom field
client.queryMembers({ 'subscription':'gold_plan' })