Maps SDK for Android/com.magiclane.sdk.routesandnavigation/RouteBookmarks

RouteBookmarks

class RouteBookmarks(address: Long) : GemNativeObj

RouteBookmarks object

Constructors

Link copied to clipboard
constructor(address: Long)

Types

Link copied to clipboard
object Companion

Route Bookmarks companion

Properties

Link copied to clipboard
val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard
val filepath: String?

Bookmarks collection path.

Link copied to clipboard
val size: Int

Number of routes.

Functions

Link copied to clipboard
external fun add(name: String, waypoints: LandmarkList, preferences: RoutePreferences? = null, overwrite: Boolean = false)

Add a new route / update existing.

Link copied to clipboard
external fun addTrips(filename: String): Int

Add trips from the given filename.

Link copied to clipboard
external fun clear()

Clears all routes bookmarks.

Link copied to clipboard
external fun exportToFile(index: Int, path: String): Int

Export the route to the given file.

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getName(index: Int): String?

Get name of the route specified by index.

Link copied to clipboard
external fun getPreferences(index: Int): RoutePreferences?

Get preferences of the route specified by index.

Link copied to clipboard
external fun getTimestamp(index: Int): Time?

Get timestamp of the route specified by index.

Link copied to clipboard
external fun getWaypoints(index: Int): LandmarkList?

Get waypoints of the route specified by index.

Link copied to clipboard
fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard
external fun remove(index: Int)

Remove the item at the specified index.

Link copied to clipboard
fun setSortOrder(order: ERouteBookmarksSortOrder)

Changes the sort order of the routes. Default order is ESortByDate. UI needs to refresh the list.

Link copied to clipboard
external fun update(index: Int, name: String? = null, waypoints: LandmarkList? = null, preferences: RoutePreferences? = null)

Update a route.