TTSearchQueryBuilder
@interface TTSearchQueryBuilder : NSObject
TTSearchQueryBuilder Search query
-
Create query builder with term
Declaration
Objective-C
+ (TTSearchQueryBuilder *_Nonnull)createWithTerm:(NSString *_Nonnull)term;
Swift
class func create(withTerm term: String) -> TTSearchQueryBuilder
Parameters
term
Query to be searched.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withLimit:(NSUInteger)limit;
Swift
func withLimit(_ limit: UInt) -> TTSearchQueryBuilder
Parameters
limit
Maximum number of search results that will be returned by the search service.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withOffset:(NSUInteger)offset;
Swift
func withOffset(_ offset: UInt) -> TTSearchQueryBuilder
Parameters
offset
Starting offset of the returned results within the full result set.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withPosition:(CLLocationCoordinate2D)position;
Swift
func withPosition(_ position: CLLocationCoordinate2D) -> TTSearchQueryBuilder
Parameters
position
Position where results should be biased.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withPosition:(CLLocationCoordinate2D)position withRadius:(int)radius;
Swift
func withPosition(_ position: CLLocationCoordinate2D, withRadius radius: Int32) -> TTSearchQueryBuilder
Parameters
position
Position for which the results should be biased.
radius
If radius and location are set, the results will be constrained to the defined area.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withCountrySet: (NSSet<NSString *> *_Nonnull)countrySet;
Swift
func withCountrySet(_ countrySet: Set<String>) -> TTSearchQueryBuilder
Parameters
countrySet
This will limit the search to the specified countries.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withIdxSet:(TTSearchIndex)idxSet;
Swift
func withIdxSet(_ idxSet: TTSearchIndex) -> TTSearchQueryBuilder
Parameters
idxSet
Specifies which indexes to use for the search. The predefined indexes are: Addr (address range interpolation), Geo (Geographies), Str (streets).
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withLang:(NSString *_Nonnull)language;
Swift
func withLang(_ language: String) -> TTSearchQueryBuilder
Parameters
language
List of supported languages: https://developer.tomtom.com/search-api/search-api-documentation/supported-languages
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withExtendedPostalCodesFor: (TTSearchIndex)extendedPostalCodesIndexes;
Swift
func withExtendedPostalCodes(for extendedPostalCodesIndexes: TTSearchIndex) -> TTSearchQueryBuilder
Parameters
extendedPostalCodesIndexes
extendedPostalCodesIndexes Indexes for which extended postal codes should be included in the results.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull) withBoundingBoxTopLeft:(CLLocationCoordinate2D)topLeft withBoundingBoxBottomRight:(CLLocationCoordinate2D)bottomRight;
Swift
func withBoundingBoxTopLeft(_ topLeft: CLLocationCoordinate2D, withBoundingBoxBottomRight bottomRight: CLLocationCoordinate2D) -> TTSearchQueryBuilder
Parameters
topLeft
Top left corner of the bounding box.
bottomRight
Bottom right corner of the bounding box.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withTypeAhead:(BOOL)isTypeAhead;
Swift
func withTypeAhead(_ isTypeAhead: Bool) -> TTSearchQueryBuilder
Parameters
isTypeAhead
If the
typeahead
flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withCategory:(BOOL)isCategory;
Swift
func withCategory(_ isCategory: Bool) -> TTSearchQueryBuilder
Parameters
isCategory
Indicates whether the query a category query.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withMinFuzzyLevel:(NSUInteger)minFuzzyLevel;
Swift
func withMinFuzzyLevel(_ minFuzzyLevel: UInt) -> TTSearchQueryBuilder
Parameters
minFuzzyLevel
Minimum fuzziness level to be used.
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withMaxFuzzyLevel:(NSUInteger)maxFuzzyLevel;
Swift
func withMaxFuzzyLevel(_ maxFuzzyLevel: UInt) -> TTSearchQueryBuilder
Parameters
maxFuzzyLevel
Maximum fuzziness level to be used.
Return Value
TTSearchQueryBuilder
-
Bitmask of TTEVConnectorTypes be used to restrict the result to Points Of Interest of type Electric Vehicle Station supporting specific connector types.
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withEVConnectorTypeSet: (TTEVConnectorTypes)connectorTypesSet;
Swift
func withEVConnectorTypeSet(_ connectorTypesSet: TTEVConnectorTypes) -> TTSearchQueryBuilder
Parameters
connectorTypesSet
TTEVConnectorTypes
Return Value
TTSearchQueryBuilder
-
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withCategorySet: (NSArray<NSNumber *> *_Nonnull)categorySet;
Swift
func withCategorySet(_ categorySet: [NSNumber]) -> TTSearchQueryBuilder
Parameters
categorySet
The list of the most specific POI categories.
Return Value
TTSearchQueryBuilder
-
A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withBrandSet:(NSString *_Nonnull)brandSet;
Swift
func withBrandSet(_ brandSet: String) -> TTSearchQueryBuilder
Parameters
brandSet
A comma-separated list of brand names.
Return Value
TTSearchQueryBuilder
-
The list of opening hours for a POI (Points of Interest).
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withOpeningHours: (TTOpeningHoursEnum)openingHours;
Swift
func withOpeningHours(_ openingHours: TTOpeningHoursEnum) -> TTSearchQueryBuilder
Parameters
openingHours
The opening hours mode.
Return Value
TTSearchQueryBuilder
-
Enables the return of a comma-separated mapcodes list. It can also filter the Response to only show selected mapcode types.
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withMapCodes:(TTMapCodeOptions)mapCodes;
Swift
func withMapCodes(_ mapCodes: TTMapCodeOptions = []) -> TTSearchQueryBuilder
Parameters
mapCodes
An array of enum types indicating supported MapCodes.
Return Value
TTSearchQueryBuilder
-
Used to indicate the mode in which the timeZone object should be returned.
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withTimeZone:(TTTimeZoneEnum)timeZone;
Swift
func withTimeZone(_ timeZone: TTTimeZoneEnum) -> TTSearchQueryBuilder
Parameters
timeZone
The enum indicating the type of the time zone. @result TTSearchQueryBuilder
-
Specifies HTTP headers for the Request. It can be used to trace a call.
Declaration
Objective-C
- (TTSearchQueryBuilder *_Nonnull)withHTTPHeaders:(id)headers;
Swift
func withHTTPHeaders(_ headers: Any!) -> TTSearchQueryBuilder
Parameters
headers
HTTP headers for the Request
Return Value
TTSearchQueryBuilder
-
Based on the provided data, it builds a query object.
Return Value
TTSearchQuery