TTSearchQueryBuilder Class Reference

Inherits from NSObject
Declared in TTSearchQuery.h

Overview

TTSearchQueryBuilder Search query

+ createWithTerm:

Create query builder with term

+ (TTSearchQueryBuilder *_Nonnull)createWithTerm:(NSString *_Nonnull)term

Parameters

term

Query to be searched.

Return Value

TTSearchQueryBuilder

Discussion

Create query builder with term

Declared In

TTSearchQuery.h

– withLimit:

Maximum number of search results that will be returned by the search service.

- (TTSearchQueryBuilder *_Nonnull)withLimit:(NSNumber *_Nonnull)limit

Parameters

limit

Maximum number of search results that will be returned by the search service.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withOffset:

Starting offset of the returned results within the full result set.

- (TTSearchQueryBuilder *_Nonnull)withOffset:(NSNumber *_Nonnull)offset

Parameters

offset

Starting offset of the returned results within the full result set.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withPosition:

Position where results should be biased.

- (TTSearchQueryBuilder *_Nonnull)withPosition:(CLLocationCoordinate2D)position

Parameters

position

Position where results should be biased.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withPosition:withRadius:

Position for which the results should be biased.

- (TTSearchQueryBuilder *_Nonnull)withPosition:(CLLocationCoordinate2D)position withRadius:(int)radius

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

Declared In

TTSearchQuery.h

– withCountrySet:

This will limit the search to the specified countries.

- (TTSearchQueryBuilder *_Nonnull)withCountrySet:(NSArray<NSString*> *_Nonnull)countrySet

Parameters

countrySet

This will limit the search to the specified countries.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withIdxSet:

Specifies which indexes to use for the search. The predefined indexes are: Addr (address range interpolation), Geo (Geographies), Str (streets).

- (TTSearchQueryBuilder *_Nonnull)withIdxSet:(NSArray<NSNumber*> *_Nonnull)idxSet

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

Declared In

TTSearchQuery.h

– withLanguage:

Language

- (TTSearchQueryBuilder *_Nonnull)withLanguage:(TTLanguage)languageType

Parameters

languageType

Language

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withExtendedPostalCodesFor:

extendedPostalCodesIndexes Indexes for which extended postal codes should be included in the results.

- (TTSearchQueryBuilder *_Nonnull)withExtendedPostalCodesFor:(TTExtendedPostalCodesIndexes)extendedPostalCodesIndexes

Parameters

extendedPostalCodesIndexes

extendedPostalCodesIndexes Indexes for which extended postal codes should be included in the results.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withBoundingBoxTopLeft:withBoundingBoxBottomRight:

Top left corner of the bounding box.

- (TTSearchQueryBuilder *_Nonnull)withBoundingBoxTopLeft:(CLLocationCoordinate2D)topLeft withBoundingBoxBottomRight:(CLLocationCoordinate2D)bottomRight

Parameters

topLeft

Top left corner of the bounding box.
bottomRight

Bottom right corner of the bounding box.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withTypeAhead:

If the “typeahead” flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.

- (TTSearchQueryBuilder *_Nonnull)withTypeAhead:(BOOL)isTypeAhead

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

Declared In

TTSearchQuery.h

– withCategory:

Indicates whether the query a category query.

- (TTSearchQueryBuilder *_Nonnull)withCategory:(BOOL)isCategory

Parameters

isCategory

Indicates whether the query a category query.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withMinFuzzyLevel:

Minimum fuzziness level to be used.

- (TTSearchQueryBuilder *_Nonnull)withMinFuzzyLevel:(NSNumber *_Nonnull)minFuzzyLevel

Parameters

minFuzzyLevel

Minimum fuzziness level to be used.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– withMaxFuzzyLevel:

Maximum fuzziness level to be used.

- (TTSearchQueryBuilder *_Nonnull)withMaxFuzzyLevel:(NSNumber *_Nonnull)maxFuzzyLevel

Parameters

maxFuzzyLevel

Maximum fuzziness level to be used.

Return Value

TTSearchQueryBuilder

Declared In

TTSearchQuery.h

– build

Baseed on provided data builds query object

- (TTSearchQuery *_Nonnull)build

Return Value

TTSearchQuery

Discussion

Baseed on provided data builds query object

Declared In

TTSearchQuery.h