Class AndroidHttp

This class now uses 'got' There's a migration guide here: https://github.com/sindresorhus/got/blob/master/documentation/migration-guides.md

As a SOCKS-Proxy, use 'socks-proxy-agent' https://github.com/TooTallNate/node-socks-proxy-agent Note: typescript will complain, bot you can @ts-ignore it

Example

igpapi.http.defaults.agent = {
     https: new SocksProxyAgent({
       host,
       port
     }),
   }

 As a HTTP(S) proxy, use 'tunnel'
 https://github.com/koichik/node-tunnel

Example

https://github.com/sindresorhus/got#proxies

Hierarchy (view full)

Constructors

constructor

Properties

client debug headers setMasq state statusCheckerStrategy

Methods

agent body error finally full getDefaults handleResponseHeaders setFaultPolicy setHeaders setMasqConnectionPooling setMasqMode setMasqUrl sign signature stream userBreadcrumb

Constructors

constructor

Properties

client

client: Got = ...

Protecteddebug

debug: Debugger = ...

headers

headers: IgpapiHttpHeaders

setMasq

setMasq: ((url: null | string) => void)

Deprecated

just replace with setMasqUrl() instead

Protectedstate

state: AndroidState

ProtectedstatusCheckerStrategy

statusCheckerStrategy: BodyStatusCheckerStrategy = ...

Methods

agent

  • agent(proxyUrl?: string): undefined | SocksProxyAgent | HttpsProxyAgent

  • Parameters

    • OptionalproxyUrl: string

    Returns undefined | SocksProxyAgent | HttpsProxyAgent

body

Protectederror

Protectedfinally

  • finally(response: Response<any>): void

  • Parameters

    • response: Response<any>

    Returns void

full

getDefaults

handleResponseHeaders

  • handleResponseHeaders(headers: Record<string, undefined | string | string[]>): void

  • Parameters

    • headers: Record<string, undefined | string | string[]>

    Returns void

setFaultPolicy

  • setFaultPolicy(policy: IPolicy<IDefaultPolicyContext, never>): void

  • Parameters

    • policy: IPolicy<IDefaultPolicyContext, never>

    Returns void

setHeaders

setMasqConnectionPooling

setMasqMode

  • setMasqMode(mode: null | string): void

  • Parameters

    • mode: null | string

    Returns void

setMasqUrl

  • setMasqUrl(url: null | string): void

  • Parameters

    • url: null | string

    Returns void

sign

  • sign(payload: AndroidHttpSignPayload): {
        signed_body: string;
    }

  • Parameters

    • payload: AndroidHttpSignPayload

    Returns {
        signed_body: string;
    }

    • signed_body: string

signature

  • signature(): string

  • Returns string

stream

  • stream(options: Options): Request

  • Parameters

    • options: Options

    Returns Request

userBreadcrumb

  • userBreadcrumb(size: number): string

  • Parameters

    • size: number

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods