Add Room Leader
    • Dark
      Light
    • PDF

    Add Room Leader

    • Dark
      Light
    • PDF

    Article summary

    Set a user as room leader.

    Method

    Requires Auth

    Permission

    addRoomLeader

    Yes

    set-leader

    Payload parameters

    Argument

    Example

    Required

    Description

    roomId

    64a1f373376181965ab77f54

    Required

    The room ID.

    userId

    5fRTXMt7DMJbpPJfh

    Required

    The user ID to be set as room leader.

    Example call

    {
        "msg": "method",
        "method": "addRoomLeader",
        "id": "2",
        "params": [
            "WDuJLFkjwk6L7LdFC",
            "5fRTXMt7DMJbpPJfh"
        ]
    }

    Example response

    Success

    {
        "msg": "result",
        "id": "2",
        "result": true
    }

    Errors

    • User not in the room: This occurs when the userId doesn't belong to any user in the room.

    • Invalid User: This occurs when the userId doesn't belong to any user in the workspace.

    • User is already a Leader: This occurs when user is already a leader in that room.

    • No Permission: This occurs when the authenticated user does not have the set-leader permission.

    {
        "msg": "result",
        "id": "2",
        "error": {
            "isClientSafe": true,
            "error": "error-user-not-in-room",
            "reason": "User is not in this room",
            "details": {
                "method": "addRoomLeader"
            },
            "message": "User is not in this room [error-user-not-in-room]",
            "errorType": "Meteor.Error"
        }
    }
    {
        "msg": "result",
        "id": "2",
        "error": {
            "isClientSafe": true,
            "error": "error-invalid-user",
            "reason": "Invalid user",
            "details": {
                "method": "addRoomLeader"
            },
            "message": "Invalid user [error-invalid-user]",
            "errorType": "Meteor.Error"
        }
    }
    {
        "msg": "result",
        "id": "2",
        "error": {
            "isClientSafe": true,
            "error": "error-user-already-leader",
            "reason": "User is already a leader",
            "details": {
                "method": "addRoomLeader"
            },
            "message": "User is already a leader [error-user-already-leader]",
            "errorType": "Meteor.Error"
        }
    }
    
    {
        "msg": "result",
        "id": "2",
        "error": {
            "isClientSafe": true,
            "error": "error-not-allowed",
            "reason": "Not allowed",
            "details": {
                "method": "addRoomLeader"
            },
            "message": "Not allowed [error-not-allowed]",
            "errorType": "Meteor.Error"
        }
    }


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence