Membership object

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

Properties

The Membership object has the following properties:

Parameter	Description
Channel Type: Channel	Channel object.
User Type: User	User object.
Custom Type: FString	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.

• Delete()
• GetChannel()
• GetChannelID()
• GetLastReadMessageTimetoken()
• GetMembershipData()
• GetUnreadMessagesCount()
• GetUser()
• GetUserID()
• SetLastReadMessage()
• SetLastReadMessageTimetoken()
• Update()

Streaming

Call these methods to subscribe to or unsubscribe from real-time updates for this Membership object.

• StreamUpdates()
• StopStreamingUpdates()
• StreamUpdatesOn()

Use case

Membership methods enable:

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