android-sdk-ui/com.mapsted.ui/MapUiApi/Itinerary

Itinerary

interface Itinerary

Inheritors

Types

Link copied to clipboard
interface ErrorMessageListener
Listener for error messages to show UI
Link copied to clipboard
interface ItemChangeListener
Listener for itinerary item changes

Functions

Link copied to clipboard
abstract fun add(item: ItineraryItem): Boolean
Add item to itinerary
Link copied to clipboard
abstract fun addAll(stops: List<ItineraryItem>): Boolean
Add multiple items to itinerary
Link copied to clipboard
abstract fun addErrorMessageListener(listener: MapUiApi.Itinerary.ErrorMessageListener): Boolean
Add a listener for when error message should be shown to UI
Link copied to clipboard
abstract fun addItemChangeListener(listener: MapUiApi.Itinerary.ItemChangeListener): Boolean
Add a listener for when itinerary items changed
Link copied to clipboard
abstract fun areAllDestinationsValid(): Boolean
Whether or not all destinations are valid
Link copied to clipboard
@Nullable
abstract fun createRouteRequest(@NonNull context: Context, @NonNull items: List<ItineraryItem>, useEmergencyExit: Boolean): RouteRequest
Build a RouteRequest for the supplied stops (the route-distance preview site), carrying the same alert-derived routing constraints as processRoutingRequest when an AlertProvider is registered.
Link copied to clipboard
@Nullable
abstract fun get(position: Int): ItineraryItem
Retrieve the itinerary item in the given position
Link copied to clipboard
abstract fun getItinerary(): List<ItineraryItem>
Fetch the current itinerary
Link copied to clipboard
abstract fun isStartCurrentLocation(): Boolean
Whether or not the start is set to the user's current location
Link copied to clipboard
abstract fun isStartValid(): Boolean
Whether or not the start position is valid
Link copied to clipboard
abstract fun processRoutingRequest(routingRequestCallback: RoutingRequestCallback)
Process navigation request based on the current itinerary
Link copied to clipboard
abstract fun removeByIndex(idx: Int): Boolean
Remove item from itinerary by index
Link copied to clipboard
abstract fun removeByItineraryItem(item: ItineraryItem): Boolean
Remove item from itinerary (by look-up)
Link copied to clipboard
abstract fun removeByWaypoint(waypoint: Waypoint): Boolean
Remove waypoint from itinerary (by look-up)
Link copied to clipboard
abstract fun removeErrorMessageListener(listener: MapUiApi.Itinerary.ErrorMessageListener): Boolean
remove a listener for when error message should be shown to UI
Link copied to clipboard
abstract fun removeItemChangeListener(listener: MapUiApi.Itinerary.ItemChangeListener): Boolean
remove a listener for when itinerary items changed
Link copied to clipboard
abstract fun removeNonPropertyItineraries(selectedPropertyId: Int)
Removes itinerary items that do not match the given property ID, while retaining items that represent the current location.
Link copied to clipboard
abstract fun reset()
Reset the itinerary (to shared prefs or default)
Link copied to clipboard
abstract fun set(position: Int, item: ItineraryItem): Boolean
Replace the specific position with the supplied item
Link copied to clipboard
abstract fun setAll(items: List<ItineraryItem>): Boolean
Replace existing itinerary with the supplied items
Link copied to clipboard
abstract fun swapItems(idx1: Int, idx2: Int): Boolean
Swap itinerary item positions
Link copied to clipboard
abstract fun updateTag(tag: Tag): Boolean
If a tag with a matching tagId is present in itinerary, update its tag information
Generated by Dokka
© 2026 Copyright