IGPAPI
    Preparing search index...

    Type Alias AndroidIgpapiOptions

    AndroidIgpapiOptions: (
        | { checkpoint?: undefined; seed: string; snapshot?: undefined }
        | { checkpoint?: undefined; seed?: undefined; snapshot: MobileSnapshot }
        | { checkpoint: unknown; seed?: undefined; snapshot?: undefined }
    ) & {
        dangerAcceptInvalidCerts?: boolean;
        location?: MobileDeviceLocation;
        network?: MobileNetwork;
        protocolMode?: TransportProtocolMode;
        proxy?: string;
        pushToken?: string;
        requestTimeoutMs?: number;
    }

    Options of the Android app layer (AndroidApp).

    Use seed for a fresh deterministic virtual device, snapshot to restore a session exported with ExportSnapshot, or checkpoint to continue a checkpointed process — the screen restores then put the process state and the screen stack back over this client.

    Exactly one stored form, like the launch input: seed, snapshot and checkpoint are three forms of one slot, so a second one beside the first is a type error rather than a value the build silently resolves in one order. A continued process (a checkpoint) is the very client state the checkpoint carries, so it takes no network or pushToken either: those belong to a launch from a checkpoint (a new process), and the build refuses them with the declared SnapshotDecodeError instead of building a client every restore then refuses.

    The checkpoint is unknown on purpose: it crosses JSON storage, and the build decodes it itself — a damaged one, one of another format or one taken on another platform is the declared SnapshotDecodeError, never a process that quietly diverges.

    Type Declaration

    • { checkpoint?: undefined; seed: string; snapshot?: undefined }
    • { checkpoint?: undefined; seed?: undefined; snapshot: MobileSnapshot }
    • { checkpoint: unknown; seed?: undefined; snapshot?: undefined }
    • OptionaldangerAcceptInvalidCerts?: boolean

      Allow invalid TLS certificates in the native transport.

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

    • Optionallocation?: MobileDeviceLocation

      The coarse position the device knows, when the caller models one. The 450 app sends it on the search results, the 451 app sends none on a device without one; when set it replaces a restored snapshot's position.

    • 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 http2: no Android flow shows the app on HTTP/3). The Android profile has no HTTP/3 path; the transport rejects http3 at client creation.

    • Optionalproxy?: string

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

    • OptionalpushToken?: string

      The device's FCM/FBNS push token from the platform push SDK. It is a device fact (MobileDeviceState.pushToken), not a launch input: the launch reads it from the device, push/register is skipped when the device holds none, and a restored snapshot keeps the token it was saved with. When set it replaces a restored snapshot's token.

    • 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