com.inrix.sdk

Class IncidentAlert

java.lang.Object

com.inrix.sdk.IncidentAlert

All Implemented Interfaces:

ICancellable, IDataResponseListener<List<Incident>>, IncidentsManager.IIncidentsResponseListener

public class IncidentAlert
extends Object
implements ICancellable, IncidentsManager.IIncidentsResponseListener

Represents an alert message that is delivered when an incident happens that is expected to affect the user.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the alert.
double	getLastRequestedDistance() Returns the last requested distance.
void	onError(Error error) Called when there is an error.
void	onResult(List<Incident> data) Called when there is an alert.
void	start() The alert starts automatically when the alert instance is created.

Methods inherited from class java.lang.Object

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

Method Detail

cancel

public void cancel()

Cancels the alert.

Specified by:

cancel in interface ICancellable

start

public void start()

The alert starts automatically when the alert instance is created. This method can be used to start the alert after IncidentAlert.cancel().

onResult

public void onResult(List<Incident> data)

Called when there is an alert.

Specified by:

onResult in interface IDataResponseListener<List<Incident>>

Parameters:

data - The list of alerts.

onError

public void onError(Error error)

Called when there is an error.

Specified by:

onError in interface IDataResponseListener<List<Incident>>

Parameters:

error - The error.

getLastRequestedDistance

public double getLastRequestedDistance()

Returns the last requested distance.

This value may vary based on the speed at the moment of request.

Returns:

The last requested distance

See Also:

AlertsManager.AlertOptionsBase.setSpeedFactor(float)