RequestOptions

 
public struct RequestOptions

Search request options

  • Coordinate to search around

    Declaration

    Swift

    public var proximity: CLLocationCoordinate2D?

  • Limit search result to a region

    Declaration

    Swift

    public var boundingBox: BoundingBox?

  • Search origin point. This point is used for calculation of SearchResult ETA and distance fields. Set appropriate navigationProfile for better calculation of ETA. If no origin location specified, distance will be calculated based on proximity point.

    Declaration

    Swift

    public var origin: CLLocationCoordinate2D?

  • Navigation profile option used for proper calculation of ETA. It can be driving, cycling or walking.

    Declaration

    Swift

    public var navigationProfile: SearchNavigationProfile?

  • Non-verified query parameters to the server API

    Attention

    May break engine entity functionality. Do not use without SDK developers agreement

    Declaration

    Swift

    public var unsafeParameters: [String : String]?

  • Search request options constructor

    Declaration

    Swift

    public init(proximity: CLLocationCoordinate2D? = nil,
            boundingBox: BoundingBox? = nil,
            origin: CLLocationCoordinate2D? = nil,
            navigationProfile: SearchNavigationProfile? = nil,
            unsafeParameters: [String: String]? = nil)

    Parameters

    proximity

    Coordinate to search around
    boundingBox

    Limit search result to a region
    origin

    Search origin point. This point is used for calculation of SearchResult ETA and distance fields
    navigationProfile

    Navigation profile option used for proper calculation of ETA. It can be driving, cycling or walking