SearchResult

 
public protocol SearchResult

Resolved search object with populated fields

  • id

    Result unique identifier.

    Declaration

    Swift

    var id: String { get }

  • Result name.

    Declaration

    Swift

    var name: String { get }

  • A unique identifier for the geographic feature

    Declaration

    Swift

    var mapboxId: String? { get }

  • Icon name according to Mapbox Maki icon set

    Declaration

    Swift

    var iconName: String? { get }

  • Index in response from server.

    Declaration

    Swift

    var serverIndex: Int? { get }

  • A point accuracy metric for the returned address.

    Declaration

    Swift

    var accuracy: SearchResultAccuracy? { get }

  • Type of SearchResult. Should be one of address or POI.

    Declaration

    Swift

    var type: SearchResultType { get }

  • Result coordinates.

    Declaration

    Swift

    var coordinate: CLLocationCoordinate2D { get }

  • The feature name, as matched by the search algorithm. Not available in searchBox results.

    Warning

    The field is exposed for compatibility only and should be considered deprecated.

    Declaration

    Swift

    var matchingName: String? { get }

  • Result address.

    Declaration

    Swift

    var address: Address? { get }

  • Contains formatted address.

    Declaration

    Swift

    var descriptionText: String? { get }

  • Result categories types.

    Declaration

    Swift

    var categories: [String]? { get }

  • Coordinates of building entries

    Declaration

    Swift

    var routablePoints: [RoutablePoint]? { get }

  • Original search request.

    Declaration

    Swift

    var searchRequest: SearchRequestOptions { get }
  • placemark Default implementation

    MapKit placemark

    Default Implementation

    MapKit placemark

    Declaration

    Swift

    var placemark: MKPlacemark { get }

  • An approximate distance to the origin location, in meters.

    Declaration

    Swift

    var distance: CLLocationDistance? { get }

  • Estimated time of arrival (in minutes) based on specified origin point and NavigationOptions. Those can be specified via SearchOptions

    Declaration

    Swift

    var estimatedTime: Measurement<UnitDuration>? { get }

  • Additional search result data, such as phone number, website and other

    Declaration

    Swift

    var metadata: SearchResultMetadata? { get }