CustomPoi
interface CustomPoi
Headless (no prebuilt-UI) API to add a custom Point-of-Interest / Tag at an arbitrary location, drop a pin for it, and route to it from the user's current location. This is the programmatic Android parity for the documented iOS "Programmatically Add Points-of-Interest" flow: it does not require any of the prebuilt map-ui fragments and works directly against the map + routing engine.
A custom POI is modelled as a named location (MercatorZone). The destination it routes to uses the supported bare-location Waypoint destination path (Waypoint.Builder), and the route is computed by the routing engine via requestRoute and then drawn on the map via switchRoute.
Inheritors
Types
Link copied to clipboard
interface CustomPoiCallback
Result callback for addAndRouteToCustomPoi.
Link copied to clipboard
class CustomPoiItem
A programmatically-added custom POI/Tag: a named, plotted location on the map.
Functions
Link copied to clipboard
abstract fun addAndRouteToCustomPoi(@NonNull name: String, @NonNull location: MercatorZone, @Nullable callback: MapApi.CustomPoi.CustomPoiCallback)
Create a custom POI at the supplied indoor location (property/building/floor + mercator coordinates), drop a pin for it on the map, add it as the routing destination, and compute + draw a route to it from the user's current location.
abstract fun addAndRouteToCustomPoi(@NonNull name: String, latitude: Double, longitude: Double, propertyId: Int, buildingId: Int, floorId: Int, @Nullable callback: MapApi.CustomPoi.CustomPoiCallback)
Create a custom POI at the supplied WGS84 geographic coordinate.
Link copied to clipboard
abstract fun addCustomPoi(@NonNull name: String, @NonNull location: MercatorZone): MapApi.CustomPoi.CustomPoiItem
Plot a custom POI pin at the supplied location WITHOUT routing to it.