Package 

Class RouteEvent

  • All Implemented Interfaces:

    
    public class RouteEvent
    extends ApplicationEvent
                        

    RouteEvent Schema model object.

    • Constructor Detail

    • 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

      • getType

         Object getType()

        Applicable for auto.Whether route was personalized, fastest, etc.

      • getEntityId

         String getEntityId()

        Required .. Entity ID of the destination that was chosen

      • getIId

         String getIId()

        Impression ID of the chosen destination POI from SRP or Coupon page.

      • 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.

      • getEta

         Double getEta()

        Required .. Estimated time in minutes to arrive at the destination.

      • 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.

      • 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

      • getEdgeId

         String getEdgeId()

        Edge id at the point deviation occurred when trigger is deviation.

      • getCausedBy

         Object getCausedBy()

        If the trigger is deviation, then the reason for deviation.

      • getSource

         Object getSource()

        States the connection type whether it is onboard or cloud connection.

      • getNavId

         String getNavId()

        LogID of corresponding NavStart event, Required only when trigger is Deviation or Waypoint

      • 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.