Package es.situm.sdk.navigation

Class NavigationRequest

java.lang.Object

es.situm.sdk.navigation.NavigationRequest

All Implemented Interfaces:

MapperInterface

public class NavigationRequest
extends Object
implements MapperInterface

Holds NavigationManager request parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NavigationRequest.Builder	NavigationState builder static inner class.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_DISTANCE_CHANGE_FLOOR
static final double	DEFAULT_DISTANCE_THRESHOLD
static final double	DEFAULT_DISTANCE_TO_CHANGE_INDICATION
static final double	DEFAULT_DISTANCE_TO_IGNORE_FIRST_INDICATION
static final boolean	DEFAULT_IGNORE_LOW_QUALITY_LOCATIONS
static final long	DEFAULT_INDICATIONS_INTERVAL
static final int	DEFAULT_ROUND_INDICATION_STEP
static final long	DEFAULT_TIME_TO_FIRST_INDICATION
static final int	DEFAULT_TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES

Fields inherited from interface es.situm.sdk.model.MapperInterface

ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, ASSET_TRACKING_OPTIONS_BEACON_FILTERS, ASSET_TRACKING_OPTIONS_ENABLED, ASSET_TRACKING_OPTIONS_ITERATIONS_TO_UPLOAD, ASSET_TRACKING_OPTIONS_SCANNING_INTERVAL, BEACON_FILTER_UUID, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIAGNOSTICS_OPTIONS_UPLOAD_DIAGNOSTICS_DATA, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, DURATION_MINUTES, EDGES, EVENTS, EXCLUDED_TAGS, EXTERNAL_NAVIGATION_PAYLOAD, EXTERNAL_NAVIGATION_TYPE, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TAP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, REALTIME_UPDATE_INTERVAL, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static NavigationRequest	fromMap(Map<String,Object> map)	Return a new NavigationRequest instance object containing the data at the given map.
double	getDistanceToChangeFloorThreshold()
double	getDistanceToChangeIndicationThreshold()
double	getDistanceToGoalThreshold()
double	getDistanceToIgnoreFirstIndication()
long	getIndicationsInterval()
double	getOutsideRouteThreshold()
int	getRoundIndicationsStep()
Route	getRoute()
long	getTimeToFirstIndication()
int	getTimeToIgnoreLocationInWrongFloorDuringFloorChange()
int	hashCode()
boolean	ignoreLowQualityLocations()
void	setRoute(Route route)	Sets the Route whose progress is going to be updated.
Map<String,Object>	toMap()	Method to transform object into Map<String, Object>
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_DISTANCE_THRESHOLD

public static final double DEFAULT_DISTANCE_THRESHOLD

See Also:

• Constant Field Values

DEFAULT_DISTANCE_TO_IGNORE_FIRST_INDICATION

public static final double DEFAULT_DISTANCE_TO_IGNORE_FIRST_INDICATION

See Also:

• Constant Field Values

DEFAULT_DISTANCE_CHANGE_FLOOR

public static final double DEFAULT_DISTANCE_CHANGE_FLOOR

See Also:

• Constant Field Values

DEFAULT_DISTANCE_TO_CHANGE_INDICATION

public static final double DEFAULT_DISTANCE_TO_CHANGE_INDICATION

See Also:

• Constant Field Values

DEFAULT_INDICATIONS_INTERVAL

public static final long DEFAULT_INDICATIONS_INTERVAL

See Also:

• Constant Field Values

DEFAULT_TIME_TO_FIRST_INDICATION

public static final long DEFAULT_TIME_TO_FIRST_INDICATION

See Also:

• Constant Field Values

DEFAULT_ROUND_INDICATION_STEP

public static final int DEFAULT_ROUND_INDICATION_STEP

See Also:

• Constant Field Values

DEFAULT_TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES

public static final int DEFAULT_TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES

See Also:

• Constant Field Values

DEFAULT_IGNORE_LOW_QUALITY_LOCATIONS

public static final boolean DEFAULT_IGNORE_LOW_QUALITY_LOCATIONS

See Also:

• Constant Field Values

Method Details

getRoute

public Route getRoute()

setRoute

public void setRoute(Route route)

Sets the Route whose progress is going to be updated.

Parameters:

route - the route to set.

getDistanceToGoalThreshold

@FloatRange(from=0.0)
public double getDistanceToGoalThreshold()

getOutsideRouteThreshold

@FloatRange(from=0.0)
public double getOutsideRouteThreshold()

getDistanceToIgnoreFirstIndication

@FloatRange(from=0.0)
public double getDistanceToIgnoreFirstIndication()

getDistanceToChangeFloorThreshold

@FloatRange(from=0.0)
public double getDistanceToChangeFloorThreshold()

getDistanceToChangeIndicationThreshold

@FloatRange(from=0.0)
public double getDistanceToChangeIndicationThreshold()

getIndicationsInterval

@IntRange(from=0L)
public long getIndicationsInterval()

getTimeToFirstIndication

@IntRange(from=0L)
public long getTimeToFirstIndication()

getRoundIndicationsStep

@IntRange(from=0L)
public int getRoundIndicationsStep()

getTimeToIgnoreLocationInWrongFloorDuringFloorChange

@IntRange(from=0L)
public int getTimeToIgnoreLocationInWrongFloorDuringFloorChange()

ignoreLowQualityLocations

public boolean ignoreLowQualityLocations()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toMap

public Map<String,Object> toMap()

Description copied from interface: MapperInterface

Method to transform object into Map<String, Object>

Specified by:

toMap in interface MapperInterface

Returns:

Map<String, Object> with the information of the object mapped

fromMap

public static NavigationRequest fromMap(Map<String,Object> map)
                                 throws IllegalArgumentException

Return a new NavigationRequest instance object containing the data at the given map. Use MapperInterface to populate the Map. The expected fields are those defined at NavigationRequest.Builder. MapperInterface.ROUTE will be ignored and must be set using setRoute(Route).

Parameters:

map - Map containing the data used to populate the new object.

Returns:

New instance.

Throws:

IllegalArgumentException - If there is not enough information at the given map or it is incorrect.