Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseJoinTokenState

    State returned by the useJoinToken hook.

    interface UseJoinTokenState {
        error: JoinTokenError | null;
        isJoining: boolean;
        isRoomActive: boolean;
        isValidated: boolean;
        isValidating: boolean;
        offlineEnabled: boolean;
        offlineTabs: Record<string, unknown> | null;
        requiresPassword: boolean;
        roomAlias: string | null;
        roomName: string | null;
    }
    Index

    Properties

    error isJoining isRoomActive isValidated isValidating offlineEnabled offlineTabs requiresPassword roomAlias roomName

    Properties

    error: JoinTokenError | null

    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

    offlineEnabled: boolean

    Whether the room owner allows token holders to enter in offline (no-video) mode while the room isn't active. False until validated.

    offlineTabs: Record<string, unknown> | null

    The owner's offline tab configuration from validation (feature-key → enabled map, plus optional tabOrder). Null when offline access is disabled or the owner didn't configure one.

    requiresPassword: boolean

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

    roomAlias: string | null

    The room's human-readable display name (owner-assigned), when one exists. Prefer this over roomName for UI — room names are often machine-generated. Null until validated or when the room has no alias.

    roomName: string | null

    Room name from the token, null if not validated yet

    Settings

    Member Visibility

    On This Page

    Properties