IGPAPI
    Preparing search index...

    Interface NavigationWireValues

    What the navigation state looks like on the wire, in the platform's spelling. One value feeds every place a request names the navigation: the x-ig-nav-chain header and the nav_chain field of a body, the x-ig-client-endpoint header, and the container_module field — so they can never disagree.

    interface NavigationWireValues {
        bodyNavChain: string | undefined;
        clientEndpoint: string | undefined;
        containerModule: MobileNavModule | undefined;
        currentEndpointModule: string | undefined;
        currentModule: string | undefined;
        currentResumedAtMs: number | undefined;
        navChain: string | undefined;
    }
    Index

    Properties

    bodyNavChain: string | undefined

    The nav_chain field of a signed body or query: the chain when the platform is observed to send it there and a chain is recorded, undefined otherwise. Android sends it; iOS has no observation of nav_chain in any request body, so it omits the field rather than porting Android's shape.

    clientEndpoint: string | undefined

    x-ig-client-endpoint; undefined while the platform renders none.

    containerModule: MobileNavModule | undefined

    container_module of the screen in front in the platform's own spelling; undefined when the platform has no observed spelling for the screen, so the field is omitted (never an Android spelling on iOS, never an invented default for a screen no recording names).

    currentEndpointModule: string | undefined

    Endpoint module of the screen in front: the module part of its x-ig-client-endpoint (the catalog's endpointModule when it names one, else its chain module). Request bodies that name the screen they were sent from as a module (from_module) read this, never a caller literal. undefined before the first screen.

    currentModule: string | undefined

    Chain module of the screen in front in the platform's spelling: the value get_account_family reports as request_source. undefined before the first screen or when the platform has no spelling for it.

    currentResumedAtMs: number | undefined

    When the screen in front last came to front, for a navigation-derived request field; undefined before the first screen.

    navChain: string | undefined

    The header rendering (x-ig-nav-chain); undefined while the platform renders none (Android: nothing recorded yet; iOS: a screen no recording names). iOS also has a sentinel for "no screen yet" (not_init), which is this header's value and never a body's.