QP SDK Android/com.quandopasso.sdk/QPEngine

QPEngine

object QPEngine

QPEngine

Singleton class used by clients to integrate QuandoPasso SDK functionalities in their apps.

Properties

var active: Boolean

var onEvent: (QPEvent) -> Unit?

lateinit var settings: QPSettings

Functions

checkPermissions

fun checkPermissions(context: Context): Boolean

clearAllSignalNotifiedStatus

fun clearAllSignalNotifiedStatus()

Prompt the user with the required Battery permission popup

clearCachedJingle

fun clearCachedJingle(context: Context)

Clear the cached Jingle

forceFetchSignals

fun forceFetchSignals()

getPermissionsBatteryInfo

fun getPermissionsBatteryInfo(context: Context): PermissionsBatteryInfo

Get Permission details

getSecureStatus

fun getSecureStatus(): QPSecurityStatus

Get secure status

fun getVersion(): String

Returns the current SDK build version

fun initialize(context: Context, settings: QPSettings)

Initialize the SDK.

isCategoryFiltered

fun isCategoryFiltered(categoryId: Int?, list: List<Int> = settings.categoriesFiltered): Boolean

fun isRunning(): Boolean

Get Service is running

fun loadCategories(callback: (List<QPCategory>) -> Unit? = null)

Retrieve the VSign categories.

onSettingsUpdated

fun onSettingsUpdated(context: Context)

requestPermissions

fun requestPermissions(activity: Activity)

Prompt the user with the required permission popup

fun setDebugLog(log: Boolean)

Set debug log (default = false)

fun setJingle(context: Context, url: Uri?, cacheFile: Boolean = false)

Set the URL from where retrieve the jingle file.

fun speak(context: Context, text: String?, language: String? = null, useIterationSettings: Boolean = false)

Reproduce a message to read according to Text-To-Speech activation

fun start(context: Context)

Initialize and start all required services, like GPS updates.

fun startFCD(): Boolean

fun stop(context: Context)

Stops the QPEngine instance and unsubscribe from any notifications. Calling this method also stops the foreground service used to track location updates. It is recommended to call this method when the main app activity is destroyed to make sure the service is also detached.

fun stopFCD(): Boolean

fun updateSettings(jsonFile: File): List<String>

Update Settings with a JSON File

fun updateSettings(json: String, settings: QPSettings = this.settings): List<String>

Update Settings with a JSON