ReverseGeocoderQuery

public struct ReverseGeocoderQuery

Defines the input to the reverse geocoding service.

Important

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

Public

  • Describes the error that might occur when building a query

    Declaration

    Swift

    public enum ValidationError : Error

  • A builder to create and/or modify ReverseGeocoderQuery

    Important

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

    Declaration

    Swift

    public final class Builder

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

    Declaration

    Swift

    public let position: CLLocationCoordinate2D

  • The directional heading of the vehicle in degrees when it is traveling along a segment of roadway. Zero is North, 90 is East and so on

    Note

    the value should be in range of 0…360

    Declaration

    Swift

    public fileprivate(set) var heading: Int? { get }

  • The maximum distance in meters from the specified position that the reverse geocoder will deliver results for. Default value: 10000 meters (10km).

    Note

    the value should be a positive integer >= 1

    Declaration

    Swift

    public fileprivate(set) var radius: Int { get }

  • Restricts reverse geocoding to certain types of road uses

    Declaration

    Swift

    public fileprivate(set) var supportedRoadUses: [RoadUse]? { get }

  • Specifies the level of filtering performed on geographies. Providing this parameter narrows the search to specified geography entity types. The resulting response will contain the geography ID as well as the matched entity type. This ID is a token that can be used to get the geometry of that geography. The following parameters are ignored when entityType is set: [heading], [preferredBuildingNumber], [fetchSupportedRoads], [supportedRoads]

    Declaration

    Swift

    public fileprivate(set) var supportedEntityTypes: [EntityType]? { get }

  • IETF language tag (case insensitive), for the language in which search results should be returned. When the language tag is invalid or data in a specified language is not available for a specific field, the default value is used. The default language value is NGT (Neutral Ground Truth), that means official languages for all regions in local scripts if available.

    Declaration

    Swift

    public fileprivate(set) var language: String? { get }

  • An ISO 3166-1 alpha3 country code, that gives the context used to resolve the handling of disputed territories. If there are no geopolitical views for the provided country code then the default view is used.

    Declaration

    Swift

    public fileprivate(set) var geopoliticalView: String? { get }

  • Acts as a filter, so only the results with provided map code types are returned. In addition, enables inclusion of the map codes in the result

    Declaration

    Swift

    public fileprivate(set) var supportedMapCodeTypes: [MapCodeType]? { get }

  • Gives the preference to the closest accurate address over the address with the closest coordinates to route to.

    Declaration

    Swift

    public fileprivate(set) var preferClosestAccurateAddress: Bool { get }

  • Enables the inclusion of geometry shapes for the provided reverse geocoding results. (where available)

    Declaration

    Swift

    public fileprivate(set) var fetchGeometry: Bool { get }