ApiOptions Class Reference

Static Public Member Functions
static String	getApplicationOptions (int maxTime) throws GeneralException
	Retrieve application settings as a json string. More...
static void	setApplicationOptions (String json, int maxTime) throws GeneralException
	Set some or all application settings through the given json string. More...
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

changeApplicationOptions()

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:
Appearance 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	model.Options instance which contains new settings.
maxTime	Maximum time (in milliseconds) the function can take. If MaxTime=0 function execution is not time limited.

Returns

model.Options instance which contains current settings.

Exceptions

GeneralException

the general exception

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

getApplicationOptions()

static String getApplicationOptions ( int  maxTime ) throws GeneralException

static

Retrieve application settings as a json string.

The returned json string expresses the structure described in JSON Application settings
Please note new output attributes might be added in future, but the existing ones will be kept for backward compatibility

Parameters

maxTime

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

Returns

json string containing current settings

Exceptions

GeneralException

the general exception

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

setApplicationOptions()

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

static

Set some or all application settings through the given json string.

The input json string needs to be expressed in the structure described in JSON Application settings
Please note new input attributes might be added in future, but the existing ones will be kept for backward compatibility

Parameters

maxTime	Maximum time (in milliseconds) the function can take. If MaxTime=0 function execution is not time limited.
json	string containing overwriting settings

Exceptions

GeneralException

the general exception

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

setDefaultValues()

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