com.inrix.sdk.model

Class PreDriveNotification

java.lang.Object

com.inrix.sdk.model.PreDriveNotification

All Implemented Interfaces:

IPushNotification

public class PreDriveNotification
extends Object
implements IPushNotification

Represents pre drive notification.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PreDriveNotification.NotificationSource PreDriveNotification.NotificationSource indicates the source of the PreDriveNotification.

Nested classes/interfaces inherited from interface com.inrix.sdk.push.IPushNotification

IPushNotification.PushNotificationType

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TEMPLATE_ID Normal Template.
static String	ROAD_CLOSURE_TEMPLATE_ID Road Closure Template.

Constructor Summary

Constructors

Constructor and Description
PreDriveNotification()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDestinationName() Gets the name of the destination.
Integer	getFuelLevel() Gets fuel level, in percent (of PreDriveNotification.getFuelTankCapacity()).
Integer	getFuelTankCapacity() Gets fuel tank capacity, in gallons.
int	getLeaveInMinutes() Gets the number of minutes before the leave times.
Route	getRoute() Gets the route.
int	getRouteQuality() Gets the quality of the route, typically scaled from 0 (most congested) to 3 (least congested).
PreDriveNotification.NotificationSource	getSource() Gets the source of the push notification.
String	getTemplateId() Gets the push notification template id.
int	getTravelTimeMinutes() Gets the currently calculated travel time in minutes.
IPushNotification.PushNotificationType	getType() Gets the push notification type.
boolean	hasRoadClosures() Gets whether there are road closures along the route to the destination.
Boolean	isLowFuel() Gets whether the user's vehicle is low on fuel.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TEMPLATE_ID

public static final String DEFAULT_TEMPLATE_ID

Normal Template.

See Also:

Constant Field Values

ROAD_CLOSURE_TEMPLATE_ID

public static final String ROAD_CLOSURE_TEMPLATE_ID

Road Closure Template.

See Also:

Constant Field Values

Constructor Detail

PreDriveNotification

public PreDriveNotification()

Method Detail

getDestinationName

public String getDestinationName()

Gets the name of the destination.

Returns:

Name of the destination; null if information is not available.

getLeaveInMinutes

public int getLeaveInMinutes()

Gets the number of minutes before the leave times.

Returns:

Number of minutes; null if information is not available.

getTravelTimeMinutes

public int getTravelTimeMinutes()

Gets the currently calculated travel time in minutes.

If there are any road closures on the route, this value will be -1.

Returns:

The currently calculated travel time, or -1 if there is a road closure.

getRouteQuality

public int getRouteQuality()

Gets the quality of the route, typically scaled from 0 (most congested) to 3 (least congested).

The following table describes the route quality values:

Value	Description	Travel Time
0	Stop and go	Greater than 175% of free flow traffic time.
1	Heavy	Between 150% and 175% of free flow traffic time.
2	Moderate	Between 125% and 150% of free flow traffic time.
3	Free flow	Less than 125% of free flow traffic time.
255	Closed	Route is unusable due to a closure or restriction on the route.

Returns:

The status ID.

hasRoadClosures

public boolean hasRoadClosures()

Gets whether there are road closures along the route to the destination.

Returns:

true if the route has road closures, false otherwise.

getRoute

public Route getRoute()

Gets the route. The returned Route will not contain any details until it is updated using RouteManager.getUpdatedRouteInfo(RouteManager.UpdatedRouteOptions, RouteManager.IUpdatedRouteListener).

Returns:

The route.

getType

public IPushNotification.PushNotificationType getType()

Gets the push notification type.

Specified by:

getType in interface IPushNotification

Returns:

The push notification type.

getSource

public PreDriveNotification.NotificationSource getSource()

Gets the source of the push notification. Value is PreDriveNotification.NotificationSource.UNKNOWN if the source cannot be determined.

Returns:

The source of the push notification.

getTemplateId

public String getTemplateId()

Gets the push notification template id.

Returns:

The push notification template id.

isLowFuel

public Boolean isLowFuel()

Gets whether the user's vehicle is low on fuel.

Returns:

true if the vehicle is low on fuel, false if the vehicle is not and null if fuel information is not available for this user.

getFuelTankCapacity

public Integer getFuelTankCapacity()

Gets fuel tank capacity, in gallons.

Returns:

Fuel tank capacity if available, null otherwise.

See Also:

PreDriveNotification.isLowFuel()

getFuelLevel

public Integer getFuelLevel()

Gets fuel level, in percent (of PreDriveNotification.getFuelTankCapacity()).

Returns:

Fuel level if available, null otherwise.

See Also:

PreDriveNotification.isLowFuel()