End Room

End the room with hmsSdk.endRoom.

endRoom takes three parameters.

reason: Optional message you want to pass along the end room notification to other peers

lock: Whether you want to prevent anyone from rejoining the room. If false, they will be allowed to enter the room again if the client called join. If this is false, they will not able to join this room again.

completion handler: Lets you know whether the end room operation executed. was ended successfully or not.

hmssdk.endRoom(lock: false, reason: "Meeting is over") { success, error in
if (success) {
    // pop to previous screen
}
}

How to handle an end room callback

Once the peer with adequate permissions calls endRoom, all other peers in the room will receive a callback in HMSUpdateListener.onRemovedFromRoom.

The on(removedFromRoom:) callback has a single parameter called HMSRemovedFromRoomNotification with the following structure.

class HMSRemovedFromRoomNotification {
    public let requestedBy: HMSPeer
    public let reason: String
    public let roomEnded: Bool
}

reason: The string message detailing why the room was ended.

requestedBy: The details of the peer who called endRoom.

roomEnded: True if the entire room was ended. False if only the receiving peer was removed.

Clients should read this callback and show the appropriate UI.

How to end the Room

Call endSession method on HMSRoomModel instance.

try await roomModel.endSession(withReason reason: /* an optional string describing the reason for ending the session for everyone*/, shouldAllowReJoin: /* an optional bool whether anyone should be allowed to join the room after it has been ended*/)

// End a class room locking it so that no-one can join/start the room again.
try await roomModel.endSession(withReason: "Class has been over.", shouldAllowReJoin: false)

How to know when the Room has been ended

You check the roomState property on HMSRoomModel instance and see if it's set to leftMeeting(reason: LeaveReason) enum.

struct MeetingView: View {
    
    @ObservedObject var roomModel = HMSRoomModel(roomCode: "qdr-mik-seb")
    
    var body: some View {
        
        switch roomModel.roomState {
        case .notJoined:
            // Button to join the room
            ...
        case .inMeeting:
            // Button to leave the room
            ...
        case .leftMeeting(reason: let leaveReason):
            if case .roomEnded(reasonString: _) = leaveReason {
                // show room ended view here
            }
        }
    }
}

where leave reasons can be following:

public enum LeaveReason {
    case roomEnded
    case youLeft
    case removedFromRoom
}