Invites

LAST EDIT Sep 16 2021

Inviting Users

Copied!

Stream Chat provides the ability to invite users to a channel via the channel method with the invites array. Upon invitation, the end-user will receive a notification that they were invited to the specified channel.

See the following for an example on how to invite a user by adding an invites array containing the user ID:

Accepting an Invite

Copied!

In order to accept an invite, you must use call the acceptInvite method. The acceptInvite method accepts an object with an optional message property. Please see below for an example of how to call acceptInvite:

The message can be used for system messages for display within the channel (e.g. "Nick joined this channel!").
Unread counts are not incremented for a channel for which a user is a member of but has a pending invite.

Rejecting an Invite

Copied!

To reject an invite, call the rejectInvite method. This method does not require a user ID as it pulls the user ID from the current session in store from the connectUser call.

Query for Accepted Invites

Copied!

Querying for accepted invites is done via the queryChannels method. This allows you to return a list of accepted invites with a single call. See below for an example:

Query for Rejected Invites

Copied!

Similar to querying for accepted invites, you can query for rejected invites with queryChannels. See below for an example:

Query for Pending Invites

Copied!

Similar to querying for accepted and rejected invites, you can query for pending invites with queryChannels. See below for an example: