Class PickMapContentResult.TrafficIncidentResult

java.lang.Object
com.here.NativeBase
com.here.sdk.mapview.PickMapContentResult.TrafficIncidentResult
All Implemented Interfaces:
TrafficIncidentBase
Enclosing class:
PickMapContentResult

public static final class PickMapContentResult.TrafficIncidentResult extends NativeBase implements TrafficIncidentBase

Carries the result of picking a Carto traffic incident object. Description of incident is currently not present in our map data, so TrafficIncidentBase.getDescription() always returns an empty string.

  • Method Details

    • getOriginalId

      @NonNull public String getOriginalId()

      Gets the unique traffic event ID.

      Can be referenced when checking for updated traffic information for the specified event.

      Returns:

      Unique traffic event ID.

    • getCoordinates

      @NonNull public GeoCoordinates getCoordinates()

      Gets the geographic coordinates of the traffic incident.

      Returns:

      The geographic coordinates of the traffic incident.

    • getImpact

      @NonNull public TrafficIncidentImpact getImpact()

      Gets the impact of the incident.

      The value is TrafficIncidentImpact.UNKNOWN if it hasn't been provided by the traffic incidents supplier.

      Specified by:
      getImpact in interface TrafficIncidentBase
      Returns:

      The impact of the incident.

    • getType

      @NonNull public TrafficIncidentType getType()

      Gets the category of the incident.

      The value is TrafficIncidentType.UNKNOWN if it hasn't been provided by the traffic incidents supplier.

      Specified by:
      getType in interface TrafficIncidentBase
      Returns:

      The category of the incident.

    • getDescription

      @NonNull public LocalizedText getDescription()

      Gets the human readable description of the incident, possibly with location information.

      The description is currently not present in our map data. Therefore, when accessing the data from a picked carto POI via TrafficIncidentResult, then always an empty string is returned. This does not apply when using the TrafficEngine.

      Specified by:
      getDescription in interface TrafficIncidentBase
      Returns:

      The human readable description of the incident, possibly with location information.

    • getStartTime

      @Nullable public Date getStartTime()

      Gets the time from which the incident is valid, before this time the incident should not be considered.

      The value is null if it hasn't been provided by the traffic incidents supplier.

      Specified by:
      getStartTime in interface TrafficIncidentBase
      Returns:

      The time from which the incident is valid, before this time the incident should not be considered.

    • getEndTime

      @Nullable public Date getEndTime()

      Get the time until which the incident is valid, after this time the incident should not be considered.

      The value is null if it hasn't been provided by the traffic incidents supplier.

      Specified by:
      getEndTime in interface TrafficIncidentBase
      Returns:

      The time until which the incident is valid, after this time the incident should not be considered.