Marmot-TS
    Preparing search index...

    Interface WelcomePreview

    Everything that can be surfaced about an invite before committing to join — see MarmotClient.previewWelcome. The rumor-level fields decode without key material; group requires decrypting the Welcome with a held KeyPackage and is null when none matches or the decode fails.

    interface WelcomePreview {
        cipherSuite?: number;
        epoch?: bigint;
        group: WelcomePreviewGroup | null;
        keyPackageEventId?: string;
        recipientCount?: number;
        relays: string[];
    }
    Index

    Client - Marmot Client

    cipherSuite? epoch? group keyPackageEventId? recipientCount? relays

    Client - Marmot Client

    cipherSuite?: number

    MLS cipher suite id from the Welcome struct.

    epoch?: bigint

    Group epoch from the previewed GroupInfo.

    group: WelcomePreviewGroup | null

    Decrypted group metadata, or null when unavailable.

    keyPackageEventId?: string

    Kind-30443 KeyPackage event id this Welcome consumed, if tagged.

    recipientCount?: number

    Number of recipients the Welcome targets.

    relays: string[]

    Group relay URLs from the Welcome's relays tag.

    Settings

    Member Visibility

    On This Page

    Client - Marmot Client