DrivingInsightsApi

Use this API to receive driving insights about vehicular transports.

DrivingInsightsApi API

getAverageOverallSafetyScore()

@Nullable Float getAverageOverallSafetyScore(SafetyScoreRequestParameters params);

Returns the average overall safety score for a given set of parameters, or null if the score is not available.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
params	The parameters for which to calculate the average overall safety score. See SafetyScoreRequestParameters.

getCallEvents()

List<CallEvent> getCallEvents(String transportId);

Returns the call events for a completed, non-provisional transport. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

getCallWhileMovingEvents()

This method was deprecated in v6.20.0 in favor of getCallEvents().

List<CallWhileMovingEvent> getCallWhileMovingEvents(String transportId);

Returns the call while moving events for a completed, non-provisional transport. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
transportId	The ID of the desired transport.

getDrivingInsights()

@Nullable DrivingInsights getDrivingInsights(String transportId)

Returns the driving insights for a given non-provisional transport, or null if there are no driving insights, the transport ID is invalid, or the transport is a provisional one. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
transportId	The ID of the desired transport.

getHarshDrivingEvents()

List<HarshDrivingEvent> getHarshDrivingEvents(String transportId)

Returns the harsh driving events for a completed, non-provisional transport. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
transportId	The ID of the desired transport.

getPhoneUsageEvents()

List<PhoneUsageEvent> getPhoneUsageEvents(String transportId)

Returns the phone usage events for a completed, non-provisional transport. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
transportId	The ID of the desired transport.

getSpeedingEvents()

List<SpeedingEvent> getSpeedingEvents(@NonNull String transportId);

Returns the speeding events for a completed, non-provisional transport. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
transportId	The ID of the desired transport.

getWrongWayDrivingEvents()

List<WrongWayDrivingEvent> getWrongWayDrivingEvents(String transportId);

Returns the wrong way driving events for a completed, non-provisional transport. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
transportId	The ID of the desired transport.

setDrivingInsightsReadyListener()

void setDrivingInsightsReadyListener(@Nullable DrivingInsightsReadyListener listener)

Sets a listener that will be invoked when the driving insights for a completed, non-provisional transport becomes ready. See isProvisional to learn more about what a provisional transport is.

Note: calling this method on an uninitialized SDK will throw an SdkException.

Parameters
listener	A DrivingInsightsReadyListener to receive the driving insights. Set null to remove a previously set listener.