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

    Interface StoredRoom

    A persistent room that can be reused for future meetings.

    interface StoredRoom {
        alias: string;
        apiKey?: string;
        createdAt?: string;
        enabled: boolean;
        enableOffline: boolean;
        expiresIn?: number;
        id?: string;
        metadata?: Record<string, unknown>;
        roomLink: string | null;
        roomName: string;
        tabsConfig?: StoredRoomTabsConfig;
        usePassword: boolean;
        userId?: string;
        useWaitingRoom: boolean;
    }
    Index

    Properties

    alias apiKey? createdAt? enabled enableOffline expiresIn? id? metadata? roomLink roomName tabsConfig? usePassword userId? useWaitingRoom

    Properties

    alias: string

    Display name / alias for the room

    apiKey?: string

    API key associated with the room

    createdAt?: string

    When the room was created

    enabled: boolean

    Whether the room is enabled (visible/accessible to members)

    enableOffline: boolean

    Whether offline access to room resources is enabled

    expiresIn?: number

    Expiration time in milliseconds (0 = never expires)

    id?: string

    Unique identifier

    metadata?: Record<string, unknown>

    Arbitrary metadata (e.g., targetUserIds, category, description)

    roomLink: string | null

    Join link URL, or null for static (name-based) rooms

    roomName: string

    The actual room name used for joining

    tabsConfig?: StoredRoomTabsConfig

    Tab/feature configuration

    usePassword: boolean

    Whether a password is required to join

    userId?: string

    The user who created the room

    useWaitingRoom: boolean

    Whether a waiting room is enabled

    Settings

    Member Visibility

    On This Page

    Properties