Membership object
Membership is an object that refers to a single user-channel relation in a chat.
Properties
The Membership object has the following properties:
| Parameter | Type | Description |
|---|---|---|
Channel | Channel | Channel object. |
User | User | User object. |
Custom | 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.
GetUnreadMessagesCount()LastReadMessageTimetoken()SetLastReadMessage()SetLastReadMessageTimetoken()StreamUpdates()StreamUpdatesOn()Update()
Use case
For example, you can use the Membership object methods to:
- Update information on the user-channel relation 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.