@japofc/baileys - v2.4.7
    Preparing search index...

    Interface MiniAppOptions

    interface MiniAppOptions {
        allowPrivateThumbnail?: boolean;
        appUrl?: string;
        body?: string;
        buttons?: any[];
        buttonText?: string;
        dispatcher?: any;
        expiresIn?: number;
        fetchImpl?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        flow?: string
        | MiniAppFlowOptions;
        footer?: string;
        onThumbnailError?: (err: any) => void;
        openWebview?: boolean;
        params?: Record<string, string | number | boolean>;
        secret?: string;
        text?: string;
        thumbnail?: string | Buffer<ArrayBufferLike>;
        thumbnailHeaders?: any;
        thumbnailMaxBytes?: number;
        thumbnailTimeoutMs?: number;
        title?: string;
        url?: string;
        useWebview?: boolean;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any
    Index
    allowPrivateThumbnail? appUrl? body? buttons? buttonText? dispatcher? expiresIn? fetchImpl? flow? footer? onThumbnailError? openWebview? params? secret? text? thumbnail? thumbnailHeaders? thumbnailMaxBytes? thumbnailTimeoutMs? title? url? useWebview?
    allowPrivateThumbnail?: boolean

    Allow localhost/private-IP thumbnail URLs. Off by default to reduce SSRF risk.

    appUrl?: string

    Optionalbody

    body?: string
    buttons?: any[]
    buttonText?: string
    dispatcher?: any
    expiresIn?: number

    Opener-URL lifetime in seconds; signs an exp the web app can enforce.

    fetchImpl?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    flow?: string | MiniAppFlowOptions
    footer?: string
    onThumbnailError?: (err: any) => void
    openWebview?: boolean

    Emit a real native in-app webview button (open_webview) instead of cta_url. Default false (cta_url renders on regular accounts; open_webview needs the in-app-webview capability).

    params?: Record<string, string | number | boolean>
    secret?: string

    HMAC-SHA256 key; when set, the opener URL's params are signed (tamper-proof).

    Optionaltext

    text?: string
    thumbnail?: string | Buffer<ArrayBufferLike>
    thumbnailHeaders?: any
    thumbnailMaxBytes?: number

    Remote thumbnail byte cap (default 512 KiB).

    thumbnailTimeoutMs?: number

    Remote thumbnail fetch timeout (default 10s).

    title?: string
    url?: string
    useWebview?: boolean

    Toggle cta_url's (WA-ignored) webview_interaction flag. Default true. Kept for backward compatibility — for a REAL in-app webview use openWebview.

    Settings
    Member Visibility

    On This Page
    Properties