ApiOptions Class Reference

Static Public Member Functions
static Options	changeApplicationOptions (Options changeOption, int maxTime) throws GeneralException
	Changes basic Navigation settings. More...
static void	setDefaultValues (int maxTime) throws GeneralException
	Sets default Navigation values. More...

Member Function Documentation

static Options changeApplicationOptions ( Options  changeOption, int  maxTime  ) throws GeneralException

static

Changes basic Navigation settings.

Use ChangeOption to set new Navigation settings. It is possible to change these characteristics:

for right or left handed user. Enable/disable sounds. Maximum and minimum sound volume (not applicable for Android) Set clock format. It is possible to choose EUROPE, UK or US format. Set distance units. User can choose kilometers or miles. Set GPS units. User can choose degrees, minutes or seconds. Set location of home position. Set keyboard type which Navigation uses. After function execution ChangeOption contains actual Navigation settings.

Parameters

changeOption	Options instance which contains new settings.
maxTime	Maximum of time (in milliseconds) function can take. If MaxTime=0 function execution is not time limited.

Returns

Options instance which contains current settings.

Exceptions

GeneralException

the general exception

References Api.getInstance(), Api.getService(), Options.readBundle(), and Options.writeBundle().

static void setDefaultValues ( int  maxTime ) throws GeneralException

static

Sets default Navigation values.

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().