Invites
Invites allow you to add users to a channel with a pending state. The invited user receives a notification and can accept or reject the invite.
Unread counts are not incremented for channels with a pending invite.
Invite Users
await channel.inviteMembers({ members: ["nick"] });Accept an Invite
Call acceptInvite to accept a pending invite. You can optionally include a message parameter to post a system message when the user joins (e.g., "Nick joined this channel!").
// initialize the channel
const channel = client.channel("messaging", "awesome-chat");
// accept the invite
await channel.acceptInvite({
message: { text: "Nick joined this channel!" },
});Reject an Invite
Call rejectInvite to decline a pending invite. Client-side calls use the currently connected user. Server-side calls require a user_id parameter.
await channel.rejectInvite();Query Invites by Status
Use queryChannels with the invite filter to retrieve channels based on invite status. Valid values are pending, accepted, and rejected.
Query Accepted Invites
const invites = await client.queryChannelsAndHydrate({
filter_conditions: { invite: "accepted" },
});Query Rejected Invites
const rejected = await client.queryChannelsAndHydrate({
filter_conditions: { invite: "rejected" },
});Query Pending Invites
const pending = await client.queryChannelsAndHydrate({
filter_conditions: { invite: "pending" },
});