DeliveryDriverApi

public final class DeliveryDriverApi extends DriverApi

Entry point into the DriverApi for the deliveries vertical.

Public Method Summary

synchronized static void
clearInstance()
Cleans up instance of the DeliveryDriverApi before all references to it are destroyed.
static DeliveryDriverApi
createInstance(DriverContext driverContext)
Creates a DeliveryDriverApi singleton instance.
DeliveryTaskManager
getDeliveryTaskManager()
Returns an instance of the DeliveryTaskManager, which enables creation, modification, and fetching of DeliveryTasks.
DeliveryVehicleManager
getDeliveryVehicleManager()
Returns an instance of the DeliveryVehicleManager, which enables creation, modification, and fetching of the DeliveryVehicle for the initialized vehicle id.
DeliveryVehicleReporter
getDeliveryVehicleReporter()
Returns an instance of the DeliveryVehicleReporter, which reports vehicle information to FleetEngine.
static String
getDriverSdkVersion()
Returns the current Driver SDK version.
static DeliveryDriverApi
getInstance()
Returns the DeliveryDriverApi singleton.

Inherited Method Summary

Public Methods

public static synchronized void clearInstance ()

Cleans up instance of the DeliveryDriverApi before all references to it are destroyed. It is the responsibility of the caller to ensure that all such references have been removed.

Objects previously derived from this instance of DeliveryDriverApi should no longer be used.

public static DeliveryDriverApi createInstance (DriverContext driverContext)

Creates a DeliveryDriverApi singleton instance.

Throws
IllegalStateException if a DeliveryDriverApi instance already exists.
NullPointerException if DriverContext is null.

public DeliveryTaskManager getDeliveryTaskManager ()

Returns an instance of the DeliveryTaskManager, which enables creation, modification, and fetching of DeliveryTasks.

public DeliveryVehicleManager getDeliveryVehicleManager ()

Returns an instance of the DeliveryVehicleManager, which enables creation, modification, and fetching of the DeliveryVehicle for the initialized vehicle id.

public DeliveryVehicleReporter getDeliveryVehicleReporter ()

Returns an instance of the DeliveryVehicleReporter, which reports vehicle information to FleetEngine.

public static String getDriverSdkVersion ()

Returns the current Driver SDK version.

public static DeliveryDriverApi getInstance ()

Returns the DeliveryDriverApi singleton. createInstance() must be called prior to getInstance(), otherwise null will be returned.