de.infoware.android.mti.ApiListener Interface Reference

Public Member Functions
void	onError (int requestId, String command, ApiError returnCode)
void	onErrorWithDescription (int requestId, String command, String description, ApiError returnCode)
void	findServerResult (int requestId, ApiError returnCode)
void	initResult (int requestId, ApiError returnCode)
void	showAppResult (int requestId, ApiError returnCode)
void	sendTextResult (int requestId, ApiError returnCode)
void	getMapVersionResult (int requestId, String version, ApiError returnCode)
void	getMaptripVersionResult (int requestId, String version, ApiError returnCode)
void	getApiVersionResult (int requestId, String version, ApiError returnCode)
void	showServerResult (int requestId, ApiError returnCode)
void	hideServerResult (int requestId, ApiError returnCode)
void	addBlockagePointResult (int requestId, ApiError returnCode)
void	addBlockagePathResult (int requestId, ApiError returnCode)
void	addBlockagePolygonResult (int requestId, ApiError returnCode)
void	addBlockageOfRoutePartResult (int requestId, ApiError returnCode)
void	deleteAllBlockagesResult (int requestId, ApiError returnCode)
void	deleteBlockageAtResult (int requestId, ApiError returnCode)
void	deleteBlockageByIDResult (int requestId, ApiError returnCode)
void	getBlockageCountResult (int requestId, int BlockageCount, ApiError returnCode)
void	getBlockageAtResult (int requestId, double radius, boolean persistent, String ID, long startTime, long endTime, ShpTypes ShapeType, ApiError returnCode)
void	stopServerResult (int requestId, ApiError returnCode)
void	enableNetworkConnectionsResult (int requestId, ApiError returnCode)
void	setDataUsageMonthlyLimitResult (int requestId, ApiError returnCode)
void	resetDataUsageMonthlyLimitResult (int requestId, ApiError returnCode)
void	getDataUsageMonthlyLimitResult (int requestId, int LimitKB, ApiError returnCode)
void	getDataUsageRemainingQuotaResult (int requestId, int remainingKB, ApiError returnCode)
void	isNetworkConnectionEnabledResult (int requestId, boolean enabled, ApiError returnCode)
void	customFunctionResult (int requestId, String result1, String result2, ApiError returnCode)
void	setSettingsParameter (int requestId, ApiError returnCode)
void	getSettingsParameter (int requestId, String section, String parameter, String value, ApiError returnCode)
void	infoMsg (Info messageType, int param)

Member Function Documentation

addBlockageOfRoutePartResult()

void de.infoware.android.mti.ApiListener.addBlockageOfRoutePartResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.addBlockageOfRoutePart() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

addBlockagePathResult()

void de.infoware.android.mti.ApiListener.addBlockagePathResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.addBlockagePath() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

addBlockagePointResult()

void de.infoware.android.mti.ApiListener.addBlockagePointResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.addBlockagePoint() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

addBlockagePolygonResult()

void de.infoware.android.mti.ApiListener.addBlockagePolygonResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.addBlockagePolygon() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

customFunctionResult()

void de.infoware.android.mti.ApiListener.customFunctionResult	(	int	requestId,
		String	result1,
		String	result2,
		ApiError	returnCode
	)

Result from the Api.customFunction() function.

Parameters

result1	- first result (dependent on the maptrip configuration)
result2	- second result (dependent on the maptrip configuration)
requestId	- unique Id of the request which initiated the request
returnCode	- MTI_ERROR results dependent on the maptrip configuration

deleteAllBlockagesResult()

void de.infoware.android.mti.ApiListener.deleteAllBlockagesResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.deleteAllBlockages() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

deleteBlockageAtResult()

void de.infoware.android.mti.ApiListener.deleteBlockageAtResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.deleteBlockageAt() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

deleteBlockageByIDResult()

void de.infoware.android.mti.ApiListener.deleteBlockageByIDResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.deleteBlockageByID() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

