SearchQueryBuilder | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
On-Premise
Urbi Pro

SearchQueryBuilder

Search query builder. The search is performed by the global index, as well as by local indexes of segments, where a segment is a certain piece of the global map partition. The procedure for selecting segments to search is as follows (in descending order of priority):):

Extends: Hashable
public static func == (lhs: SearchQueryBuilder, rhs: SearchQueryBuilder) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Parameters
hasher
Hasher

The hasher to use when combining the components of this instance.

public static func fromQueryText(
    queryText: String
) -> SearchQueryBuilder

Start building a text search query with the given text.

Parameters
queryText
Returns
public static func fromQuery(
    query: SearchQuery
) -> SearchQueryBuilder

Start building a query based on #query to change some of the parameters.

Parameters
query
Returns
public func setSpatialRestriction(
    spatialRestriction: [GeoPoint]?
) -> SearchQueryBuilder

Set the search area limit in the form of a polygon. The first and the last points of the polygon must not coincide.

Parameters
spatialRestriction
Returns
public func setAreaOfInterest(
    rect: GeoRect?
) -> SearchQueryBuilder

Set the rectangular area of interest in geographic coordinates. A typical value is visible_rect from ICamera - the enclosing rectangle of the viewport.

Parameters
rect
Returns
public func setAllowedResultTypes(
    allowedResultTypes: [ObjectType]
) -> SearchQueryBuilder

Specify the types of objects allowed by the query.

Parameters
allowedResultTypes
Returns
public func setPageSize(
    pageSize: Int32
) -> SearchQueryBuilder

Set the preferred number of elements on the results page. Values from the range [1; 50] are allowed

Parameters
pageSize
Returns
public func setDirectoryFilter(
    filter: DirectoryFilter
) -> SearchQueryBuilder

Set filtering for search query.

Parameters
filter
Returns
public func setSortingType(
    sortingType: SortingType
) -> SearchQueryBuilder

Set sorting for the search query.

Parameters
sortingType
Returns
public func build() -> SearchQuery

Generate a search query.

Returns