App misuse

Introducing a new service to send information about application usage to our servers.

Usage

Please contact IMS sales to use this feature.

Importing the library

To use app misuse APIs, add the module dependency and initialize by sending login, logout, or userAppLaunch events.

Swift

//Add IMSAppMisuse xcFramework to your project 
import IMSAppMisuse

Kotlin

dependencies {
    ...  
    implementation 'com.drivesync.android:imsappmisuse:1.19.0'
    ...
    }

Initializing the Misuse Library(iOS)

Initialize the Misuse API by creating Identity and PermissionManager objects, then pass them to AppMisuseManager.

import IMSAppMisuse
import IMSInterfaces
import IMSPermissions
import IMSBluetooth

let identity = Identity(apiKey: apiKey,externalReferenceID: userId)
let permissionManager = PermissionManager()

permissionManager.addPermissionProvider(CLLocationManager(), isRequired: true)
permissionManager.addPermissionProvider(CMMotionActivityManager(), isRequired: true)
// Add this, if app requires bluetooth permissions for trip detection
permissionManager.addPermissionProvider(BluetoothPermissionProvider(), isRequired: true)

// Servertype can be used based on two environments (.uat or .prod)
let serverType = .uat

let appMisuseService = AppMisuseManager(identity: identity, permissionManageable: permissionManager,serverType: serverType))

Calling Misuse API

There are a number of API's available depending on the service you require; choose and call the appropriate one accordingly. The serverType can be .uat or .prod based on the deployment environment.

Enabling App misuse API

This API enables the Misuse API Service.

iOS SDK scheduler

• Call the app misuse scheduler to send the event type every hour by calling AppMisuseManager.enableAppMisuse()

  • Ensure to call the mentioned API within application(_:didFinishLaunchingWithOptions:) of app life cycle and register the scheduler key in the info.plist file for registering the scheduler.

  • For more information on setup, check here.

Here's an example.

Swift

// Enable the scheduler in application(_:didFinishLaunchingWithOptions:)
AppMisuseManager.enableAppMisuse()

Kotlin

AppMisuseManager.enableAppMisuse(context,AppMisuseManager.AppMisuseServerType)

Disabling App misuse API

This API disables the AppMisuse API Service.

Here's an example.

Swift

appMisuseService.disableAppMisuse()

Kotlin

AppMisuseManager.disableAppMisuse(context)

Misuse Login API

This API sends AppMisuse information on Login.

Here's an example.

Swift

appMisuseService.sendAppMisuseEvent(eventType: .login, serverType: .prod) { result in
    switch result {
    case .success:
        // successful call
    case .failure(let error):
        // failed with \(error)
    }
}

Kotlin

AppMisuseManager.sendLoginEvent(context)

Misuse Logout API

This API sends AppMisuse information on Logout.

Here's an example.

Swift

appMisuseService.sendAppMisuseEvent(eventType: .logout, serverType: .prod) { result in
    switch result {
    case .success:
        // successful call
    case .failure(let error):
        // failed with \(error)
    }
}

Kotlin

AppMisuseManager.sendLogoutEvent(context)

Misuse User App Launch API

This API sends AppMisuse information on User Launch.

Here's an example.

Swift

appMisuseService.sendAppMisuseEvent(eventType: .userAppLaunch, serverType: .prod) { result in
    switch result {
    case .success:
        // successful call
    case .failure(let error):
        // failed with \(error)
    }
}

Kotlin

AppMisuseManager.sendAppLaunchEvent(context)