enableNetworkConnectionsResult()

void de.infoware.android.mti.ApiListener.enableNetworkConnectionsResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.enableNetworkConnections() function.

Parameters

requestId	- unique Id of the request which initiated closing of the server, If the requestID is MTI_REQUEST_NO_REQUEST_ID, the server was closed by an external source.
returnCode	- ApiError.OK on success

findServerResult()

void de.infoware.android.mti.ApiListener.findServerResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.findServer() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

getApiVersionResult()

void de.infoware.android.mti.ApiListener.getApiVersionResult	(	int	requestId,
		String	version,
		ApiError	returnCode
	)

Result from the Api.getApiVersion() function.

Parameters

requestId	- unique identifier returned by the initiating request
version	- version string of the api used by the server
returnCode	- ApiError.OK on success

getBlockageAtResult()

void de.infoware.android.mti.ApiListener.getBlockageAtResult	(	int	requestId,
		double	radius,
		boolean	persistent,
		String	ID,
		long	startTime,
		long	endTime,
		ShpTypes	ShapeType,
		ApiError	returnCode
	)

Result from the Api.getBlockageAt() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

getBlockageCountResult()

void de.infoware.android.mti.ApiListener.getBlockageCountResult	(	int	requestId,
		int	BlockageCount,
		ApiError	returnCode
	)

Result from the Api.getBlockageCount() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

getDataUsageMonthlyLimitResult()

void de.infoware.android.mti.ApiListener.getDataUsageMonthlyLimitResult	(	int	requestId,
		int	LimitKB,
		ApiError	returnCode
	)

Result from the Api.getDataUsageMonthlyLimit() function.

Parameters

requestId	- unique Id of the request which initiated closing of the server, If the requestID is MTI_REQUEST_NO_REQUEST_ID, the server was closed by an external source.
limitKB	- Monthly data limit in KB as set by setDataUsageMonthlyLimit
returnCode	- ApiError.OK on success

getDataUsageRemainingQuotaResult()

void de.infoware.android.mti.ApiListener.getDataUsageRemainingQuotaResult	(	int	requestId,
		int	remainingKB,
		ApiError	returnCode
	)

Result from the Api.getDataUsageRemainingQuota() function.

Parameters

requestId	- unique Id of the request which initiated closing of the server, If the requestID is MTI_REQUEST_NO_REQUEST_ID, the server was closed by an external source.
remainingKB	- remaining quota in KB before reaching the monthly data usage limit
returnCode	- ApiError.OK on success

getMaptripVersionResult()

void de.infoware.android.mti.ApiListener.getMaptripVersionResult	(	int	requestId,
		String	version,
		ApiError	returnCode
	)

Result from the Api.getMaptripVersion() function.

Parameters

requestId	- unique identifier returned by the initiating request
version	- version string of the map data
returnCode	- ApiError.OK on success

getMapVersionResult()

void de.infoware.android.mti.ApiListener.getMapVersionResult	(	int	requestId,
		String	version,
		ApiError	returnCode
	)

Result from the Api.getMapVersion() function.

Parameters

requestId	- unique identifier returned by the initiating request
version	- version string of the map data. Format: "(maprelease) mapProvider"
returnCode	- ApiError.OK on success

getSettingsParameter()

void de.infoware.android.mti.ApiListener.getSettingsParameter	(	int	requestId,
		String	section,
		String	parameter,
		String	value,
		ApiError	returnCode
	)

Result from the Api.getSettingsParameter() function

Parameters

