Interface UseRoomFlowReturn

Return type for useRoomFlow.

interface UseRoomFlowReturn {
    isConnecting: boolean;
    isInRoom: boolean;
    isWaitingForAdmission: boolean;
    isWaitingForHost: boolean;
    screen: RoomFlowScreen;
    wasRejected: boolean;
}

Index

Properties

isConnecting isInRoom isWaitingForAdmission isWaitingForHost screen wasRejected

Properties

isConnecting

isConnecting: boolean

true while createRoom or joinRoom is in progress

isInRoom

isInRoom: boolean

true when the user is inside an active room

isWaitingForAdmission

isWaitingForAdmission: boolean

true when the guest is in the waiting room

isWaitingForHost

isWaitingForHost: boolean

true when the guest is waiting for the host to start

screen

screen: RoomFlowScreen

The current screen to render

wasRejected

wasRejected: boolean

true when the guest was rejected from the waiting room