Options
All
  • Public
  • Public/Protected
  • All
Menu

Delivery Vehicle Location Provider.

Access by calling const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing"). See https://developers.google.com/maps/documentation/javascript/libraries.

Hierarchy

Index

Constructors

Properties

deliveryVehicleId: string

ID for the vehicle that this location provider observes. Set this field to track a vehicle.

isPolling: boolean

True if this location provider is polling. Read only.

pollingIntervalMillis: number

Minimum time between fetching location updates in milliseconds. If it takes longer than pollingIntervalMillis to fetch a location update, the next location update is not started until the current one finishes.

Setting this value to 0, Infinity, or a negative value disables automatic location updates. A new location update is fetched once if the tracking ID parameter (for example, the shipment tracking ID of the shipment location provider), or a filtering option (for example, viewport bounds or attribute filters for fleet location providers) changes.

The default, and minimum, polling interval is 5000 milliseconds. If you set the polling interval to a lower positive value, 5000 is stored and used.

shouldShowOutcomeLocations: null | boolean

Optionally allow users to display the task's outcome location.

shouldShowTasks: null | boolean

Optionally allow users to display fetched tasks.

staleLocationThresholdMillis: number

This Field is read-only. Threshold for stale vehicle location. If the last updated location for the vehicle is older than this threshold, the vehicle will not be displayed.

taskFilterOptions: FleetEngineTaskFilterOptions

Returns the filter options to apply when fetching tasks.

Methods

Generated using TypeDoc