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

SearchQueryBuilder

Построитель поисковых запросов. Поиск осуществляется по глобальному индексу, а также по локальным индексам сегментов, где сегмент - это некоторый кусок разбиения глобальной карты. Процедура выбора сегментов для поиска осуществляется следующими способами (по убыванию приоритета):

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

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters
hasher
Hasher

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

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

Начать построение текстового поискового запроса c указанным текстом.

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

Начать построение поискового запроса на основе идентификаторов рубрик.

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

Начать построение текстового поискового запроса с фильтрацией по идентификаторам рубрик.

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

Начать построение запроса на основе запроса #query для изменения части параметров.
Исходный запрос #query остается без изменений

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

Задать ограничение области поиска в форме полигона. Первая и последняя точки полигона не обязаны совпадать.
по умолчанию ограничение отсутствует

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

Задать прямоугольную область интереса в географических координатах. Типичным значением является visible_rect из ICamera - объемлющий прямоугольник области просмотра.

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

Задать типы объектов, разрешенные в результате запроса.
по умолчанию все, кроме Route

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

Задать предпочитаемое количество элементов на странице результатов. Допустимы значения из диапазона [1; 50]
по умолчанию 10

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

Задать фильтрацию для поискового запроса.

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

Задать сортировку для поискового запроса.

Parameters
sortingType
Returns
public func build() -> SearchQuery

Сформировать поисковый запрос.

Returns