iOS
This section describes how to integrate DriveKit into an iOS mobile application.
DriveKit is developed with the Swift 5 language and is compatible with iOS 12.0 and later versions.
DriveKit SDK is available on Cocoapods master repo.
To access the framework in the repository, add the following lines to your Podfile:
Podfile
target 'my-target' do
pod 'DriveKitCore'
end
Even if your app do not use Bluetooth, since DriveKit imports CoreBluetooth framework, you must include Bluetooth usage description keys in your
Info.plist file: NSBluetoothAlwaysUsageDescription (and NSBluetoothPeripheralUsageDescription if your deployment target is < iOS 13). This value can be localized (see our English file for example).If you don't do this, your app will be rejected when you will send the binary to App Store Connect.
To initialize DriveKit in your app, you must call the initialization method in
didFinishLaunchingWithOptions method of your application class.AppDelegate.swift
import DriveKitCoreModule
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
DriveKit.shared.initialize(delegate: self)
...
}
extension AppDelegate: DriveKitDelegate {
func driveKitDidConnect(_ driveKit: DriveKit) {
// Connected to DriveKit.
}
func driveKit(_ driveKit: DriveKit, didReceiveAuthenticationError error: RequestError) {
// DriveKit authentication error: \(error).
}
func driveKitDidDisconnect(_ driveKit: DriveKit) {
// Disconnected from DriveKit.
}
func userIdUpdateStatusChanged(status: UpdateUserIdStatus, userId: String?) {
// DriveKit userId updated: userId = \(userId), status = \(status).
}
func driveKit(_ driveKit: DriveKit, accountDeletionCompleted status: DeleteAccountStatus) {
// account deletion completed with status \(status).
}
}
All DriveKit modules have a method
initialize that must be called in didFinishLaunchingWithOptions method of your AppDelegate file.To use DriveKit framework, you have to obtain an API Key from DriveQuant. If you don't have an API key, please contact DriveQuant.
Once your API key is securely stored in your application, you can configure DriveKit by calling the following method:
DriveKit.shared.setApiKey(key: "MyApiKey")
Each driver must be identified with a unique identifier. Once you have this identifier, configure DriveKit by calling the following method:
DriveKit.shared.setUserId(userId: "MyUserId")
You can call these 2 configuration methods anywhere in your app code. DriveKit will save the value locally. If the app is killed and relaunched, DriveKit will be reconfigured automatically.
We recommend never using an email address or phone number to define the unique user ID. It is recommended that you set up a unique, universal and anonymous user ID. For example, you can generate a globally unique identifier (GUID) for each of your users.
DriveKit SDK will not work until you set the API key and the userId.
You can check if DriveKit SDK is well configured with the following method:
DriveKit.shared.isConfigured()
This method returns
true if it is well configured.If you need to reset DriveKit configuration (user logout for example), you can call the following method:
DriveKit.shared.reset()
All data saved locally by DriveKit will be erased.
All DriverKit frameworks have
reset method that erases all data saved locally by the framework.Make sure that you call
reset method of all frameworks to fully reset DriveKit configuration.DriveKit comes with a logging feature that is enabled by default. This feature allows you to quickly identify the cause of a problem. We recommend leaving the log enabled as it does not consume memory space and is useful in the support phase. However, if you don't want to use it, it can be disabled.
Log will be written in app directory. One log file per month will be written with the name
log-<YEAR>-<MONTH>.txt (example: log-2019-8.txt). All DriveKit modules log in this file.
You can get a zip file with the log files of the previous month and the current one with the method DriveKitLog.shared.getZippedLogFilesUrl(), or by clicking on “Contact support” and changing the email receiver. The file will be in attachment of the email.You can also make files of your application (including DriveKit log files) available in the iOS Files app by adding these 2 keys to your project's
Info.plist file: UIFileSharingEnabled and LSSupportsOpeningDocumentsInPlace, setting them both to true.To write log files on user smartphone, you must add the following entry in your info.plist file
UIFileSharingEnabledandLSSupportsOpeningDocumentsInPlace set to true.Disable logging by calling:
DriveKit.shared.disableLogging()
To activate logging, call the following method:
DriveKit.shared.enableLogging()
To get user’s information (first name, last name and pseudo), call the
getUserInfo method. It will retrieve and save these data locally:DriveKit.shared.getUserInfo(synchronizationType: .defaultSync) { status, userInfo in
if status == .success {
// Get user's names in userInfo object.
}
}
You can add information to a user's account such as first name, last name and pseudo. These details are optional and you can choose to make the user's account anonymous. To update the user's information, you must call the
updateUserInfo method:DriveKit.shared.updateUserInfo(pseudo: "New_pseudo") { success in
if success {
// The pseudo has been successfully updated.
}
}
Or to update all information:
DriveKit.shared.updateUserInfo(firstname: "New_firstname", lastname: "New_lastname", pseudo: "New_pseudo") { success in
if success {
// The firstname, lastname and pseudo have been successfully updated.
}
}
It is possible to update the userId by calling the following method:
DriveKit.shared.updateUserId(userId: "newUserId")
To be able to check whenever
userId got updated and catch the update status, you have to use DriveKitDelegate delegate.You can delete a driver's account in DriveKit. This action deletes all the data related to the account.
The deletion can be done instantly or with delay.
- In the first case, when the method is called, the account is instantly deleted.
- In the second case, the driver has 30 days to log back into the application and reactivate his account.
To delete a driver's account, use the following method:
Swift
DriveKit.shared.deleteAccount(instantDeletion: false)
instantDeletion can have 2 values: false: Default value, allows the user to recover the deleted account by logging-in again with the same credentials. Users have 30 days starting from the day when the account was deleted.true: Allow to delete an account instantly. The account and all the related data will be immediately deleted and no rollback is possible.
Your team needs to have the deletion feature activated to use this method. Please contact DriveQuant if you need it.
To be able to check whenever the account deletion is complete, you have to use the DriveKitDelegate interface.
You should restore the DriveKit API key in the
onAccountDeleted() callback only when the status value is SUCCESS.Last modified 6d ago