Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TaskTrackingInfo

The details for a task tracking info object returned by Fleet Engine.

Hierarchy

  • TaskTrackingInfo

Index

Properties

Properties

attributes

attributes: {}

Attributes assigned to the task.

Type declaration

  • [key: string]: unknown

estimatedArrivalTime

estimatedArrivalTime: null | Date

The estimated arrival time to the stop location.

estimatedTaskCompletionTime

estimatedTaskCompletionTime: null | Date

The estimated completion time of a Task.

latestVehicleLocationUpdate

latestVehicleLocationUpdate: null | VehicleLocationUpdate

Information specific to the last location update.

name

name: string

The name in the format "providers/{provider_id}/taskTrackingInfo/{tracking_id}", where tracking_id represents the tracking ID.

plannedLocation

plannedLocation: null | LatLng

The location where the Task will be completed.

remainingDrivingDistanceMeters

remainingDrivingDistanceMeters: null | number

The total remaining distance in meters to the VehicleStop of interest.

remainingStopCount

remainingStopCount: null | number

Indicates the number of stops the vehicle remaining until the task stop is reached, including the task stop. For example, if the vehicle's next stop is the task stop, the value will be 1.

routePolylinePoints

routePolylinePoints: null | LatLng[]

A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.

state

state: null | string

The current execution state of the Task.

targetTimeWindow

targetTimeWindow: null | TimeWindow

The time window during which the task should be completed.

taskOutcome

taskOutcome: null | string

The outcome of attempting to execute a Task.

taskOutcomeTime

taskOutcomeTime: null | Date

The time when the Task's outcome was set by the provider.

trackingId

trackingId: string

The tracking ID of a Task.

  • Must be a valid Unicode string.
  • Limited to a maximum length of 64 characters.

  • Normalized according to Unicode Normalization Form C.
  • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.

Generated using TypeDoc