Membership object

Membership is an object that refers to a single user-channel relationship in a chat.

Properties

The Membership object has the following properties:

class Membership {
    channel: Channel,
    user: User,
    custom: ObjectCustom
}

Parameter	Description
channel Type: Channel	Channel object.
user Type: User	User object.
custom Type: ObjectCustom	Any custom properties or metadata associated with the channel-user membership, such as lastReadMessageTimetoken.

API limits

To learn about the maximum length of parameters used to set channel membership metadata, refer to REST API docs.

Methods

You can call the following methods on the Membership object.

Click on each method for more details.

• getUnreadMessagesCount()
• (getter) lastReadMessageTimetoken
• setLastReadMessage()
• setLastReadMessageTimetoken()
• streamUpdates()
• (static) streamUpdatesOn()
• update()

Use case

For example, you can use the Membership object methods to:

• Update information on the user-channel relationship and get updates on such changes.
• Decide what is the last message read by a user on a given channel.
• Get information on the total amount of messages unread by a user on a channel.