requestId	- unique Id of the request which caused an error
section	- section of the requested parameter
parameter	- name of the requested parameter
value	- value of the requested parameter
returnCode	- error identifier of the type MTI_ERROR ApiError.UNKNOWN_COMMAND - if maptrip received a command that can not be handled ApiError.WRONG_PARAM - if maptrip received a command with non matching parameter list ApiError.UNKNOWN_RESPONSE - if a maptrip message is received which is not known by the client ApiError.COULD_NOT_POST_TO_SERVER - if messages can not be send to the server - re-init the MTI interface ApiError.QUEUE_LIMIT_EXCEEDED - if Messages from MapTrip have queued up greater than the queue size, see Api.setQueueSize()- increase the queue size, activate blocking message passing ( Api.setBlockingMessagePassing() ) or reduce the load of windows messages respectively avoid blocking the message queue in the client application

hideServerResult()

void de.infoware.android.mti.ApiListener.hideServerResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.hideServer() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

infoMsg()

void de.infoware.android.mti.ApiListener.infoMsg	(	Info	messageType,
		int	param
	)

This callback is called on certain events of the server application that can occur if the maptrip application gets user input. It notifies if e.g. a user starts a navigation on the maptrip UI or if Maptrip has started or quit.

This message can be registered before initialization to receive Info.MAPTRIP_STARTED event. After a call to Api.uninit() no further infoMsg can be received. Re-register the callback to receive the Info.MAPTRIP_STARTED events again.

The infomessages maybe extended in further releases - dont treat unknown messages in your application as error to stay compatible with future MapTrip versions.

Parameters

messageType

- indicates the event that initiated this callback Info.NAVIGATION_STARTED - if a navigation was started; param is empty Info.FMR_STARTED - if a Follow Me Route was started or continued; param is empty Info.MAPTRIP_WAS_MINIMIZED - if the server is minimized; param is empty Info.MAPTRIP_WAS_RESTORED - if the server is restored; param is empty Info.SERVER_IS_CLOSING - if the server is closing, after a restart of the server Api.init() has to be called; This message can be received without a previous call to Api.init(); param is empty Info.MAPTRIP_STARTED - if MapTrip has started, This message can be received without a previous call to Api.init(); param is empty Info.MUTE_ON - if MapTrip sound output has been muted; param is empty Info.MUTE_OFF - if muting has been turned off so sound output is now on; param is empty Info.BEFORE_ADVICE_STARTS - this message is issued just before MapTrip starts ca callout; param is empty Info.AFTER_ADVICE_FINISHED - this message is issed just after MapTrip has finished a callout; param is empty Info.MAP_ACTIVE - if the MapTrip map is active; param is empty, only Android Info.MAP_INACTIVE - if the MapTrip map is inactive; param is empty, only Android

param

- message dependent parameter, content depends on the msgCode( may be empty )

initResult()

void de.infoware.android.mti.ApiListener.initResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.init() function. On success, the server is ready to receive further messages.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

isNetworkConnectionEnabledResult()

void de.infoware.android.mti.ApiListener.isNetworkConnectionEnabledResult	(	int	requestId,
		boolean	enabled,
		ApiError	returnCode
	)

Result from the Api.isNetworkConnectionEnabled() function.

Parameters

requestId	- unique Id of the request which initiated closing of the server, If the requestID is MTI_REQUEST_NO_REQUEST_ID, the server was closed by an external source.
returnCode	- ApiError.OK on success

onError()

void de.infoware.android.mti.ApiListener.onError	(	int	requestId,
		String	command,
		ApiError	returnCode
	)

Called if something went wrong during a mti request respectively after returning from the non-blocking request. This error callback is exclusively used for communication related errors. All other errors that might occur will be indicated in the appropriate requests result callback.

Parameters

requestId	- unique Id of the request which caused an error
command	- command of the request that caused the error
returnCode	- error identifier of the type MTI_ERROR ApiError.UNKNOWN_COMMAND - if maptrip received a command that can not be handled ApiError.WRONG_PARAM - if maptrip received a command with non matching parameter list ApiError.UNKNOWN_RESPONSE - if a maptrip message is received which is not known by the client ApiError.COULD_NOT_POST_TO_SERVER - if messages can not be send to the server - re-init the MTI interface ApiError.QUEUE_LIMIT_EXCEEDED - if Messages from MapTrip have queued up greater than the queue size, see Api.setQueueSize()- increase the queue size, activate blocking message passing ( Api.setBlockingMessagePassing() ) or reduce the load of windows messages respectively avoid blocking the message queue in the client application

