Interface UseJoinTokenState

State returned by the useJoinToken hook.

interface UseJoinTokenState {
    error: JoinTokenError | null;
    isJoining: boolean;
    isRoomActive: boolean;
    isValidated: boolean;
    isValidating: boolean;
    requiresPassword: boolean;
    roomName: string | null;
}

Properties

Error information if validation or join failed

isJoining: boolean

Whether room join is in progress

isRoomActive: boolean

Whether the room is currently active (host has joined)

isValidated: boolean

Whether token has been successfully validated

isValidating: boolean

Whether token validation is in progress

requiresPassword: boolean

Whether the token requires a password (from error or initial detection)

roomName: string | null

Room name from the token, null if not validated yet