Skip to main content

Intent Integration

Overview​

This section outlines the capabilities of the intent integration, which facilitates seamless integration with the Android Aladdin application. Intent integration provides a sophisticated registering model, enabling developers to efficiently receive and manage scanned data. With built-in functionalities for sharing data, developers gain a professional and adaptable solution for incorporating scanned data into their applications.

Intent Integration in Aladdin​

  1. Select the Intent option in the Integration UI of Aladdin application.

  2. A UI will appear to enter the names for the barcode action, barcode data, label type and scan time extra name in their respective input fields. The input fields will be pre-populated with default names, but can be modified to fit your needs.

    Below are the default values used in Aladdin app:

    • Barcode event action name: COM.DATALOGIC.ALADDINAPP.INTENT.ACTION_SEND_BAR_CODE_DATA
    • Barcode data extra name: COM.DATALOGIC.ALADDINAPP.EXTRA.BARCODE_DATA
    • Barcode label type extra name: COM.DATALOGIC.ALADDINAPP.EXTRA.BARCODE_CODE_TYPE
    • Barcode scan time extra name: COM.DATALOGIC.ALADDINAPP.EXTRA.BARCODE_SCAN_TIME

  3. Click "Save". Now, whenever the CODiScan scans a barcode, the application will send a broadcast with the barcode event action name and intent extra names which you entered in step 2.

Client Application Implementation​

Barcode event​

To receive a barcode event in the client application, the client must implement a broadcast receiver with the action and extras names that you entered in the Aladdin application.

Example:

class BarCodeReceiver : BroadcastReceiver() {

    override fun onReceive(context: Context, intent: Intent) {

        if ("COM.DATALOGIC.ALADDINAPP.INTENT.ACTION_SEND_BAR_CODE_DATA" == intent.action) {

            val data = intent.getStringExtra("COM.DATALOGIC.ALADDINAPP.EXTRA.BARCODE_DATA")

            val codeType = intent.getStringExtra("COM.DATALOGIC.ALADDINAPP.EXTRA.BARCODE_CODE_TYPE")

            val scanTime = intent.getLongExtra("COM.DATALOGIC.ALADDINAPP.EXTRA.BARCODE_SCAN_TIME", 0L)

            Toast.makeText(context, data, Toast.LENGTH_SHORT).show()
        }
    }
}

Define an IntentFilter for the specified actions:

val barCodeReceiver = BarCodeReceiver()

val barCodeIntent = IntentFilter("COM.DATALOGIC.ALADDINAPP.INTENT.ACTION_SEND_BAR_CODE_DATA")

Register the broadcast receiver instance, the usual place for this call would be in the onCreate method of a Service or Activity class:

registerReceiver(barCodeReceiver, barCodeIntent)

Connection status event​

You can get the scanner connection state by registering a receiver for the action name com.datalogic.aladdinapp.intent.ACTION_SEND_SCANNER_STATE with extra com.datalogic.aladdinapp.extra.SCANNER_STATE

Implement a broadcast receiver:

class ScannerStateReceiver : BroadcastReceiver() {
    override fun onReceive(context: Context, intent: Intent) {
        if ("com.datalogic.aladdinapp.intent.ACTION_SEND_SCANNER_STATE" == intent.action) {
            val connected =
                intent.getBooleanExtra("com.datalogic.aladdinapp.extra.SCANNER_STATE", false)
            
            if (connected) {
                Toast.makeText(context, "Connected to scanner", Toast.LENGTH_SHORT).show()
            } else {
                Toast.makeText(context, "Disconnected from scanner", Toast.LENGTH_SHORT).show()
            }
        }
    }
}

Define an IntentFilter for the specified actions:

val scanStateReceiver = ScannerStateReceiver()
val connectionStateIntent = 
    IntentFilter("com.datalogic.aladdinapp.intent.ACTION_SEND_SCANNER_STATE")

Register the broadcast receiver instance, the usual place for this call would be in the onCreate method of a Service or Activity class:

registerReceiver(scanStateReceiver, connectionStateIntent)

Get Latest Scan Data​

You can get the latest scanned barcode data by sending the broadcast below. The Aladdin application will send the barcode details under the defined action name within Aladdin.
Default: COM.DATALOGIC.ALADDINAPP.INTENT.ACTION_SEND_BAR_CODE_DATA

val intent = Intent("com.datalogic.aladdinapp.intent.ACTION_GET_LATEST_SCAN_DATA")
sendBroadcast(intent)

Get Connection State​

You can get the scanner connection state by sending the broadcast below. The Aladdin application will send the connection details in the following action: com.datalogic.aladdinapp.intent.ACTION_SEND_SCANNER_STATE

val intent = Intent("com.datalogic.aladdinapp.intent.ACTION_GET_SCANNER_STATE")
sendBroadcast(intent)

Intent Sample Client​

The Aladdin intent client is a purposefully crafted sample application designed to showcase the dynamic capabilities of the Intent integration.

info

The client APK and source code can be found in the Aladdin samples repository on Github.

  1. Select Intent as the integration method within the Aladdin app.

  2. The Intent setting UI will appear with some pre-populated fields. You can change the content of each input text field (or leave the default) and tap the "Save" button to confirm. Please, note that each field should contain unique entries; the same data should not be repeated.

  3. Open the Intent client application.

  4. Tap the "Register to Aladdin" button.

  5. A pop-up will appear with 4 pre-populated input fields. The name of each field must be the same that you entered in step 2.

  6. You can now scan barcodes with your CODiScan device. The barcode details will be displayed in a toast message in the client application.

  7. You can also tap "Get latest barcode" and retrieve the latest scanned barcode data.

  8. To check the scanner status, tap "Get scanner status".

  9. To unregister from the Aladdin application, tap "Unregister from Aladdin".

Notes:

  • The client can register to Aladdin irrespective of any integration method selected in the application, but it cannot receive barcode data or connection state if Intent is not selected as the integration method within Aladdin.
  • If Intent is selected as the integration method, but the action and intent extras do not match between Aladdin and the client application, you will not be able to receive barcode events in the client app. You can only get the scanner status. You can unregister from Aladdin and then register anew with the same key values entered in the Aladdin app.
  • If Intent is not selected as integration method in the Aladdin app and you try to register to the Intent client application, registration will be successful, but the "Get latest barcode" and the "Get scanner status" buttons will be disabled and you will not be able to receive new barcode data scanned by the CODiScan.
  • User input for barcode extra names (barcode data, label type, and scan time) should be unique.
  • If all entries are equal and unique in both client and Aladdin app, you will get the barcode details in the toast message.