Static Public Member Functions
static void	goOnline (boolean online, int maxTime) throws GeneralException
	Defines if the navigation has to connect to or disconnect from online services. More...

static void	onlineServicesLogin (String userName, String password, int maxTime) throws GeneralException
	Enters the login credentials for the online services, such as life traffic. More...

static String	getMobileData (int maxTime) throws GeneralException
	Retrieves information on mobile data usage statistics and a current parametrization. More...

static void	setMobileData (String json, int maxTime) throws GeneralException
	Sets parametrization on mobile data usage behavior such as monthly mobile data limit and reset day. More...

static void	resetMobileData (int maxTime) throws GeneralException
	Explicit trigger for reseting monthly cycle of mobile data transfer. More...

static String	getMapCorrectionEvents (int maxTime) throws GeneralException
	Exports all map corrections entered by the user of navigation, so called user-defined map corrections. More...

static void	addMapCorrectionEvents (String table, int maxTime) throws GeneralException
	Imports a list of map corrections to be applied on a current map in a specified csv format. More...

static void	clearMapCorrectionEvents (int maxTime) throws GeneralException
	Clears all map corrections imported with the calls of addMapCorrectionEvents Note: it does not clear user-defined map corrections. More...

Member Function Documentation

◆ addMapCorrectionEvents()

static void addMapCorrectionEvents	(	String	table,
		int	maxTime
	)		throws GeneralException

static

Imports a list of map corrections to be applied on a current map in a specified csv format.

If necessary multiple lists can be imported successively. Note: clearMapCorrectionEvents is to reset all the imports.

Parameters

table	string representing list of map corrections in a csv table including header. Example: "ID;ISO_CODE;DIRECTION;EVENT;ICON;JAM_FACTOR;EXPIRATION;DELAY;CLOSURE;OPENLR\n999;SVK;1;401;17;3;0;0;1;CwwuhSI9PsSeAf/dAF3EDg=="
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

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

◆ clearMapCorrectionEvents()

static void clearMapCorrectionEvents ( int maxTime ) throws GeneralException

static

Clears all map corrections imported with the calls of addMapCorrectionEvents Note: it does not clear user-defined map corrections.

The purpose of the function is to prepare for a reimport of a new global map correction database.

Parameters

maxTime Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

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

◆ getMapCorrectionEvents()

static String getMapCorrectionEvents ( int maxTime ) throws GeneralException

static

Exports all map corrections entered by the user of navigation, so called user-defined map corrections.

The list of map corrections is exported as a string represented in a csv format, one event per row.

Parameters

maxTime Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Returns: string representing user-defined list of map corrections in a csv table including header. Example with one event: "ID;ISO_CODE;DIRECTION;EVENT;ICON;JAM_FACTOR;EXPIRATION;DELAY;CLOSURE;OPENLR\n999;SVK;1;401;17;3;0;0;1;CwwuhSI9PsSeAf/dAF3EDg=="

Exceptions

GeneralException the general exception

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

◆ getMobileData()

static String getMobileData ( int maxTime ) throws GeneralException

static

Retrieves information on mobile data usage statistics and a current parametrization.

Statistics are about data transfer count in bytes for a current monthly cycle.

Parameters

maxTime Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Returns: string that contains the mobile data information in the json format. Example: {"totalBytes" : 8169692, "settings" : { "mobileDataLimit": 52000000, "counterStartDay": 1 } }

Exceptions

GeneralException the general exception

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

◆ goOnline()

static void goOnline	(	boolean	online,
		int	maxTime
	)		throws GeneralException

static

Defines if the navigation has to connect to or disconnect from online services.

The online services include functions as live traffic from the server and other.

Parameters

online	Determines whether connect or disconnect. *true* - Connect. *false* - Disconnect.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

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

◆ onlineServicesLogin()

static void onlineServicesLogin	(	String	userName,
		String	password,
		int	maxTime
	)		throws GeneralException

static

Enters the login credentials for the online services, such as life traffic.

If not credentials are given, the application logs in anonymously.

Parameters

userName	User name.
password	Password.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

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

◆ resetMobileData()

static void resetMobileData ( int maxTime ) throws GeneralException

static

Explicit trigger for reseting monthly cycle of mobile data transfer.

The function works only in case the parameter counterStartDay is set to 0 (meaning explicit reset). All the data transfer count statistics get cleared as a new monthly cycle starts after this call.

Parameters

maxTime Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

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

◆ setMobileData()

static void setMobileData	(	String	json,
		int	maxTime
	)		throws GeneralException

static

Sets parametrization on mobile data usage behavior such as monthly mobile data limit and reset day.

The parametrization is given in a json formatted string.

Parameters

json	json string to express mobile data limit and reset day Example: {"settings" : { "mobileDataLimit": 52000000, "counterStartDay": 1 } }
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

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

Static Public Member Functions

Member Function Documentation

◆ addMapCorrectionEvents()

◆ clearMapCorrectionEvents()

◆ getMapCorrectionEvents()

◆ getMobileData()

◆ goOnline()

◆ onlineServicesLogin()

◆ resetMobileData()

◆ setMobileData()