com.tomtom.navapp

Interface TripEventManager

public interface TripEventManager

NavApp TripEventManager interface. This allows client to add different events to the currently active Trip, these events will be displayed alongside other events (e.g. traffic incidents, or speed-cameras) in the routebar. If the Trip at any point becomes invalid (e.g. cancelled, or on a trip arrival) all the registered events will be removed, as soon as an event has been passed it is also removed. To be informed of when the events are removed register a TripEvent.Listener with the registerTripEventListener API.

Note: This interface (and any containing interfaces) is still in beta and might be subject to change.

Since:

1

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvent(int offset, int length, org.json.JSONObject attributes, TripEvent.ModifyListener listener) Add a new TripEvent with the specified parameters.
void	getAllEvents(TripEvent.ListListener listener) Request a list of all the currently registered events.
void	modifyEvent(TripEvent event, int offset, int length, org.json.JSONObject attributes, TripEvent.ModifyListener listener) Modify an existing event.
void	registerTripEventListener(TripEvent.Listener listener) Register a TripEvent.Listener, to receive information when a TripEvent has been removed.
void	removeAllEvents(TripEvent.ModifyListener listener) Remove all currently registered events from the trip.
void	removeEvent(TripEvent event, TripEvent.ModifyListener listener) Remove the specified event.
void	unregisterTripEventListener(TripEvent.Listener listener) Unregister a TripEvent.Listener.

Method Detail

registerTripEventListener

void registerTripEventListener(TripEvent.Listener listener)

Register a TripEvent.Listener, to receive information when a TripEvent has been removed.

Parameters:

listener - TripEvent.Listener to receive information about the TripEvent objects.

Since:

1

unregisterTripEventListener

void unregisterTripEventListener(TripEvent.Listener listener)

Unregister a TripEvent.Listener.

Parameters:

listener - The TripEvent.Listener to unregister.

Throws:

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

Since:

1

addEvent

void addEvent(int offset,
            int length,
            org.json.JSONObject attributes,
            TripEvent.ModifyListener listener)

Add a new TripEvent with the specified parameters. 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:

offset - The offset for the event in meters. The offset is calculated from the start of the Trip until the start of the event.

length - The length for the event in meters.

attributes - The attributes of the event (see TripEvent for options).

listener - TripEvent.ModifyListener to receive the result of the operation.

Since:

1

modifyEvent

void modifyEvent(TripEvent event,
               int offset,
               int length,
               org.json.JSONObject attributes,
               TripEvent.ModifyListener listener)

Modify an existing event. 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:

event - The TripEvent to modify.

offset - The offset for the event in meters. The offset is calculated from the start of the Trip until the start of the event.

length - The length for the event in meters.

attributes - The attributes of the event (see TripEvent for options).

listener - TripEvent.ModifyListener to receive the result of the operation.

Since:

1

removeEvent

void removeEvent(TripEvent event,
               TripEvent.ModifyListener listener)

Remove the specified event. 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:

event - The TripEvent to remove.

listener - TripEvent.ModifyListener to receive the result of the operation.

Since:

1

getAllEvents

void getAllEvents(TripEvent.ListListener listener)

Request a list of all the currently registered events. 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 - TripEvent.ListListener to receive the result of the operation.

Since:

1

removeAllEvents

void removeAllEvents(TripEvent.ModifyListener listener)

Remove all currently registered events from the trip. 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 - TripEvent.ModifyListener to receive the result of the operation.

Since:

1