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

    Interface CreateStoredRoomOptions

    Options for creating a new stored room.

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

    Properties

    alias enabled? enableOffline? expiresIn? metadata? roomLink? roomName tabsConfig? usePassword? useWaitingRoom?

    Properties

    alias: string

    Display name / alias for the room

    enabled?: boolean

    Whether the room is enabled

    enableOffline?: boolean

    Whether offline access to room resources is enabled

    expiresIn?: number

    Expiration time in milliseconds (0 = never)

    metadata?: Record<string, unknown>

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

    roomLink?: string | null

    Join link URL, or null/omitted for static rooms

    roomName: string

    The actual room name

    tabsConfig?: StoredRoomTabsConfig

    Tab/feature configuration

    usePassword?: boolean

    Whether a password is required

    useWaitingRoom?: boolean

    Whether a waiting room is enabled

    Settings

    Member Visibility

    On This Page

    Properties