Prerequisite

Before starting DriveKit Driver Achievement integration, make sure that you have initialized DriveKit.​

Integration

Get framework from Github.

To add the Driver Achievement SDK module to your app, add the following line to your dependencies in your application build.gradle file:

dependencies {
implementation 'com.drivequant.drivekit:drivekit-driver-achievement:1.8.0'
}

Get Streaks

To get Driver streaks, you have to call the following method:

DriveKitDriverAchievement.getStreaks(listener: StreaksQueryListener,
        type: SynchronizationType = SynchronizationType.DEFAULT)

DriveKitDriverAchievement.INSTANCE.getStreaks(StreaksQueryListener listener, SynchronizationType type)

SynchronizationType can have 2 values:

1. DEFAULT: if this value is used, the SDK will try to synchronize local trips with DriveQuant backend to get new trips or modified trips, and then return the trip list via the callback.

2. CACHE: If this value is used, no synchronization will be performed and only trips previously synchronized will be returned via the callback.

StreakSyncStatus in the callback can have 3 values:

1. NO_ERROR: synchronization has been successfully performed.

2. CACHE_DATA_ONLY: synchronizationType has been set to cache.

3. FAILD_TO_SYNC_STREAKS_CACHE_ONLY: synchronization has failed, only streaks previously synchronized are returned.

Streak description

Streak themes description

The themes and conditions to increment the sequences of the trip are the following:

• PHONE_DISTRACTION: the driver has not handled his phone.

• SAFETY: the safety score of the trip is higher or equal to 9.8.

• SPEEDING: the speeding score of the trip is higher or equal to 9.8.

• ACCELERATION: there wasn’t any harsh acceleration event during the trip.

• BRAKE: there wasn’t any hard braking event during the trip.

• ADHERENCE: there wasn’t any adherence thresold crossing during the trip.

Streak Result description

Get Badges

To get Driver badges, you have to call the following method:

DriveKitDriverAchievement.getBadges(
        listener: BadgesQueryListener,
        synchronizationType: SynchronizationType = SynchronizationType.DEFAULT
    )

DriveKitDriverAchievement.INSTANCE.getBadges(
        listener: BadgesQueryListener,
        synchronizationType: SynchronizationType = SynchronizationType.DEFAULT)

BadgeSyncStatus in the callback can have 3 values:

1. NO_ERROR : Synchronization has been successfully performed

2. .CACHE_DATA_ONLY : SynchronizationType has been set to cache.

3. FAILD_TO_SYNC_BADGES_CACHE_ONLY : Synchronization has failed, only badges previously synchronized are returned.

Badge Description

Badge

BadgeCharacteristics

Level

The Level enum values are:

• BRONZE

• SILVER

• GOLD

​

BadgeCategory

The BadgeCategory enum values are:

• GENERIC

• SAFETY

• ECO_DRIVING

• PHONE_DISTRACTION

Get ranking

To get driver’s ranking, you need to call the following method:

DriveKitDriverAchievement.getRanking(
        rankingType: RankingType,
        listener: RankingQueryListener,
        rankingDepth: Int = 5,
        rankingPeriod: RankingPeriod = RankingPeriod.WEEKLY,
        synchronizationType: SynchronizationType = SynchronizationType.DEFAULT
    )
​

DriveKitDriverAchievement.INSTANCE.getRanking(
        RankingType rankingType,
        RankingQueryListener listener,
        int rankingDepth,
        RankingPeriod rankingPeriod,
        SynchronizationType synchronizationType)

Ranking parameters

​

RankingPeriod

The RankingPeriod enum values are:

• WEEKLY: is the period from the last Monday at midnight to the next Sunday at midnight.

• MONTHLY: is the period from the 1rst day of the month (at midnight) to the last (at midnight).

• ALL_TIME: is the period since the creation of the app.

RankingType

The RankingType enum values are:

• SAFETY,

• DISTRACTION,

• ECO-DRIVING,

• SPEEDING.

RankingSyncStatus

RankingSyncStatus in the callback can have 3 values:

Synchronization status:

• NO_ERROR: Synchronization has been successfully performed.

• CACHE_DATA_ONLY: SynchronizationType has been set to cache.

• FAILD_TO_SYNC_RANKINGS_CACHE_ONLY: Synchronization has failed, only rankings previously synchronized are returned.

• USER_NOT_RANKED: Driver not ranked.

Ranking Description

DriverRanked Description

Ranking access conditions

To enter a ranking, a driver must have at least one scored trip in the ranking period.

Data update

The scores, distances and ranks are updated every hour.

Reset

If you need to reset Driver Achievement configuration (user logout, clear data for example), you can call the following method:

DriveKitDriverAchievement.reset()

DriveKitDriverAchievement.INSTANCE.reset()

All data saved locally by the Driver Achievement SDK will be erased and default configuration will be restored.