API Reference¶
The Dokka HTML API reference is generated from KDoc comments in the SDK source and is populated at build time.
To view the API reference locally:
In the release bundle (roadsavesdk-4.0.0.zip), the API reference is pre-built at docs/index.html.
On the web (after CI publishes): the full API reference is available under /android/api/ at docs.roadsave.co.za.
Public API surface¶
The following classes and interfaces form the public API of the RoadSave SDK 4.0.0:
| Type | Description |
|---|---|
RoadSave |
Primary SDK entry point |
RoadSaveConfiguration |
SDK configuration: app ID, user ID, detection options |
RoadSaveListener |
Callback interface for all SDK events |
CrashInfo |
Data class for a detected crash event |
TripInfo |
Data class for a completed trip |
TripStartInfo |
Data class for a trip start event |
CurrentTripInfo |
Live trip data delivered during monitoring updates |
RoadSaveLocation |
SDK-specific location wrapper |
CrashConfidence |
Enum: HIGH / LOW / UNKNOWN crash confidence |
CrashFalsePositiveReason |
Constants for false-positive dismissal reasons |
ErrorCode |
Integer error code constants |
RoadSaveBroadcastConstants |
Broadcast action strings and extra key constants |