The Enx.dropUser() method allows the Moderator to disconnect / force-drop one or more participant(s) from the Session.
Class: Enx
Method: Enx.dropUser(clientIds)
Parameter:
clientIds– Required. List of Client IDs to be disconnected.
Callbacks:
ackDropUser-Acknowledgment to the Moderator when the user is disconnected.roomDisconnected-Notification to the affected user with the reason to be disconnected from the Room.
Enx.dropUser(clientIds)
ackDropUser:event=>{
// Moderator is acknowledged that user has been dropped
}
roomDisconnected:event=>{
// Notification to the affected user with the reason to be disconnected from the Room
}
Error Codes & Exceptions
| Code | Description |
|---|---|
| 5116 | Unauthorized Access. When a user with participant role invokes dropUser() |
