-
- All Implemented Interfaces:
public class RouteEvent extends ApplicationEventRouteEvent Schema model object.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumRouteEvent.RouteDisplayScreenTypepublic enumRouteEvent.FirstTimeTypepublic classRouteEvent.Builder
-
Method Summary
Modifier and Type Method Description ObjectgetTrigger()Required .. ObjectgetType()Applicable for auto.Whether route was personalized, fastest, etc. StringgetTrafficFlowVendor()Traffic Flow Vendor Name. StringgetTrafficIncidentVendor()Traffic Incident Vendor Name. DoublegetOriginLat()Required .. DoublegetOriginLon()Required .. DoublegetDestLat()Required .. DoublegetDestLon()Required .. StringgetEntityId()Required .. DoublegetEntityLat()Required .. DoublegetEntityLon()Required .. StringgetIId()Impression ID of the chosen destination POI from SRP or Coupon page. StringgetMerchantId()Merchant ID of the coupon if route was calculated for a coupon selection. DoublegetDistance()Required .. DoublegetEta()Required .. DoublegetEtaStatic()Required .. DoublegetEtaDynamic()Required .. ObjectgetShareEta()Required .. DoublegetNumberOfIncidents()Required .. DoublegetRoutePosition()Required .. ObjectgetDestType()Required .. StringgetSearchId()The LogID of the Search that resulted in the Route Calculation if the caused by a Search StringgetCouponDetailId()The LogID of the CouponDetails selection that resulted in the Route Calculation if caused by Coupon select StringgetParentSearchId()LogID of the original Search for the trip. StringgetRouteId()The RouteID of the immediate parent. StringgetParentRouteId()Required .. StringgetEdgeId()Edge id at the point deviation occurred when trigger is deviation. ObjectgetCausedBy()If the trigger is deviation, then the reason for deviation. RouteModeTypegetMode()Whether routing for automobile or pedestrian. ObjectgetSource()States the connection type whether it is onboard or cloud connection. DoublegetResponseTime()Required .. StringgetNavId()LogID of corresponding NavStart event, Required only when trigger is Deviation or Waypoint InteractionMethodValuegetInteractionMethod()for each user interaction log the interaction method RouteEvent.FirstTimeTypegetFirstTime()Marks the first time this combination of values for the properties event_label, event_environment and page_title is fired for a user ObjectgetEventEnvironmentValue()To identify if event happened on the mobile app or when connected to Car Play or if the app is on a memory stick or directly on a head unit. StringgetEventLabel()The label of the button or the icon interacted with EventTypegetEventType()Get RouteEvent's EventType static RouteEvent.Builderbuilder()-
Methods inherited from class com.telenav.sdk.datacollector.model.event.ApplicationEvent
getEventData -
Methods inherited from class com.telenav.sdk.datacollector.model.event.Event
getFormatType, getLogContext -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getTrigger
Object getTrigger()
Required .. The purpose of the Route calculation depending on what action triggered it. If a drive was paused and resumed later by clicking on Resume Route, trigger would be ResumeRoute. Calculation of route to original destination from Waypoint-ResumeFromWP. If user manually alters a step in the Navigation direction Listing by adding a detour, log as Detour
-
getTrafficFlowVendor
String getTrafficFlowVendor()
Traffic Flow Vendor Name.
-
getTrafficIncidentVendor
String getTrafficIncidentVendor()
Traffic Incident Vendor Name.
-
getOriginLat
Double getOriginLat()
Required .. Latitude of origin.
-
getOriginLon
Double getOriginLon()
Required .. Longitude of origin.
-
getDestLat
Double getDestLat()
Required .. Latitude of destination.
-
getDestLon
Double getDestLon()
Required .. Longitude of destination.
-
getEntityId
String getEntityId()
Required .. Entity ID of the destination that was chosen
-
getEntityLat
Double getEntityLat()
Required .. Latitude of entity.
-
getEntityLon
Double getEntityLon()
Required .. Longitude of entity.
-
getMerchantId
String getMerchantId()
Merchant ID of the coupon if route was calculated for a coupon selection.
-
getDistance
Double getDistance()
Required .. Calculated distance to destination for the specific route in miles.
-
getEtaStatic
Double getEtaStatic()
Required .. Estimated time in minutes to arrive at the destination.
-
getEtaDynamic
Double getEtaDynamic()
Required .. Estimated time in minutes to arrive at the destination
-
getShareEta
Object getShareEta()
Required .. Route setting for whether ETA is shared or not.
-
getNumberOfIncidents
Double getNumberOfIncidents()
Required .. The number of traffic incidents displayed on the route.
-
getRoutePosition
Double getRoutePosition()
Required .. When multiple routes are displayed for a destination, the position of the route displayed on the screen. 1 would be the leftmost route on the screen.
-
getDestType
Object getDestType()
Required .. Type of destination on how the route calculation was initiated
-
getSearchId
String getSearchId()
The LogID of the Search that resulted in the Route Calculation if the caused by a Search
-
getCouponDetailId
String getCouponDetailId()
The LogID of the CouponDetails selection that resulted in the Route Calculation if caused by Coupon select
-
getParentSearchId
String getParentSearchId()
LogID of the original Search for the trip. This would be different from SearchID when a Search is initiated with intent as Waypoint.
-
getRouteId
String getRouteId()
The RouteID of the immediate parent. For example, for a route with trigger=deviation, the route_id field should have the RouteID of the segment within which the deviation occurred.
-
getParentRouteId
String getParentRouteId()
Required .. RouteID of the original trip.If the intent of the route was RouteRequest,the ParentRouteID would be same as RouteID. If trigger is any other, then RouteID of the first RouteCalculation in the trip
-
getCausedBy
Object getCausedBy()
If the trigger is deviation, then the reason for deviation.
-
getMode
RouteModeType getMode()
Whether routing for automobile or pedestrian.
-
getResponseTime
Double getResponseTime()
Required .. Response time to each request in milliseconds
-
getNavId
String getNavId()
LogID of corresponding NavStart event, Required only when trigger is Deviation or Waypoint
-
getInteractionMethod
InteractionMethodValue getInteractionMethod()
for each user interaction log the interaction method
-
getFirstTime
RouteEvent.FirstTimeType getFirstTime()
Marks the first time this combination of values for the properties event_label, event_environment and page_title is fired for a user
-
getEventEnvironmentValue
Object getEventEnvironmentValue()
To identify if event happened on the mobile app or when connected to Car Play or if the app is on a memory stick or directly on a head unit.
-
getEventLabel
String getEventLabel()
The label of the button or the icon interacted with
-
getEventType
EventType getEventType()
Get RouteEvent's EventType
-
builder
static RouteEvent.Builder builder()
-
-
-
-