TomTom SDK for iOS SearchResult

SearchResult

public struct SearchResult

SearchResult Object containing grouped information about places or points of interest.

  • Creates a new SearchResult instance.

    Declaration

    Swift

    public init(
    type: SearchResultType,
    searchResultID: SearchResultID,
    distance: Measurement<UnitLength>?,
    poi: POI?,
    place: Place,
    boundingBox: BoundingBox?,
    detour: Detour?
)

    Parameters

    type

    The type of result.
    searchResultID

    The ID of the result.
    distance

    The distance from the route provided in the request.
    poi

    Information about the POI.
    place

    Detailed address and the geographical position of the POI.
    boundingBox

    The bounding box of the result.
    detour

    The detailed information about detour which should be taken to reach the search result position.

  • The type of a search result.

    See more

    Declaration

    Swift

    public enum SearchResult.`Type` : Hashable

  • Describes the details about the detour from the route to the point of interest along the route.

    Declaration

    Swift

    public typealias Detour = TomTomSDKSearch.Detour

  • The type of result.

    Declaration

    Swift

    public let type: SearchResultType

  • The ID of the result.

    Declaration

    Swift

    public let searchResultID: SearchResultID

  • The distance from the route provided in the request.

    Declaration

    Swift

    public let distance: Measurement<UnitLength>?
  • poi

    Information about the POI.

    Declaration

    Swift

    public let poi: POI?

  • Detailed address and the geographical position of the POI.

    Declaration

    Swift

    public let place: Place

  • The bounding box of the result.

    Declaration

    Swift

    public let boundingBox: BoundingBox?

  • The detailed information about detour which should be taken to reach the search result position.

    Declaration

    Swift

    public let detour: Detour?

  • Maps SearchResult to POILocation

    Important

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

    Declaration

    Swift

    public func toPoiLocation() -> POILocation

    Return Value

    POILocation equivalent of the SearchResult