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

    Interface RoomInfoFromToken

    Result from getting room info from a join token.

    interface RoomInfoFromToken {
        alias: string | null;
        isActive: boolean;
        offlineEnabled: boolean;
        offlineTabs: Record<string, unknown> | null;
        roomName: string;
    }
    Index

    Properties

    alias isActive offlineEnabled offlineTabs roomName

    Properties

    alias: 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 (normalized + uniquified).

    isActive: boolean

    Whether the room is currently active (owner has joined)

    offlineEnabled: boolean

    Whether the room owner allows token holders to enter the room in offline (no-video) mode when it isn't active. Only true when the owner explicitly enabled offline access for invite-link users.

    offlineTabs: Record<string, unknown> | null

    The owner's offline tab configuration (feature-key → enabled map, plus an optional tabOrder), when offline access is enabled and the owner configured one. null when absent — consumers fall back to their own defaults.

    roomName: string

    The room name

    Settings

    Member Visibility

    On This Page

    Properties