Main configuration

Permission management

On Android, the user must grant the SDK access to the phone's location and background activity monitoring to enable the trip detection function included in the Trip Analysis component.

The user must additionally accept background execution to avoid the application being stopped by the power saving system.

The Permissions Utils component provides a set of screens to guide the user through the selection of the right options.

Once all permissions have been granted by the user, you are warned by the closure passed in parameter:

Kotlin
Java
Kotlin
val permissionViews = arrayListOf(
PermissionView.ACTIVITY,
PermissionView.LOCATION,
PermissionView.BACKGROUND_TASK
)
PermissionsUtilsUI.showPermissionViews(this, permissionViews, object : PermissionViewListener {
override fun onFinish() {
//Code called when all permissions in the list are properly granted
}
})
Java
ArrayList<PermissionView> permissionViews = new ArrayList<>();
permissionViews.add(PermissionView.ACTIVITY);
permissionViews.add(PermissionView.LOCATION);
permissionViews.add(PermissionView.BACKGROUND_TASK);
PermissionsUtilsUI.INSTANCE.showPermissionViews(this, permissionViews, new PermissionViewListener() {
@Override
public void onFinish() {
//Code called when all permissions in the list are properly granted
}
});

The Permissions Utils component automatically manages the permission request workflow depending on the version of Android installed on the user's smartphone.

SDK diagnosis

The diagnosis screen is divided into four areas:

  1. The first displays the status of sensors and permissions.

  2. The second contains a quick link to the battery optimization functions.

  3. The third displays a contact button to reach support.

  4. The fourth section allows you to enable an activity log.

Layout of the diagnosis screen on iOS

The first two areas are always displayed. The third and fourth are optional.

The diagnostic function of the SDK has the following configurations:

  • In area 1, the sensors and permissions to be checked are selected automatically except for the Bluetooth sensor. If your application does not use a Bluetooth device or an iBeacon, it is not necessary to monitor the status of the Bluetooth sensor.

  • Area 2 is always displayed if the Android version includes power-saving features (introduced from Android 6.0 - API level 23).

  • In area 3, it is possible to configure the recipient's email address for the support request or a web address to which the user can be directed.

  • Area 4 can be hidden if necessary.

To use the app diagnosis display into your app, you must enter the following lines of code:

Kotlin
Java
Kotlin
DriveKitNavigationController.permissionsUtilsUIEntryPoint?.let {
it.startAppDiagnosisActivity(this)
}
Java
PermissionsUtilsUIEntryPoint permissionsUtilsUIEntryPoint = DriveKitNavigationController.INSTANCE.getPermissionsUtilsUIEntryPoint();
if (permissionsUtilsUIEntryPoint != null) {
permissionsUtilsUIEntryPoint.startAppDiagnosisActivity(this);
}

Bluetooth sensor status check

Access to the Bluetooth sensor is not required. This permission is not requested when the application is first installed.

For natural triggering (i.e. from the phone's sensors), or using an iBeacon, Bluetooth access is not required.

Access to the Bluetooth sensor is required in the two cases described below:

  1. To enable automatic start of trip recording from an iBeacon device.

  2. To enable automatic start of trip recording from a Bluetooth device.

By default, access to the Bluetooth sensor is not monitored. If you want to monitor the Bluetooth sensor, add the following line after initialization of the module:

Kotlin
Java
Kotlin
PermissionsUtilsUI.configureBluetooth(true)
Java
PermissionsUtilsUI.INSTANCE.configureBluetooth(true);

Support Request Management

The user can make a support request if the application does not work properly.

When the user clicks on the support request button, you can choose between two actions:

  1. An email will be automatically composed,

  2. or a redirection to a web page of your choice will be made.

The email contains the key information to ease the diagnosis of a problem (status of permissions and phone sensors). The recipient's email is configurable, as well as other parameters:

Kotlin
Java
Kotlin
PermissionsUtilsUI.configureContactType(ContactType.EMAIL(object : ContentMail {
override fun getBccRecipients(): List<String> {
//return a list of bcc recipients
}
override fun getMailBody(): String {
//return mail body
}
override fun getRecipients(): List<String> {
//return list of recipients
}
override fun getSubject(): String {
//return mail body message
}
override fun overrideMailBodyContent() {
//return true if you want to override the default support mail body
}
})
Java
PermissionsUtilsUI.INSTANCE.configureContactType(new ContactType.EMAIL(
new ContentMail() {
@NotNull
@Override
public List<String> getRecipients() {
//return list of recipients
}
@NotNull
@Override
public List<String> getBccRecipients() {
//return a list of bcc recipients
}
@NotNull
@Override
public String getSubject() {
//return subject
}
@NotNull
@Override
public String getMailBody() {
//return mail body message
}
@Override
public boolean overrideMailBodyContent() {
//return true if you want to override the default support mail body
}
}
));

If you want to redirect the user to a web page instead of composing an email, you have to add the following line:

Kotlin
Java
Kotlin
PermissionsUtilsUI.configureContactType(ContactType.WEB(Uri.parse("https://www.docs.drivequant.com")))
Java
PermissionsUtilsUI.INSTANCE.configureContactType(new ContactType.WEB(Uri.parse("https://www.docs.drivequant.com/")));

In this specific case, there is no way to obtain information about authorization and sensor status.

If you do not configure the contact type, this area will be hidden and will not appear on the diagnosis screen.

Kotlin
Java
Kotlin
PermissionsUtilsUI.configureContactType(ContactType.NONE)
Java
PermissionsUtilsUI.INSTANCE.configureContactType(ContactType.NONE.INSTANCE);

Activity log

If necessary, the user can enable the activity log. This feature records key events in a file. This data will be helpful to analyse in detail the cause of a problem occurring in the application.

The activity log file is automatically added as an attachment to the support request email (which has been configured in the previous section).

This feature is configurable. By default, this feature is not displayed. To activate it, call the following line:

Kotlin
Java
Kotlin
PermissionsUtilsUI.configureDiagnosisLogs(true)
Java
PermissionsUtilsUI.INSTANCE.configureDiagnosisLogs(true);

For more details on the DriveKit logging function, go to the logging page.