Mute User In a Room
- Print
- DarkLight
- PDF
Mute User In a Room
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Mute a user in a room.
Method | Requires Auth | Permission |
|---|---|---|
| Yes |
|
Payload parameters
Argument | Example | Required | Description |
|---|---|---|---|
|
| Required | An object containing the room ID and username of the user to be muted. |
Example call
{
"msg": "method",
"method": "muteUserInRoom",
"id": "2",
"params": [
{
"rid": "siyr2oWQJBjQjhLwr",
"username": "test.fun"
}
]
}Example response
Success
{
"msg": "result",
"id": "2",
"result": true
}Errors
User not in the room: This occurs when the
usernamedoesn't belong to any user in the room.No Permission: This occurs when the authenticated user does not have the
mute-userpermission.
{
"msg": "result",
"id": "2",
"error": {
"isClientSafe": true,
"error": "error-user-not-in-room",
"reason": "User is not in this room",
"details": {
"method": "muteUserInRoom"
},
"message": "User is not in this room [error-user-not-in-room]",
"errorType": "Meteor.Error"
}
}{
"msg": "result",
"id": "2",
"error": {
"isClientSafe": true,
"error": "error-not-allowed",
"reason": "Not allowed",
"details": {
"method": "muteUserInRoom"
},
"message": "Not allowed [error-not-allowed]",
"errorType": "Meteor.Error"
}
}
Was this article helpful?