Skip to main content

Moderation

Module which contains logic to handle moderation based features.

Flow for joining a room with the waiting-room enabled:

sequenceDiagram participant Joinee participant Server Participant Moderator Joinee->>Server: Control/Join Server->>Joinee: Moderation/InWaitingRoom Server->>Moderator: Moderation/JoinedWaitingRoom(Joinee) Moderator->>Server: Moderation/Accept(Joinee) Server->>Joinee: Moderation/Accepted Joinee->>Server: Control/EnterRoom Server->>Joinee: JoinSuccess

Joining the room​

JoinSuccess​

When joining a room, the join_success control event contains the module-specific fields described below.

Fields​

FieldTypeAlwaysDescription
raise_hands_enabledboolyesIf raise hands feature is enabled
waiting_room_enabledboolnoIf waiting room is enabled
waiting_room_participantsParticipant[]noA list of participants in the waiting room; see Participant
Example​

For a moderator, the message would look like:

{
    "waiting_room_enabled": true,
    "waiting_room_participants": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "control": {
                ...
            },
            ...
        },
        {
            "id": "00000000-0000-0000-0000-000000000001",
            "control": {
                ...
            },
            ...
        },
        ...
    ],
    "raise_hands_enabled": true
}

For a non-moderator participant, the message would look like:

{
    "raise_hands_enabled": true
}

Joined​

When joining a room, the joined control event sent to all other participants does not contain module-specific data.

Commands​

Kick​

Requires moderator role.

Remove a participant from the room.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "kick"
targetstringyesId of the participant to kick
Example​
{
    "action": "kick",
    "target": "00000000-0000-0000-0000-000000000000"
}

Ban​

Requires moderator role.

Ban a user from the room. Can only be used on participants where participation_kind is "user". The user's user-id will be banned from the room for the remainder of the session.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "ban"
targetstringyesId of the participant to ban
Example​
{
    "action": "ban",
    "target": "00000000-0000-0000-0000-000000000000"
}

Debrief​

Starts a debriefing.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "debrief"
kick_scopeenumyesEither "guests", "users_and_guests" or "all"
Example​
{
    "action": "debrief",
    "kick_scope": "guest"
}

EnableWaitingRoom​

Requires moderator role.

Enable the waiting room.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "enable_waiting_room"
Example​
{
    "action": "enable_waiting_room"
}

DisableWaitingRoom​

Requires moderator role.

Disable the waiting room.

NOTE: Participants inside the waiting room will not be automatically accepted.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "disable_waiting_room"
Example​
{
    "action": "disable_waiting_room"
}

EnableRaisedHands​

Requires moderator role.

Enable raising of hands by participants in the room.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "enable_raise_hands"
Example​
{
    "action": "enable_raise_hands"
}

DisableRaiseHands​

Requires moderator role.

Disable raising of hands by participants in the room.

NOTE: Raised hands by participants will be lowered when this command is triggered.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "disable_raise_hands"
Example​
{
    "action": "disable_raise_hands"
}

Accept​

Requires moderator role.

Accept a participant inside the waiting into the room.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "accept"
targetstringyesId of the participant to accept
Example​
{
    "action": "accept",
    "target": "00000000-0000-0000-0000-000000000000"
}

ResetRaisedHands​

Requires moderator role.

Reset all raised hands in the room.

Fields​

FieldTypeRequiredDescription
actionenumyesMust be "reset_raised_hands"
Example​
{
    "action": "reset_raised_hands",
}

Events​

Kicked​

Received by a participant if kicked from the room. Will be the last message before server-side websocket disconnection.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "kicked"
Example​
{
    "message": "kicked"
}

Banned​

Received by a participant if banned from the room. Will be the last message before server-side websocket disconnection.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "banned"
Example​
{
    "message": "banned"
}

SessionEnded​

Received by a participant if removed from the room (e.g. due to debriefing). Will be the last message before server-side websocket disconnection.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "session_ended"
issued_bystringyesId of the issuing moderator

DebriefingStarted​

Received when a debriefing has started that a participant is part of.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "debriefing_started"
issued_bystringyesId of the issuing moderator

In Waiting Room​

Received after sending Join in a room which has the waiting-room enabled. Once in the waiting room one must wait until the Accepted event was received. Then the room can be entered using Control/EnterRoom.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "in_waiting_room"
Example​
{
    "message": "in_waiting_room",
}

JoinedWaitingRoom​

Received when a participant joined the waiting-room. Wraps a Participant. Will only contain the data of the control as other modules will not be initialized before the user joins the room.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "joined_waiting_room"
Example​
{
    "message": "joined_waiting_room",
    "id": "00000000-0000-0000-0000-000000000000",
    "control": {
        ...
    }
}

LeftWaitingRoom​

Received when a participant left the waiting-room. Will also be received when a participant makes the transition from waiting-room to "conference-"room.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "left_waiting_room"
targetstringyesId of the participant
Example​
{
    "message": "joined_waiting_room",
    "id": "00000000-0000-0000-0000-000000000000"
}

WaitingRoomEnabled​

Received when a moderator enabled the waiting-room.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "waiting_room_enabled"
Example​
{
    "message": "waiting_room_enabled"
}

WaitingRoomDisabled​

Received when a moderator disabled the waiting-room.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "waiting_room_disabled"
Example​
{
    "message": "waiting_room_disabled"
}

RaiseHandsEnabled​

Received when a moderator enabled raising of hands.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "raise_hands_enabled"
issued_bystringyesId of the issuing moderator
Example​
{
    "message": "raise_hands_enabled",
    "issued_by": "00000000-0000-0000-0000-000000000000"
}

RaiseHandsDisabled​

Received when a moderator disabled raising of hands.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "raise_hands_disabled"
issued_bystringyesId of the issuing moderator
Example​
{
    "message": "raise_hands_disabled",
    "issued_by": "00000000-0000-0000-0000-000000000000"
}

Accepted​

Can only be received while in the waiting room. A moderator accepted this you into the room, which can now entered using Control/EnterRoom.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "accepted"
Example​
{
    "message": "accepted",

}

Error​

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "error"
errorenumyescurrently only cannot_ban_guest
Example​
{
    "message": "error",
    "error": "cannot_ban_guest"
}

RaisedHandResetByModerator​

Received when a moderator lowered the hand of the participant.

Fields​

FieldTypeAlwaysDescription
messageenumyesIs "raised_hand_reset_by_moderator"
issued_bystringyesId of the issuing moderator
Example​
{
    "message": "raised_hand_reset_by_moderator",
    "issued_by": "00000000-0000-0000-0000-000000000000"
}