onErrorWithDescription()

void de.infoware.android.mti.ApiListener.onErrorWithDescription	(	int	requestId,
		String	command,
		String	description,
		ApiError	returnCode
	)

Called if something went wrong during a mti request respectively after returning from the non-blocking request. This error callback is exclusively used for communication related errors. All other errors that might occur will be indicated in the appropriate requests result callback.

Parameters

requestId	- unique Id of the request which caused an error
command	- command of the request that caused the error
returnCode	- error identifier of the type MTI_ERROR ApiError.UNKNOWN_COMMAND - if maptrip received a command that can not be handled ApiError.WRONG_PARAM - if maptrip received a command with non matching parameter list ApiError.UNKNOWN_RESPONSE - if a maptrip message is received which is not known by the client ApiError.COULD_NOT_POST_TO_SERVER - if messages can not be send to the server - re-init the MTI interface ApiError.QUEUE_LIMIT_EXCEEDED - if Messages from MapTrip have queued up greater than the queue size, see Api.setQueueSize()- increase the queue size, activate blocking message passing ( Api.setBlockingMessagePassing() ) or reduce the load of windows messages respectively avoid blocking the message queue in the client application
description	- something more detailed about the error

resetDataUsageMonthlyLimitResult()

void de.infoware.android.mti.ApiListener.resetDataUsageMonthlyLimitResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.resetDataUsageMonthlyLimit() function.

Parameters

requestId	- unique Id of the request which initiated closing of the server, If the requestID is MTI_REQUEST_NO_REQUEST_ID, the server was closed by an external source.
returnCode	- ApiError.OK on success

sendTextResult()

void de.infoware.android.mti.ApiListener.sendTextResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.sendText() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

setDataUsageMonthlyLimitResult()

void de.infoware.android.mti.ApiListener.setDataUsageMonthlyLimitResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.setDataUsageMonthlyLimit() function.

Parameters

requestId	- unique Id of the request which initiated closing of the server, If the requestID is MTI_REQUEST_NO_REQUEST_ID, the server was closed by an external source.
returnCode	- ApiError.OK on success

setSettingsParameter()

void de.infoware.android.mti.ApiListener.setSettingsParameter	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.setSettingsParameter() function

Parameters

requestId

- unique Id of the request which caused an error

returnCode

- error identifier of the type MTI_ERROR ApiError.UNKNOWN_COMMAND - if maptrip received a command that can not be handled ApiError.WRONG_PARAM - if maptrip received a command with non matching parameter list ApiError.UNKNOWN_RESPONSE - if a maptrip message is received which is not known by the client ApiError.COULD_NOT_POST_TO_SERVER - if messages can not be send to the server - re-init the MTI interface ApiError.QUEUE_LIMIT_EXCEEDED - if Messages from MapTrip have queued up greater than the queue size, see Api.setQueueSize()- increase the queue size, activate blocking message passing ( Api.setBlockingMessagePassing() ) or reduce the load of windows messages respectively avoid blocking the message queue in the client application

showAppResult()

void de.infoware.android.mti.ApiListener.showAppResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.showApp() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

showServerResult()

void de.infoware.android.mti.ApiListener.showServerResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.showServer() function.

Parameters

requestId	- unique identifier returned by the initiating request
returnCode	- ApiError.OK on success

stopServerResult()

void de.infoware.android.mti.ApiListener.stopServerResult	(	int	requestId,
		ApiError	returnCode
	)

Result from the Api.stopServer() function.

Parameters

requestId	- unique Id of the request which initiated closing of the server, If the requestID is MTI_REQUEST_NO_REQUEST_ID, the server was closed by an external source.
returnCode	- ApiError.OK on success