Remove Peer

Remove them by calling hmsSdk.removePeer.

The parameters are:

peer: The HMSRemotePeer that you'd like to be removed from the room.

reason: Optional message you want to pass along the peer being removed

completion handler: Let you know whether the remove operation executed successfully or not.

hmssdk.removePeer(targetPeer, reason: "You are violating the community rules.") { success, error in
}

Handling the remove peer callback

The target peer of the removePeer will receive a callback in HMSUpdateListener of onRemovedFromRoom(notification : HMSRemovedFromRoom).

The HMSRemovedFromRoom object which is passed into the callback has the structure:

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

reason: The string message detailing why the peer is being removed.

requestedBy: The details of the peer who called removePeer.

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.

You call remove(peer, withReason:) method on HMSRoomModel instance to remove a remote participant.

try await roomModel.remove(peer: /* peer model instance*/, withReason reason: /* an optional string describing the reason for ending the session for everyone*/)

guard let studentPeerModel = (roomModel.peerModels.first{$0.name == "Pawan"}) else { return }
try await roomModel.remove(peer: studentPeerModel, withReason: "Expelled from class.")

How to check whether you were removed from the room

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

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:
            VStack {
                // Button to leave the room
                ...
            }
        case .leftMeeting(reason: let leaveReason):
            if case .removedFromRoom(reasonString: _) = leaveReason {
                // show a view to let user know that they were kicked out of the room
            }
        }
    }
}

where leave reasons can be following:

public enum LeaveReason {
    case roomEnded
    case youLeft
    case removedFromRoom
}