apidocs / com.nimmsta.core.android.platform / AndroidPlatform

AndroidPlatform

class AndroidPlatform : LogInterface, HandlerInterface, AnalyticsInterface, QRCodeRendererInterface, CustomConfigurationInterface

Android Platform implementation. This contains functions for logging, Threading and BarcodeRule Executor. Additionally it contains HighPriorityHandler that allows to check if Android device has an automatically disabled high priority mode as of a connection loss.

For Error-Handling you should register with registerErrorHandler your IErrorHandler. This provides you with all exceptions handled by framework for analytics.

Author
NIMMSTA Team

Copyright
NIMMSTA GmbH & IBPG 2020

License
NIMMSTA GmbH

Constructors

<init>

Android Platform implementation. This contains functions for logging, Threading and BarcodeRule Executor. Additionally it contains HighPriorityHandler that allows to check if Android device has an automatically disabled high priority mode as of a connection loss.

AndroidPlatform(context: Context)

Properties

context

val context: Context

highPriorityHandler

val highPriorityHandler: HighPriorityHandler

operatingSystem

val operatingSystem: OperatingSystem

Functions

base64QrCodePNGImage

fun base64QrCodePNGImage(connectionCode: HS50ConnectionCode, width: Int, height: Int): String

d

fun d(tag: String, message: String): Unit

e

fun e(tag: String, message: String): Unit
fun e(tag: String, message: String, throwable: Throwable): Unit

exportLogToFile

Collects all data for the log export and saves the logfile

fun exportLogToFile(connectionManager: INIMMSTAConnectionManager?): Task<VfsFile?>

handleError

fun handleError(t: Throwable): Unit

i

fun i(tag: String, message: String): Unit

postDelayedBackground

fun postDelayedBackground(delay: Long, runnable: Runnable?): Unit

postToMainDelayed

fun postToMainDelayed(delay: Long, runnable: Runnable?): Unit

postToMainThread

fun postToMainThread(runnable: Runnable?): Unit

readCustomConfiguration

fun readCustomConfiguration(portableFilePath: String?): Task<ConfigurationBundle?>

rulesNeedHID

Returns if HID mode must be supported due to HID characters in the rule.

fun rulesNeedHID(): Task<Boolean>

set

fun set(key: String, value: String): Unit
fun set(key: String, value: Boolean): Unit
fun set(key: String, value: Int): Unit

trackEvent

fun trackEvent(name: String, properties: Map<String, String>?): Unit

w

fun w(tag: String, message: String): Unit
fun w(tag: String, message: String, throwable: Throwable): Unit

Companion Object Properties

devicePairingManager

lateinit var devicePairingManager: DevicePairingManager

platform

lateinit var platform: AndroidPlatform

Companion Object Functions

init

Must be called to init Android Platform of NIMMSTA Core Library Android. Without this some things won't work.

fun init(context: Context): Unit

registerErrorHandler

fun registerErrorHandler(errorHandler: IErrorHandler): Unit