com.tomtom.navapp

Interface Debug

public interface Debug

This interface contains the NavApp Debug interface, providing debug methods, including starting/stopping the trip-demo and setting the current location.

Note: Anything in this interface might be unreliable, is not actively tested and is not guaranteed to work in the same way between releases.

In short; used at your own risk.

The implementation is only supplied in Debug builds.

Since:

unreleased

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Debug.CurrentLocationListener Listener callback for the setCurrentLocation and clearCurrentLocation interface.
static class	Debug.CurrentLocationResult Result codes for setting/clearing the current location see Debug.CurrentLocationListener.
static interface	Debug.InstructionListener Listener to receive instructions about the Active Trip.
static interface	Debug.TripDemoListener Listener callback for the trip demo interfaces.
static class	Debug.TripDemoResult Result codes for starting/stopping the trip demo see Debug.TripDemoListener.

Method Summary

Modifier and Type	Method and Description
void	clearCurrentLocation(Debug.CurrentLocationListener listener) Clear the current location and start using the GPS location instead (or any of the GPS fallbacks, see LocationManager).
void	registerInstructionListener(Debug.InstructionListener listener) Register a InstructionListener.
void	setCurrentLocation(Routeable location, Debug.CurrentLocationListener listener) Set the current location to any location on the active map.
void	startTripDemo(short speed, boolean disableMessage, Debug.TripDemoListener listener) Start the trip demo.
void	stopTripDemo(Debug.TripDemoListener listener) Stop the trip demo.
void	unregisterInstructionListener(Debug.InstructionListener listener) Unregister a InstructionListener.

Method Detail

setCurrentLocation

void setCurrentLocation(Routeable location,
                        Debug.CurrentLocationListener listener)

Set the current location to any location on the active map. The passed in listener is only active until the result of the call has been returned. Once a result has been returned the listener won't receive any more callbacks (but can be re-used).

Parameters:

location - The Routeable location to set.

listener - The Debug.CurrentLocationListener to receive the result of the call.

Since:

unreleased

clearCurrentLocation

void clearCurrentLocation(Debug.CurrentLocationListener listener)

Clear the current location and start using the GPS location instead (or any of the GPS fallbacks, see LocationManager). The passed in listener is only active until the result of the call has been returned. Once a result has been returned the listener won't receive any more callbacks (but can be re-used).

Parameters:

listener - The Debug.CurrentLocationListener to receive the result of the call.

Since:

unreleased

startTripDemo

void startTripDemo(short speed,
                   boolean disableMessage,
                   Debug.TripDemoListener listener)

Start the trip demo. The passed in listener is only active until the result of the call has been returned. Once a result has been returned the listener won't receive any more callbacks (but can be re-used).

Parameters:

speed - Speed in percentage (100-300), any values outside these are remapped to fit (100-300).

disableMessage - Disables the preview message.

listener - The Debug.TripDemoListener

Since:

unreleased

stopTripDemo

void stopTripDemo(Debug.TripDemoListener listener)

Stop the trip demo. The passed in listener is only active until the result of the call has been returned. Once a result has been returned the listener won't receive any more callbacks (but can be re-used).

Parameters:

listener - The Debug.TripDemoListener

Since:

unreleased

registerInstructionListener

void registerInstructionListener(Debug.InstructionListener listener)

Register a InstructionListener.

Parameters:

listener - Debug.InstructionListener to receive instructions for the active trip.

Throws:

java.lang.IllegalArgumentException - if the listener is null.

Since:

unreleased

unregisterInstructionListener

void unregisterInstructionListener(Debug.InstructionListener listener)

Unregister a InstructionListener.

Parameters:

listener - Debug.InstructionListener to receive instructions for the active trip.

Throws:

java.lang.IllegalArgumentException - if the listener is null or previously not registered.

Since:

unreleased