IGPAPI
    Preparing search index...

    Interface IgpapiClientOptions

    interface IgpapiClientOptions {
        dangerAcceptInvalidCerts?: boolean;
        http3AttemptTimeoutMs?: number;
        network?: MobileNetwork;
        protocolMode?: TransportProtocolMode;
        proxy?: string;
        requestTimeoutMs?: number;
        seed?: string;
        snapshot?: {
            application: MobileApplicationState;
            cookies: unknown;
            device: MobileDeviceState;
            session: MobileSessionState;
        };
    }
    Index

    Properties

    dangerAcceptInvalidCerts? http3AttemptTimeoutMs? network? protocolMode? proxy? requestTimeoutMs? seed? snapshot?

    Properties

    dangerAcceptInvalidCerts?: boolean
    http3AttemptTimeoutMs?: number

    How long the transport tries HTTP/3 before falling back (auto); passed as is when set.

    network?: 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. See MobileNetwork.

    protocolMode?: TransportProtocolMode

    Protocol mode passed to the native transport as is; overrides the platform default (TransportPlatformDefaults.protocolMode).

    proxy?: string
    requestTimeoutMs?: number

    Timeout of every API request, in milliseconds (default DEFAULT_REQUEST_TIMEOUT_MS); a request's own timeoutMs wins. A timed-out request is abandoned, not cancelled — see createHttpTransportLayer.

    seed?: string
    snapshot?: {
        application: MobileApplicationState;
        cookies: unknown;
        device: MobileDeviceState;
        session: MobileSessionState;
    }

    Settings

    Member Visibility

    On This Page

    Properties