History Class Reference

The History class stores all destinations of past and present navigations over application lifetime
More...

Static Public Member Functions
static ApiError	addHistoryEntry (final Waypoint wpt)
static Iterable< Waypoint >	getHistoryIterator ()
static ApiError	removeAll ()
static ApiError	removeAt (final int index)

Detailed Description

The MapTrip SDK stores a history of the latest destinations which have been added by the application by using Navigation.startNavigation().
The Waypoint history can be modified e.g. added, deleted and traversed The History is persistently stored in the file History.xml

Member Function Documentation

addHistoryEntry()

static ApiError addHistoryEntry ( final Waypoint  wpt )

static

Adds a copy of the waypoint at the front of the history list. If a waypoint with the same attributes already exists in the history, it is deleted

Parameters

wpt	- waypoint to add

Returns

Errorcode

• ApiError.OK if successful
• ApiError.WRONG_PARAM if wpt does not contain valid coordinates
• ApiError.OPERATION_INVALID if wpt has set WptOption.DONT_STORE_IN_HISTORY

getHistoryIterator()

static Iterable< Waypoint > getHistoryIterator ( )

static

Retrieve the waypoints from the history.

Returns

The iterator over contained waypoints.

removeAll()

static ApiError removeAll ( )

static

Remove all waypoints from history.

Returns

Errorcode

• ApiError.OK if successful

removeAt()

static ApiError removeAt ( final int  index )

static

Remove waypoint from history at specific position.

Parameters

index

to remove

Returns

Errorcode

• ApiError.OK if successful
• ApiError.WRONG_PARAM if index is higher than the number of available history entries

---

The documentation for this class was generated from the following file:

• History.java