sdk/com.fairmatic.sdk.classes/EstimatedDriveInfo

EstimatedDriveInfo

Information about a drive recorded by the Fairmatic SDK. The drive may have started manually by the application or due to Fairmatic auto drive detection. This is available with FairmaticBroadcastReceiver.onDriveEnd callback.

When FairmaticDriveType is not equal to FairmaticDriveType.INVALID, the info provided in this object will be superceded by AnalyzedDriveInfo provided via the com.fairmatic.sdk.classes.FairmaticBroadcastReceiver.onDriveAnalyzed callback for the same DriveInfo.driveId. The application should save the info provided here and update it when the com.fairmatic.sdk.classes.FairmaticBroadcastReceiver.onDriveAnalyzed callback is invoked.

Inherited properties

averageSpeed

var averageSpeed: Double

The average speed of the drive in meters per second. If we could not estimate the average speed due to lack of reliable location data, this value will be -1.

distanceMeters

var distanceMeters: Double

The distance traversed in this drive in meters.

driveId

var driveId: String

An identifier for this drive that was recorded. This identifier is unique for a particular FairmaticConfiguration.driverId with which the SDK is initialized.

driveType

var driveType: FairmaticDriveType

The type of drive. This also determines what other properties of this object are set.

endTimeMillis

var endTimeMillis: Long

The end timestamp of the drive in milliseconds since epoch.

events

var events: ArrayList<FairmaticEvent>

A list of FairmaticEvent detected by the sdk for this drive.

extrapolationDetails

var extrapolationDetails: FairmaticExtrapolationDetails?

The extrapolated details for this drive. This will be available only in the AnalyzedDriveInfo. Available if DriveInfo.getDriveType is FairmaticDriveType.DRIVE and the SDK was able to reliably determine the extrapolation details. Otherwise this is null.

insurancePeriod

var insurancePeriod: FairmaticInsurancePeriod?

The insurance period in which the drive was detected. This will be null if there is no insurance period associated with this drive. events

maxSpeed

var maxSpeed: Double

The maximum speed of the drive in meters per second. If we could not estimate the maximum speed due to lack of reliable location data, this value will be -1.

phonePosition

var phonePosition: PhonePosition

Position of the phone or device for the majority of the drive.

sessionId

var sessionId: String?

Session id is specified by the enclosing application when it wants to record a session. This will be null if there is no session is associated with this drive.

startTimeMillis

var startTimeMillis: Long

The start timestamp of the drive in milliseconds since epoch.

trackingId

var trackingId: String?

Tracking id is specified by the enclosing application when it wants to com.fairmatic.sdk.Fairmatic.startDrive manually. This will be null if no tracking id was specified.

userMode

var userMode: FairmaticUserMode?

Whether the user was a driver or a passenger. Driver/Passenger detection is disabled by default. Talk to your contact in Fairmatic to enable this feature. Driver/Passenger detection will only be available in AnalyzedDriveInfo.

vehicleType

var vehicleType: FairmaticVehicleType?

The type of vehicle. Only present when driveType is FairmaticDriveType.DRIVE.

warnings

var warnings: ArrayList<DriveInfo.Warning>

A list of DriveInfo.Warning for this drive.

waypoints

var waypoints: ArrayList<LocationPointWithTimestamp>

A list of LocationPointWithTimestamp objects corresponding to this drive in increasing order of timestamp. The first point corresponds to drive start location and last to drive end location. This is a sampled approximation of the drive which gives an indication of the path taken by the driver. It is not the full detailed location data of the drive. If no waypoints are recorded during the drive, then this is an empty array.