Quick Reference - Leave a group:
Leave a Group
In order to stop receiving updates and messages for any particular joined group, you will have to leave the group using theleaveGroup() method.
- JavaScript
- TypeScript
| Parameter | Description |
|---|---|
GUID | The UID of the group you would like to leave |
Real-time Group Member Left Events
In other words, as a member of a group, how do I know if someone has left it? If a user leaves any group, The members of the group receive a real-time event in theonGroupMemberLeft() method of the GroupListener class.
- JavaScript
- TypeScript
Missed Group Member Left Events
In other words, as a member of a group, how do I know if someone has left it when my app is not running? When you retrieve the list of previous messages if a member has left any group that the logged-in user is a member of, the list of messages will contain anAction message. An Action message is a sub-class of BaseMessage class.
For the group member left event, in the Action object received, the following fields can help you get the relevant information-
action-leftactionBy- User object containing the details of the user who left the groupactionFor- Group object containing the details of the group the user has left
Best Practices
Clean up local state after leaving
Clean up local state after leaving
After successfully leaving a group, remove any local references to the group’s messages, members, or conversation data. This prevents stale data from appearing in your UI.
Group owners should transfer ownership before leaving
Group owners should transfer ownership before leaving
If the logged-in user is the group owner, consider transferring ownership to another admin or member before leaving. Leaving as the owner may have different behavior depending on your app’s configuration.
Troubleshooting
leaveGroup fails with error
leaveGroup fails with error
Verify the GUID is correct and the logged-in user is actually a member of the group. You can check membership using
getGroup() and the hasJoined property.Still receiving messages after leaving
Still receiving messages after leaving
Ensure the
leaveGroup() call completed successfully (resolved the promise). Also remove any active group listeners for that group to stop receiving real-time events.