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

IgpapiHttp
- AndroidHttp

Index

Constructors

constructor

new AndroidHttp(state: AndroidState, errorRouter: AndroidHttpErrorRouter, headers: AndroidDefaultHttpHeaders): AndroidHttp
Parameters
- state: AndroidState
- errorRouter: AndroidHttpErrorRouter
- headers: AndroidDefaultHttpHeaders
Returns AndroidHttp

Overrides IgpapiHttp.constructor

Properties

client

client: Got = ...

`Protected` debug

debug: Debugger = ...

`Private` errorRouter

errorRouter: AndroidHttpErrorRouter

`Protected` headers

headers: AndroidDefaultHttpHeaders

setMasq

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

Type declaration

- (url: null | string): void
- Parameters
  - url: null | string
  Returns void

`Protected` state

state: AndroidState

`Protected` statusCheckerStrategy

statusCheckerStrategy: BodyStatusCheckerStrategy = ...

Methods

agent

agent(proxyUrl?: string): undefined | default | default
Parameters
- Optional proxyUrl: string
Returns undefined | default | default

Inherited from IgpapiHttp.agent

body

body<T>(options: IgpapiHttpRequestParameters): Promise<T>
Type Parameters
- T = unknown
Parameters
- options: IgpapiHttpRequestParameters
Returns Promise<T>

Inherited from IgpapiHttp.body

`Protected` error

error(response: Response<any>): IgpapiError
Parameters
- response: Response<any>
Returns IgpapiError

Overrides IgpapiHttp.error

`Protected` finally

finally(response: Response<any>): void
Parameters
- response: Response<any>
Returns void

Overrides IgpapiHttp.finally

full

full<T>(input: IgpapiHttpRequestParameters): Promise<Response<T>>
Type Parameters
- T = unknown
Parameters
- input: IgpapiHttpRequestParameters
Returns Promise<Response<T>>

Inherited from IgpapiHttp.full

getDefaults

getDefaults(targets: RequestDefaults): object
Parameters
- targets: RequestDefaults
Returns object

setFaultPolicy

setFaultPolicy(policy: IPolicy<IDefaultPolicyContext, never>): void
Parameters
- policy: IPolicy<IDefaultPolicyContext, never>
Returns void

Inherited from IgpapiHttp.setFaultPolicy

setHeaders

setHeaders(headersGenerator: IgpapiHttpHeaders): void
Parameters
- headersGenerator: IgpapiHttpHeaders
Returns void

Inherited from IgpapiHttp.setHeaders

setMasqConnectionPooling

setMasqConnectionPooling(as: boolean): void
Parameters
- as: boolean
Returns void

Inherited from IgpapiHttp.setMasqConnectionPooling

setMasqMode

setMasqMode(mode: null | string): void
Parameters
- mode: null | string
Returns void

Inherited from IgpapiHttp.setMasqMode

setMasqUrl

setMasqUrl(url: null | string): void
Parameters
- url: null | string
Returns void

Inherited from IgpapiHttp.setMasqUrl

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): default
Parameters
- options: Options
Returns default

Inherited from IgpapiHttp.stream

userBreadcrumb

userBreadcrumb(size: number): string
Parameters
- size: number
Returns string

Class AndroidHttp

Example

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

state: AndroidState

errorRouter: AndroidHttpErrorRouter

headers: AndroidDefaultHttpHeaders

Returns AndroidHttp

Properties

client

Protected debug

Private errorRouter

Protected headers

setMasq

Type declaration

Parameters

url: null | string

Returns void

Protected state

Protected statusCheckerStrategy

Methods

agent

Parameters

Optional proxyUrl: string

Returns undefined | default | default

body

Type Parameters

T = unknown

Parameters

options: IgpapiHttpRequestParameters

Returns Promise<T>

Protected error

Parameters

response: Response<any>

Returns IgpapiError

Protected finally

Parameters

response: Response<any>

Returns void

full

Type Parameters

T = unknown

Parameters

input: IgpapiHttpRequestParameters

Returns Promise<Response<T>>

getDefaults

Parameters

targets: RequestDefaults

Returns object

setFaultPolicy

Parameters

policy: IPolicy<IDefaultPolicyContext, never>

Returns void

setHeaders

Parameters

headersGenerator: IgpapiHttpHeaders

Returns void

setMasqConnectionPooling

Parameters

as: boolean

Returns void

setMasqMode

Parameters

mode: null | string

Returns void

setMasqUrl

Parameters

url: null | string

Returns void

sign

Parameters

payload: AndroidHttpSignPayload

Returns { signed_body: string; }

`Protected` debug

`Private` errorRouter

`Protected` headers

`Protected` state

`Protected` statusCheckerStrategy

`Optional` proxyUrl: string

`Protected` error

`Protected` finally

Returns {
signed_body: string;
}