Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GeolocateRequest

Hierarchy

  • Partial<AxiosRequestConfig>
    • GeolocateRequest

Index

Properties

Properties

Optional adapter

adapter: AxiosAdapter

Optional auth

auth: AxiosBasicCredentials

Optional baseURL

baseURL: string

Optional cancelToken

cancelToken: CancelToken

data

data: { carrier?: string; cellTowers?: CellTower[]; considerIp?: boolean; homeMobileCountryCode?: number; homeMobileNetworkCode?: number; radioType?: RadioType; wifiAccessPoints?: WifiAccessPoint[] }

Type declaration

  • Optional carrier?: string

    The carrier name.

  • Optional cellTowers?: CellTower[]

    An array of cell tower objects.

  • Optional considerIp?: boolean

    Specifies whether to fall back to IP geolocation if wifi and cell tower signals are not available. Defaults to true. Set considerIp to false to disable fall back.

  • Optional homeMobileCountryCode?: number

    The mobile country code (MCC) for the device's home network.

  • Optional homeMobileNetworkCode?: number

    The mobile network code (MNC) for the device's home network.

  • Optional radioType?: RadioType

    The mobile radio type. While this field is optional, it should be included if a value is available, for more accurate results.

  • Optional wifiAccessPoints?: WifiAccessPoint[]

    An array of WiFi access point objects.

Optional decompress

decompress: boolean

Optional headers

headers: any

Optional httpAgent

httpAgent: any

Optional httpsAgent

httpsAgent: any

Optional maxBodyLength

maxBodyLength: number

Optional maxContentLength

maxContentLength: number

Optional maxRedirects

maxRedirects: number

Optional method

method: Method

Optional onDownloadProgress

onDownloadProgress: (progressEvent: any) => void

Type declaration

    • (progressEvent: any): void

    • Parameters

      • progressEvent: any

      Returns void

Optional onUploadProgress

onUploadProgress: (progressEvent: any) => void

Type declaration

    • (progressEvent: any): void

    • Parameters

      • progressEvent: any

      Returns void

params

params: RequestParams

Optional paramsSerializer

paramsSerializer: (params: any) => string

Type declaration

    • (params: any): string

    • Parameters

      • params: any

      Returns string

Optional proxy

proxy: false | AxiosProxyConfig

Optional raxConfig

raxConfig: RetryConfig

Optional responseType

responseType: ResponseType

Optional socketPath

socketPath: string

Optional timeout

timeout: number

Optional timeoutErrorMessage

timeoutErrorMessage: string

Optional transformRequest

transformRequest: AxiosTransformer | AxiosTransformer[]

Optional transformResponse

transformResponse: AxiosTransformer | AxiosTransformer[]

Optional transitional

transitional: TransitionalOptions

Optional url

url: string

Optional validateStatus

validateStatus: (status: number) => boolean

Type declaration

    • (status: number): boolean

    • Parameters

      • status: number

      Returns boolean

Optional withCredentials

withCredentials: boolean

Optional xsrfCookieName

xsrfCookieName: string

Optional xsrfHeaderName

xsrfHeaderName: string

Generated using TypeDoc