TomTom SDK for iOS POILocation

POILocation

public struct POILocation : Equatable

Represents a Point of Interest Location (POILocation) with associated metadata.

A POILocation encapsulates the data required to plot a point on a map, including its coordinates and additional information such as its category and potential detour metrics.

Important

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

  • Initializes a new Point of Interest Location (POILocation) with the provided data.

    Declaration

    Swift

    public init(
    place: Place,
    poi: POI? = nil,
    onRouteDetourDetails: OnRouteDetourDetails? = nil
)

    Parameters

    place

    The TomTomSDKCommon/Place information of the point of interest.
    poi

    The Point of Interest (TomTomSDKCommon/POI) information.
    onRouteDetourDetails

    Detour details for points of interest along the route.

  • The TomTomSDKCommon/Place information of the point of interest.

    Declaration

    Swift

    public let place: Place
  • poi

    The Point of Interest (TomTomSDKCommon/POI) information.

    Declaration

    Swift

    public let poi: POI?

  • Detour details for points of interest along the route.

    Declaration

    Swift

    public let onRouteDetourDetails: OnRouteDetourDetails?

  • Implements a method that checks whether two POILocation objects are the same location.

    Two POILocation objects are the same location if they have the same POI and Place. Dynamic data of OnRouteDetourDetails are excluded from comparison.

    Declaration

    Swift

    public static func == (lhs: POILocation, rhs: POILocation) -> Bool

    Parameters

    lhs

    A POILocation to compare.
    rhs

    Another POILocation to compare.

    Return Value

    True if both poi locations are equal.