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

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 partitioning. The procedure for selecting segments for search is performed in the following ways (in the 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 passing them to the given hasher.

Parameters
hasher
Hasher

Hasher to use when combining the components of this instance.

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

Starts building a text search query with the given text.

Parameters
queryText
Returns
public static func fromRubricIds(
    rubricIds: [RubricId]
) -> SearchQueryBuilder

Starts building a search query based on the rubric identifiers.

Parameters
rubricIds
Returns
public static func fromQueryTextAndRubricIds(
    queryText: String,
    rubricIds: [RubricId]
) -> SearchQueryBuilder

Starts building a search query based on the rubric identifiers.

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

Starts building a query based on the #query to change part of the parameters.
The original #query remains unchanged.

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

Sets the search area limitation in the polygon form. The first and the last points of the polygon do not have to coincide.
By default, no limitation is set.

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

Sets the rectangular region of interest in geographic coordinates. A typical value is visible_rect from ICamera - the enclosing rectangle of the view area.

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

Specifies the object types allowed as a result of the request.
By default, all types except Route are allowed.

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

Sets the preferred number of items on the results page. Values in the [1; 50] range are allowed.
Default value is 10.

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

Sets filtering for the search query.

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

Sets sorting for the search query.

Parameters
sortingType
Returns
public func build() -> SearchQuery

Forms a search query.

Returns