IGPAPI
    Preparing search index...

    Type Alias IosIgpapiOptions

    IosIgpapiOptions: ({ seed: string } | { snapshot: MobileSnapshot }) & {
        dangerAcceptInvalidCerts?: boolean;
        http3AttemptTimeoutMs?: number;
        network?: MobileNetwork;
        protocolMode?: TransportProtocolMode;
        proxy?: string;
        requestTimeoutMs?: number;
    }

    Options for creating an iOS-flavored IGPAPI runtime.

    Use seed for a fresh deterministic virtual device, or snapshot to restore a previously exported session without logging in again.

    Type Declaration

    • OptionaldangerAcceptInvalidCerts?: boolean

      Allow invalid TLS certificates in the native transport.

      This is useful for local traffic capture setups, but should stay disabled for normal production traffic.

    • Optionalhttp3AttemptTimeoutMs?: number

      How long the transport tries HTTP/3 before falling back in auto mode.

    • Optionalnetwork?: MobileNetwork

      The network the device is on (default: cellular LTE for a new device; a restored snapshot keeps the network it was saved with). Pass { kind: 'wifi' } to present the device on Wi-Fi; when set it also replaces a restored snapshot's network.

    • OptionalprotocolMode?: TransportProtocolMode

      Protocol mode of the native transport (default auto: try HTTP/3 like the iOS app, fall back to HTTP/2 when it does not get through). http2 / http3 force one channel; the transport enforces them.

    • Optionalproxy?: string

      HTTP(S) proxy URL passed to the native transport.

    • OptionalrequestTimeoutMs?: number

      Timeout of every API request in milliseconds (default 60 000). A timed-out request is abandoned, not cancelled: an action may still be carried out by the server, so a retry can duplicate it.

    Settings

    Member Visibility