sdk-search / com.tomtom.online.sdk.search.data.geometry / GeometrySearchQueryBuilder

GeometrySearchQueryBuilder

class GeometrySearchQueryBuilder : IGeometrySearchQuery

Builder class used to create GeometrySearchQuery.

Constructors

<init>

GeometrySearchQueryBuilder(term: String, geometries: List<Geometry>)

Builder class used to create GeometrySearchQuery.

Functions

build

fun build(): GeometrySearchQuery

Creates a new instance of GeometrySearchQuery.

withBrandSet

fun withBrandSet(brandSet: String): GeometrySearchQueryBuilder

A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.

withCategorySet

fun withCategorySet(categorySet: List<Long>): GeometrySearchQueryBuilder

Restricts the results to the categories of provided POIs.

withEVConnectorSetFilter

fun withEVConnectorSetFilter(EVConnectorSetFilter: String): GeometrySearchQueryBuilder

A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.

withExtendedPostalCodesFor

fun withExtendedPostalCodesFor(extendedPostalCodesFor: String): GeometrySearchQueryBuilder

Indexes for extended postal codes that should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr. For example: extendedPostalCodesFor=PAD,Addr,POI Availability is region-dependent.

withFuelSet

fun withFuelSet(fuelSet: String): GeometrySearchQueryBuilder

A comma-separated list of fuel types which could be used to restrict the result to Points Of Interest of specific fuels.

withGeopoliticalView

fun withGeopoliticalView(geopoliticalView: String): GeometrySearchQueryBuilder

Defines what kind of geopolitical view should be used.

withIdxSet

fun withIdxSet(idxSet: String): GeometrySearchQueryBuilder

The "idxSet" parameter allows for fine tuning L2 by specifying which indexes to utilize for the search. Comma-separated, for example: idxSet=POI,PAD,Str,Xstr,Geo,Addr.

withLanguage

fun withLanguage(language: String): GeometrySearchQueryBuilder

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 langauge is used.

withLimit

fun withLimit(limit: Int): GeometrySearchQueryBuilder

The maximum number of responses that will be returned.

withMapCodes

fun withMapCodes(mapCodes: Set<MapCodeType>): GeometrySearchQueryBuilder

Enables the return of mapcodes.

withOpeningHours

fun withOpeningHours(openingHours: OpeningHoursMode): GeometrySearchQueryBuilder

When used includes a list of opening hours for a POI (Points of Interest).

withRelatedPois

fun withRelatedPois(relatedPois: PoiRelationType): GeometrySearchQueryBuilder

Enables the return of related POIs.

withTimeZone

fun withTimeZone(timeZone: TimeZoneType): GeometrySearchQueryBuilder

When used includes POIs' time zones.

withTypeAhead

fun withTypeAhead(typeAhead: Boolean): GeometrySearchQueryBuilder

If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode. Default value: false

Companion Object Functions

create

fun create(term: String, geometries: List<Geometry>): GeometrySearchQueryBuilder

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