android-sdk-ui/com.mapsted.ui.managers/ItineraryImpl

ItineraryImpl

open class ItineraryImpl : MapUiApi.Itinerary

Constructors

constructor(context: Context, mapApi: MapApi, searchRepository: SearchRepository)

constructor(context: Context, mapApi: MapApi, searchRepository: SearchRepository, @Nullable alertProviderSupplier: Supplier<MapUiApi.AlertProvider>)

Functions

open fun add(item: ItineraryItem): Boolean

Add item to itinerary

open fun addAll(stops: List<ItineraryItem>): Boolean

Add multiple items to itinerary

addErrorMessageListener

open fun addErrorMessageListener(listener: MapUiApi.Itinerary.ErrorMessageListener): Boolean

Add a listener for when error message should be shown to UI

addItemChangeListener

open fun addItemChangeListener(listener: MapUiApi.Itinerary.ItemChangeListener): Boolean

Add a listener for when itinerary items changed

areAllDestinationsValid

open fun areAllDestinationsValid(): Boolean

Whether or not all destinations are valid

buildIndoorOutdoorRouteOptions

open fun buildIndoorOutdoorRouteOptions(): IndoorOutdoorRouteOptions

Builds IndoorOutdoorRouteOptions using custom parameters.

buildRoutingOptionsFromPrefs

open fun buildRoutingOptionsFromPrefs(context: Context): RoutingOptions

Builds the canonical RoutingOptions from the user's saved routing preferences (getRoutingOptions) plus the current buildIndoorOutdoorRouteOptions indoor/outdoor options.

open fun createRequest(mContext: Context, @NonNull items: List<ItineraryItem>, useEmergencyExit: Boolean, @Nullable alertProviderSupplier: Supplier<MapUiApi.AlertProvider>): RouteRequest

Static route-build helper.

createRouteRequest

open fun createRouteRequest(@NonNull context: Context, @NonNull items: List<ItineraryItem>, useEmergencyExit: Boolean): RouteRequest

Instance route-build site for the route-distance preview (used by MapViewModel via createRouteRequest): builds the request with THIS instance's lazily-resolved MapUiApi.AlertProvider so alert-derived routing constraints are injected exactly as in processRoutingRequest.

open fun get(position: Int): ItineraryItem

Retrieve the itinerary item in the given position

open fun getItinerary(): List<ItineraryItem>

Fetch the current itinerary

isStartCurrentLocation

open fun isStartCurrentLocation(): Boolean

Whether or not the start is set to the user's current location

open fun isStartValid(): Boolean

Whether or not the start position is valid

processRoutingRequest

open fun processRoutingRequest(routingRequestCallback: RoutingRequestCallback)

Process navigation request based on the current itinerary

open fun removeByIndex(idx: Int): Boolean

Remove item from itinerary by index

removeByItineraryItem

open fun removeByItineraryItem(item: ItineraryItem): Boolean

Remove item from itinerary (by look-up)

removeByWaypoint

open fun removeByWaypoint(waypoint: Waypoint): Boolean

Remove waypoint from itinerary (by look-up)

removeErrorMessageListener

open fun removeErrorMessageListener(listener: MapUiApi.Itinerary.ErrorMessageListener): Boolean

remove a listener for when error message should be shown to UI

removeItemChangeListener

open fun removeItemChangeListener(listener: MapUiApi.Itinerary.ItemChangeListener): Boolean

remove a listener for when itinerary items changed

removeNonPropertyItineraries

open fun removeNonPropertyItineraries(selectedPropertyId: Int)

Removes itinerary items that do not match with the selected property ID

open fun reset()

Reset/clear the itinerary

open fun set(position: Int, item: ItineraryItem): Boolean

Replace the specific position with the supplied item

open fun setAll(items: List<ItineraryItem>): Boolean

Replace existing itinerary with the supplied items

open fun swapItems(idx1: Int, idx2: Int): Boolean

Swap itinerary item positions

open fun updateTag(tag: Tag): Boolean

If a tag with a matching tagId is present in itinerary, update its tag information