Main configurations

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 Nearby Devices permission to detect Bluetooth devices;
the background execution authorization to avoid the application being stopped by the power saving system.

Starting from Android 13, the user also needs to authorize the app to send notifications.

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:

PermissionsUtilsUI.showPermissionViews(this, object : PermissionViewListener {
       override fun onFinish() {
          //Code called when all permissions in the list are properly granted
       }
   })

PermissionsUtilsUI.INSTANCE.showPermissionViews(this, 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

Diagnosis state

Each monitored setting has three levels of criticity defined by the enum PermissionStatus : VALID, NOT_VALID and WARNING.

VALID: The setting is correctly configured (device sensor is ON and/or permission is authorized). There is no error and the trip analysis will work well.
NOT_VALID: The setting is not correctly configured (device sensor is OFF and/or permission is declined). There is an error and the trip analysis will not work as expected.
WARNING: The setting is not correctly configured, but it will not affect the trip analysis.

Diagnosis screen areas

The diagnosis screen is divided into three areas:

The first displays the status of sensors and permissions.
The second contains a quick link to the battery optimization functions.
The third displays a contact button to reach support.

The first two areas are always displayed. The third is 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.

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

DriveKitNavigationController.permissionsUtilsUIEntryPoint?.let {
   it.startAppDiagnosisActivity(this)
}

PermissionsUtilsUIEntryPoint permissionsUtilsUIEntryPoint = DriveKitNavigationController.INSTANCE.getPermissionsUtilsUIEntryPoint();
if (permissionsUtilsUIEntryPoint != null) {
   permissionsUtilsUIEntryPoint.startAppDiagnosisActivity(this);
}

Bluetooth sensor status check

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

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

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

If the Bluetooth sensor is turned off on the device, iBeacon and Bluetooth devices won't be detected.

Moreover, phone calls during a trip might not be detected and the distraction score can be affected.

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:

An email will be automatically composed,
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:

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 
   }
})

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:

PermissionsUtilsUI.configureContactType(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.

fun configureContactType(contactType: ContactType)

PreviousGet started NextIntroduction

Last updated 2 years ago

Was this helpful?