Builder

public final class Builder

A builder to create and/or modify ReverseGeocoderQuery

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Creates a builder with the specified location

    Declaration

    Swift

    public init(position: CLLocationCoordinate2D)

    Parameters

    position

    A coordinates that will be translated into a human-understandable street address, street element, or geography.

Public

  • Adds the heading to the Builder.

    Declaration

    Swift

    public func with(heading: Int) throws -> Self

    Parameters

    heading

    The directional heading of the vehicle in degrees, for travel along a segment of roadway. The value should be in range of 0…360

    Return Value

    Builder object.

  • Adds a radius to the Builder.

    Declaration

    Swift

    public func with(radius: Int) throws -> Self

    Parameters

    radius

    The maximum distance in meters from the specified position for the reverseGeocode to consider. The value should be >= 1

    Return Value

    Builder object.

  • Adds a roadUse to the Builder.

    Declaration

    Swift

    public func with(supportedRoadUses: Set<RoadUse>?) -> Self

    Parameters

    roadUse

    States which road use classes the reverseGeocode will return.

    Return Value

    Builder object.

  • Adds supported geographies to the Builder.

    Declaration

    Swift

    public func with(supportedEntityTypes: Set<EntityType>?) -> Self

    Parameters

    supportedAreas

    This parameter specifies the level of filtering performed on geographies.

    Return Value

    Builder object.

  • Adds the language to the builder.

    Declaration

    Swift

    public func with(language: String) -> Self

    Parameters

    language

    The chosen language, from the list of supported languages: https://developer.tomtom.com/search-api/search-api-documentation/supported-languages

    Return Value

    Builder object.

  • Adds a geopolitical perspective to the Builder.

    Declaration

    Swift

    public func with(geopoliticalView: String) -> Self

    Parameters

    view

    Geopolitical View. Geopolitical views are used to determine how disputed territories are displayed. Views include Unified, along with AR, IL, IN, MA, PK, RU, TR, and CN which are respectively tailored for Argentina, Israel, India, Morocco, Pakistan, Russia, Turkey, and China.

    Return Value

    Builder object.

  • Builds a new query with all parameters provided before.

    Declaration

    Swift

    public func build() -> ReverseGeocoderQuery

    Return Value

    ReverseGeocoderQuery object