com.inrix.sdk

Class TripManager

java.lang.Object

com.inrix.sdk.TripManager

public class TripManager
extends Object

Manages asynchronous interactions with user Trips.

See Also:

SavedTrip, CalendarTrip, LearnedTrip

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TripManager.DeleteTripOptions Contains options to delete saved trips.
static class	TripManager.GetTripsOptions Contains options to get saved trips.
static interface	TripManager.IDeleteTripResponseListener Response listener for deleteTrip.
static interface	TripManager.IGetTripsResponseListener Response listener for getTrips.
static interface	TripManager.ISaveTripResponseListener Response listener for saveTrip.
static interface	TripManager.IUpdateLearnedTripsResponseListener Response listener for updateLearnedTrips.
static interface	TripManager.IUpdateNotificationResponseListener Response listener for updatePreDriveNotification.
static class	TripManager.SaveTripOptions Contains options to save trips.
static class	TripManager.TripManagerException An exception that is thrown when there is an error with a TripManager operation.
static class	TripManager.UpdateLearnedTripsOptions Contains options to update LearnedTrips.
static class	TripManager.UpdateNotificationOptions Contains options to update a pre-drive notification for a specific CalendarTrip.

Method Summary

Methods

Modifier and Type	Method and Description
ICancellable	deleteTrip(TripManager.DeleteTripOptions options, TripManager.IDeleteTripResponseListener listener) Delete a SavedTrip.
ICancellable	getTrips(TripManager.GetTripsOptions options, TripManager.IGetTripsResponseListener listener) Get the SavedTrips that have been saved for the user.
ICancellable	saveTrip(TripManager.SaveTripOptions options, TripManager.ISaveTripResponseListener listener) Save a SavedTrip.
ICancellable	updateLearnedTrips(TripManager.UpdateLearnedTripsOptions options, TripManager.IUpdateLearnedTripsResponseListener listener) Update the user's LearnedTrips.
ICancellable	updatePreDriveNotification(TripManager.UpdateNotificationOptions options, TripManager.IUpdateNotificationResponseListener listener) Update pre-drive notifications for a CalendarTrip.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

saveTrip

public ICancellable saveTrip(TripManager.SaveTripOptions options,
                    TripManager.ISaveTripResponseListener listener)

Save a SavedTrip. This method will create and persist the trip if it does not exist, or persist the trip with changes if it already exists.

Parameters:

options - saveTrip request options, such as the trip to be saved

listener - listener that will receive the response

Returns:

An instance of ICancellable so that the request can be cancelled

Throws:

TripManager.TripManagerException - when either options or listener is null or invalid.

deleteTrip

public ICancellable deleteTrip(TripManager.DeleteTripOptions options,
                      TripManager.IDeleteTripResponseListener listener)

Delete a SavedTrip. This method will delete the trip if it has been previously saved using #saveTrip.

Parameters:

options - deleteTrip request options, such as the trip to be deleted

listener - listener that will receive the response

Returns:

An instance of ICancellable so that the request can be cancelled

Throws:

TripManager.TripManagerException - when either options or listener is null or invalid

getTrips

public ICancellable getTrips(TripManager.GetTripsOptions options,
                    TripManager.IGetTripsResponseListener listener)

Get the SavedTrips that have been saved for the user.

Parameters:

options - options to get trips, parameter is unused and must be null

listener - listener that will receive the response

Returns:

An instance of ICancellable so that the request can be cancelled

Throws:

TripManager.TripManagerException - when listener is null or invalid

updatePreDriveNotification

public ICancellable updatePreDriveNotification(TripManager.UpdateNotificationOptions options,
                                      TripManager.IUpdateNotificationResponseListener listener)

Update pre-drive notifications for a CalendarTrip.

Parameters:

options - options to update notification.

listener - listener that will receive the response.

Returns:

An instance of ICancellable so that the request can be cancelled.

Throws:

TripManager.TripManagerException - when either options or listener is null or invalid.

updateLearnedTrips

public ICancellable updateLearnedTrips(TripManager.UpdateLearnedTripsOptions options,
                              TripManager.IUpdateLearnedTripsResponseListener listener)

Update the user's LearnedTrips.

Parameters:

options - Request options.

listener - Response listener instance.

Returns:

An instance of ICancellable to cancel the request in progress.