Requirements

DriveKit is developed with the Kotlin language and is compatible with Android 21 (5.0) and later versions.

Integration

DriveKit repository

DriveKit SDK are available on DriveQuant Maven repository.

To access modules in the repository, add the following lines to your project build.gradle file:

allprojects {
    repositories {
        maven {
            url "https://maven.drivequant.com/repository/android-sdk/"
        }
    }
}

Get module from repository

To add DriveKit Core module to your app, add the following lines to your dependencies in your application build.gradle file:

dependencies {
    implementation 'com.drivequant.drivekit:drivekit-core:1.12.0'
}

​

Initialization

DriveKit initialization

To initialize DriveKit in your app, you must call the initialization method in onCreate method of your application class.

class MyApplication: Application() {
​
    override fun onCreate() {
        super.onCreate()
        DriveKit.initialize(this)
    }
}

public class MyApplication extends Application {
​
    @Override
    public void onCreate() {
        super.onCreate();
        DriveKit.INSTANCE.initialize(this);
    }
}

Add API key

To use DriveKit modules, you have to obtain an API Key from DriveQuant. If you don't have an API key, please contact DriveQuant.

Once you've stored your API key in a secure way in your application, you can configure DriveKit by calling the following method:

DriveKit.setApiKey("MyAPIKey")

DriveKit.INSTANCE.setApiKey("MyAPIKey");

Identify user

Each driver must be identified with a unique identifier. Once you have this identifier, configure DriveKit by calling the following method:

DriveKit.setUserId("MyUserId")

DriveKit.INSTANCE.setUserId("MyUserId");

Check your configuration

You can check if DriveKit is well configured with the following method.

DriveKit.isConfigured()

DriveKit.INSTANCE.isConfigured();

This method returns true if DriveKit is well configured.

Reset

If you need to reset DriveKit configuration (user logout for example), you can call the following method:

DriveKit.reset()

DriveKit.INSTANCE.reset();

All data saved locally by DriveKit will be erased.

Logging

In order to facilitate the integration of the SDK into your mobile application, DriveKit provides a logging feature. To enable logging, call the following method specifying the path of the log directory.

DriveKit.enableLogging("/path/to/my/log/directory")

DriveKit.INSTANCE.enableLogging("/path/to/my/log/directory");

You can retrieve the last Uri log file by calling the following method:

DriveKitLog.getLogUriFile(context)

DriveKitLog.INSTANCE.getLogUriFile(context)

Disable logging by calling:

DriveKit.disableLogging()

DriveKit.INSTANCE.disableLogging();