Prerequisite

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

Integration

Get framework

DriveKit Driver Achievement SDK is available on CocoaPods master repo.

To access the framework in the repository, add the following lines to your Podfile:

target 'my-target' do
  pod 'DriveKitDriverAchievement'
end

Then, run pod install.

Get Streaks

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

public func getStreaks(type: SynchronizationType = .defaultSync, completionHandler : @escaping (StreakSyncStatus, [Streak]) -> ())

SynchronizationType can have 2 values:

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

2. cache: if this value is used, no synchronization will be performed and only streaks previously synchronized will be returned via the completionHandler.

StreakSyncStatus in the completionHandler can have 4 values:

1. noError: synchronization has been successfully performed.

2. cacheDataOnly: synchronizationType has been set to cache.

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

4. syncAlreadyInProgress: a synchronization is in progress, only streaks previously synchronized are returned until the synchronization is finished.

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 threshold crossing during the trip.

Streak Result description

Get Badges

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

public func getBadges(type: SynchronizationType = .defaultSync, completionHandler : @escaping (BadgeSyncStatus, [DKBadge], Int) -> ())

SynchronizationType can have 2 values:

1. defaultSync: if this value is used, the SDK will try to synchronize local trips with DriveQuant backend to get new or updated badges, and then return the badge list via the completionHandler.

2. cache: If this value is used, no synchronization will be performed and only badges previously synchronized will be returned via the completionHandler.

BadgeSyncStatus in the completionHandler can have 4 values:

1. noError: Synchronization has been successfully performed.

2. cacheDataOnly: SynchronizationType has been set to cache.

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

4. syncAlreadyInProgress: A synchronization is in progress, only badges previously synchronized are returned until the synchronization is finished.

Badge description

DKBadge

DKBadgeCharacteristics

DKLevel

• .bronze

• .silver

• .gold

DKBadgeCategory

• .generic

• .ecodriving

• .safety

• .phoneDistraction

Get ranking

To get driver’s Ranking, you need to call the following method of DriveKitDriverAchievement class:

func getRanking(rankingType: DKRankingType,
                rankingPeriod: DKRankingPeriod = .weekly,
                rankingDepth: Int = 5,
                groupName: String = "All",
                type: SynchronizationType = .defaultSync,
                completionHandler : @escaping (RankingSyncStatus, DKRanking?) -> ())

Ranking parameters

DKRankingType

The DKRankingType enum values are:

• safety,

• ecoDriving,

• distraction,

• speeding.

DKRankingPeriod

The DKRankingPeriod enum values are:

• weekly: In the case of a weekly classification, the trips considered for the calculation of the user's position are those made between Monday midnight and Sunday midnight. If the user has not driven during the week, he is not ranked.

• monthly: In the case of a monthly ranking, the trips considered for the calculation of the user's position are those made between the first and last day of the month.. If the user has not driven during this period, he is not ranked.

• allTime: This ranking takes into account all of the driver's trips.

RankingSyncStatus

RankingSyncStatus in the callback can have 5 values:

Synchronization status:

1. noError: Synchronization has been successfully performed.

2. cacheDataOnly: SynchronizationType has been set to cache.

3. failedToSyncRanking: Synchronization has failed, only rankings previously synchronized are returned.

4. syncAlreadyInProgress: A synchronization is in progress, only rankings previously synchronized are returned until the synchronization is finished.

5. userNotRanked: The user is not ranked.

DKRanking Description

DKDriverRanked Description

Ranking access conditions

To enter a ranking, a driver must have at least one scored trip during 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 for example), you can call the following method:

DriveKitDriverAchievement.shared.reset()

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

​