Membership object

Membership represents a single user-channel relationship in a chat.

Properties

Membership has the following properties:

1class Membership {
2    channel: Channel,
3    user: User,
4    custom: ObjectCustom,
5    status?: string,
6    type?: string
7}

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.
status Type: string	Current status of the membership, like active or inactive.
type Type: string	Type of the membership, used to categorize the user-channel relationship.

API limits

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

Methods

Available methods:

Regular methods

• delete()
• getUnreadMessagesCount()
• (getter) lastReadMessageTimetoken
• setLastReadMessage()
• setLastReadMessageTimetoken()
• update()

Event listeners

• onDeleted()
• onUpdated()
• streamUpdates() (deprecated)
• (static) streamUpdatesOn()

Use case

Membership methods enable:

• Updating user-channel relationships and getting updates on changes
• Tracking the last message read by a user on a channel
• Getting the count of unread messages for a user