sdk-search / com.tomtom.online.sdk.search.data.reversegeocoder / ReverseGeocoderSearchQueryBuilder

ReverseGeocoderSearchQueryBuilder

class ReverseGeocoderSearchQueryBuilder : IReverseGeocoderSearchQuery

The default builder for ReverseGeocoderSearchQuery objects.

Constructors

<init>

ReverseGeocoderSearchQueryBuilder(latitude: Double, longitude: Double)

The default builder for ReverseGeocoderSearchQuery objects.

Functions

build

fun build(): ReverseGeocoderSearchQuery

Creates new instance of ReverseGeocoderSearchQuery.

withEntityType

fun withEntityType(entityType: String): ReverseGeocoderSearchQueryBuilder

Specifies the entity type.

withGeopoliticalView

fun withGeopoliticalView(geopoliticalView: String): ReverseGeocoderSearchQueryBuilder

Specifies the geopolitical view.

withHeading

fun withHeading(heading: Float): ReverseGeocoderSearchQueryBuilder

The directional heading of the vehicle in degrees while traveling along a segment of roadway. 0 is North, 90 is East, and so on. Values range from -360 to 360. The precision can include up to one decimal place.

withLanguagePrefix

fun withLanguagePrefix(languagePrefix: String): ReverseGeocoderSearchQueryBuilder

The language in which search results should be returned. It should be one of the supported IETF language tags, case insensitive. When data in the specified language is not available for a specific field, the default language is used.

withNumber

fun withNumber(number: String): ReverseGeocoderSearchQueryBuilder

If a number is sent in along with the Request, the Response may include the side of the street (Left/Right) and also an offset position for that number.

withRadius

fun withRadius(radius: Int): ReverseGeocoderSearchQueryBuilder

If the radius is set, the results will be constrained to the defined area.

withReturnRoadUse

fun withReturnRoadUse(returnRoadUse: Boolean): ReverseGeocoderSearchQueryBuilder

Enables the return of the road use array for reversegeocodes at street level.

withReturnSpeedLimit

fun withReturnSpeedLimit(returnSpeedLimit: Boolean): ReverseGeocoderSearchQueryBuilder

Enables the return of the posted speedlimit (where available).

withRoadUse

fun withRoadUse(roadUse: String): ReverseGeocoderSearchQueryBuilder

Restricts reversegeocodes to a certain type of roaduse. The road use array for reversegeocodes can be one or more of: LimitedAccess,Arterial,Terminal,Ramp,Rotary,LocalStreet.

Companion Object Functions

create

fun create(latitude: Double, longitude: Double): ReverseGeocoderSearchQueryBuilder

Builder used to create an instance of ReverseGeocoderSearchQuery, once constructed, the user cannot change the field values.