AI-generated Key Takeaways
-
This document provides detailed reference information for data classes, interfaces, and enums utilized within the Driver SDK.
-
The data structures define key elements such as tasks, vehicles, and stops, outlining their properties and states for driver interactions.
-
Interfaces enable communication and control, including authentication token management and driver status updates.
-
Enums offer categorized options for driver status codes and severity levels to enhance communication within the SDK.
-
Developers can leverage this documentation to understand and implement functionalities like managing tasks, handling vehicle information, and integrating authentication flows within their applications.
Annotations
| Task.TaskOutcome | The outcome of an attempt to execute a task. |
| Task.TaskState | The state of a Task indicating its progression. |
| Task.TaskType | The type of a Task. |
| VehicleStop.VehicleStopState | The current state of a VehicleStop. |
Interfaces
| AuthTokenContext.AuthTokenFactory | Instances of this interface will be asked to provide an authorization token when various operations are performed. |
| DriverContext.DriverStatusListener | Listener for status updates with the capability of getting the cause of an error log. |
Classes
| AuthTokenContext | The AuthTokenContext class encapsulates the state needed to generate an auth token for a given request and is provided when AuthTokenFactory#getToken is called. |
| AuthTokenContext.Builder | Builder for AuthTokenContext. |
| BaseVehicle | Base representation of a vehicle. |
| DriverContext | DriverContext provides the dependencies needed to construct a DriverApi instance. |
| DriverContext.Builder | Builder for DriverContext. |
| Task | A task represents a single action to track in the Last Mile Fleet Solution system. |
| TaskInfo | Describes a task that the driver will perform. |
| TaskInfo.Builder | Builder class for TaskInfo |
| VehicleStop | Describes a stop that the vehicle will be visiting. |
| VehicleStop.Builder | Builder class for VehicleStop. |
Enums
| DriverContext.DriverStatusListener.StatusCode | The status codes of the status update. |
| DriverContext.DriverStatusListener.StatusLevel | The severity levels of the status update. |