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

  • @deprecated This method is deprecated, use withLang:(NSString* _Nonnull)language.

    Declaration

    Objective-C

    - (TTSearchQueryBuilder *_Nonnull)withLanguage:(id)languageType;

    Swift

    func withLanguage(_ languageType: Any!) -> TTSearchQueryBuilder

  • Declaration

    Objective-C

    - (TTSearchQueryBuilder *_Nonnull)withLang:(NSString *_Nonnull)language;

    Swift

    func withLang(_ language: String) -> TTSearchQueryBuilder

    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

  • Baseed on provided data builds query object

    Declaration

    Objective-C

    - (TTSearchQuery *_Nonnull)build;

    Swift

    func build() -> TTSearchQuery

    Return Value

    TTSearchQuery