ApiFavorites Class Reference

Static Public Member Functions
static ArrayList< Poi >	getFavoritesList (boolean searchAddress, int maxTime) throws GeneralException
	Returns list of POIs in Favorites category. More...
static String	addStopOffPointsToFavorites (Poi poi, int maxTime) throws InvalidLocationException
	Adds user defined POI to Favorites category. More...
static String	removeFavoriteFromList (Poi favorite, int maxTime) throws InvalidNameException
	Removes POI from list of Favorites. More...

Member Function Documentation

static String addStopOffPointsToFavorites ( Poi  poi, int  maxTime  ) throws InvalidLocationException

static

Adds user defined POI to Favorites category.

Parameters

poi	Poi instance which contains information about POI to add.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Returns

address of location if Poi#isSearchAddress() is true, else null

Exceptions

InvalidLocationException

the invalid location exception

References Api.getInstance(), Api.getService(), and Poi.writeBundle().

static ArrayList<Poi> getFavoritesList ( boolean  searchAddress, int  maxTime  ) throws GeneralException

static

Returns list of POIs in Favorites category.

Parameters

searchAddress	Specifies whether getFavoritesList function searches for address or not. If searchAddress=true getFavoritesList() fills address member of each FavoriteArr item (see Poi class) with corresponding address.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Returns

ArrayList of POIs

Exceptions

GeneralException

the general exception

References Api.getInstance(), Api.getService(), and Poi.readBundle().

static String removeFavoriteFromList ( Poi  favorite, int  maxTime  ) throws InvalidNameException

static

Removes POI from list of Favorites.

Parameters

favorite	Poi instance which contains information about POI to remove.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Returns

address of location if Poi#isSearchAddress() is true, else null

Exceptions

InvalidNameException

the invalid name exception

References Api.getInstance(), Api.getService(), and Poi.writeBundle().