Package ai.nextbillion.maps.model

Class GeolocationPayload

java.lang.Object
ai.nextbillion.maps.model.GeolocationPayload
All Implemented Interfaces:
java.io.Serializable
public class GeolocationPayload
extends java.lang.Object
implements java.io.Serializable
Request body.

Please see Geolocation Requests and Request Body for more detail.

The following fields are supported, and all fields are optional:

See Also:
Serialized Form

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  GeolocationPayload.GeolocationPayloadBuilder  

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String carrier
    The carrier name.
    CellTower[] cellTowers
    An array of cell tower objects.
    java.lang.Boolean considerIp
    Specifies whether to fall back to IP geolocation if wifi and cell tower signals are not available.
    java.lang.Integer homeMobileCountryCode
    The mobile country code (MCC) for the device's home network.
    java.lang.Integer homeMobileNetworkCode
    The mobile network code (MNC) for the device's home network.
    java.lang.String radioType
    The mobile radio type.
    WifiAccessPoint[] wifiAccessPoints
    An array of WiFi access point objects.

  • Constructor Summary

    Constructors 
    Constructor Description
    GeolocationPayload()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • homeMobileCountryCode

      public java.lang.Integer homeMobileCountryCode
      The mobile country code (MCC) for the device's home network.

    • homeMobileNetworkCode

      public java.lang.Integer homeMobileNetworkCode
      The mobile network code (MNC) for the device's home network.

    • radioType

      public java.lang.String radioType
      The mobile radio type. Supported values are "lte", "gsm", "cdma", and "wcdma". While this field is optional, it should be included if a value is available, for more accurate results.

    • carrier

      public java.lang.String carrier
      The carrier name.

    • considerIp

      public java.lang.Boolean considerIp
      Specifies whether to fall back to IP geolocation if wifi and cell tower signals are not available. Note that the IP address in the request header may not be the IP of the device. Defaults to true. Set considerIp to false to disable fall back.

    • cellTowers

      public CellTower[] cellTowers
      An array of cell tower objects. See CellTower.

    • wifiAccessPoints

      public WifiAccessPoint[] wifiAccessPoints
      An array of WiFi access point objects. See WifiAccessPoint.

  • Constructor Details

  • Method Details

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object