interface IFuzzySearchQuery
This query is an interface designed to transfer Search API parameters in a readable manner by implementing the class: FuzzySearchQueryBuilder. The FuzzySearchQuery instance can be constructed using the associated FuzzySearchQueryBuilder class. Once constructed, the user cannot change the field values.
abstract fun withBoundingBox(boundingBox: BoundingBox!): IFuzzySearchQuery
The bounding box for the search. NOTE: Point-Radius parameters and bounding box parameters are mutually exclusive. Point-Radius parameters take precendence when both are passed in. |
|
abstract fun withBrandSet(brandSet: String!): IFuzzySearchQuery
A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands. |
|
abstract fun withCategory(isCategory: Boolean!): IFuzzySearchQuery
If your search use case only requires POI results filtered by category, you may use the Category endpoint. |
|
abstract fun withCountry(country: String!): IFuzzySearchQuery
A comma-separated string of country codes (e.g., FR,ES). This will limit the search to the specified countries. |
|
abstract fun withEVConnectorSetFilter(evConnectorSet: String!): IFuzzySearchQuery
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. |
|
abstract fun withExtendedPostalCodes(extPostalCodesFor: String!): IFuzzySearchQuery
Indexes for which extended postal codes should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr. The value should be a comma-separated list of index types (in any order), or "None" for no indexes, i.e., "PAD,Addr,POI" |
|
abstract fun withFuelSet(fuelSet: String!): IFuzzySearchQuery
A comma-separated list of fuel types which could be used to restrict the result to Points Of Interest of specific fuels. |
|
abstract fun withIdx(idxSet: String!): IFuzzySearchQuery
A comma-separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr, Geo, PAD, POI, Str, Xstr, i.e., "PAD,Addr". |
|
abstract fun withLanguage(language: String!): IFuzzySearchQuery
The language in which search results should be returned. 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. |
|
abstract fun withLimit(limit: Int!): IFuzzySearchQuery
The upper limit of the number of results. |
|
abstract fun withMapCodes(mapCodes: MutableSet<MapCodeType!>!): IFuzzySearchQuery
Enables the return of mapcodes. |
|
abstract fun withMaxFuzzyLevel(maxFuzzyLevel: Int!): IFuzzySearchQuery
The maximum fuzzyness level to be used. The default value is 2. The maximum value is 4. |
|
abstract fun withMinFuzzyLevel(minFuzzyLevel: Int!): IFuzzySearchQuery
The minimum fuzzyness level to be used. The default value is 1. The maximum value is 4. |
|
abstract fun withOffset(offset: Int!): IFuzzySearchQuery
The starting offset of the returned results within the full result set. |
|
abstract fun withOpeningHours(openingHours: OpeningHoursMode!): IFuzzySearchQuery
When used includes a list of opening hours for a POI (Points of Interest). |
|
abstract fun withPosition(position: LatLng!): IFuzzySearchQuery
The position where results should be biased. Supplying the position without a radius will only bias the search results to that area. |
|
abstract fun withPreciseness(positionAcc: LatLngAcc!): IFuzzySearchQuery
The position where results should be biased. The radius parameter is specified in meters. If radius and position are set, the results will be constrained to the defined area. If radius is not present, or is set to 0, the results will not be constrained. |
|
abstract fun withRelatedPois(poiRelationType: PoiRelationType!): IFuzzySearchQuery
Enables the return of related POIs. |
|
abstract fun withTimeZone(timeZone: TimeZoneType!): IFuzzySearchQuery
When used includes POIs' time zones. |
|
abstract fun withTypeAhead(isTypeAhead: Boolean!): IFuzzySearchQuery
If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode. |