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

    Interface AdvertiseRoomOptions

    Options for advertising a room for discovery.

    interface AdvertiseRoomOptions {
        metadata?: Record<string, unknown>;
        name: string;
        ownerDisplayName?: string;
        targetUserIds: string[];
    }
    Index

    Properties

    metadata? name ownerDisplayName? targetUserIds

    Properties

    metadata?: Record<string, unknown>

    Optional metadata (e.g., password required, waiting room enabled)

    name: string

    Room name to advertise

    ownerDisplayName?: string

    Display name of the owner

    targetUserIds: string[]

    User IDs that should see this room in discovery (required, non-empty)

    Settings

    Member Visibility

    On This Page

    Properties