PassportScannerHelper
public class PassportScannerHelper extends Object
↳ package com.onekosmos.blockid.sdk.cameramodule.passport
This is the helper class that provides Passport document scanning functionality.
- All documents (Identity and Miscellaneous) must have the following baseline attributes.
| Parameters | |
|---|---|
| String | id: It represents the document's ID eg: driver license number. |
| String | category: Currently this SDK supports two categories for documents that can be registered i.e, identity_document or misc_document. |
| String | type: This represents the type of document that the user will try to register eg: pin, dl, ppt, liveid, nationalid. |
| String | proofedBy: This identifies the entity responsible for proofing the document. When you use BlockID SDK Scanners, this defaults to “blockid”. |
- The identity documents must have the following baseline attributes.
| Parameters | |
|---|---|
| String | firstName: First name of document holder. |
| String | lastName: Last name of document holder. |
| String | dob: Date of birth {yyyyMMdd} of document holder. |
| String | doe: Date of expiry {yyyyMMdd} of document. |
| String | face: Base64 string of document holder's face photo. |
| String | image: Base64 string of document image. |
Constructor
public PassportScannerHelper(Context context, int expiryDateGracePeriod, boolean isDataRequiredOnFail, IPassportResponseListener iPassportResponseListener)
- Creates an object of PassportScannerHelper. The scanner will throw an error if the document has already expired. If the document expires before gracePeriod, the scanner will complete the scan and return an advisory error.
It is the application's responsibility to decide if the scanned Passport should be registered or not.
| Parameter | |
|---|---|
| context | Context: Application's context. |
| expiryDateGracePeriod | int: Number of days to allow as grace period ahead of Passport document expiry. |
| isDataRequiredOnFail | boolean: Indicates if the scanner must return the Passport document data. The default value is false. |
| iPassportResponseListener | IPassportResponseListener: The block to execute after the Passport document scanning is completed. |
public PassportScannerHelper(Context context, int expiryDateGracePeriod, IPassportResponseListener iPassportResponseListener)
- Creates an object of PassportScannerHelper. The methods does not return the data in case Passport document scanning is failed. The scanner will throw an error if the document has already expired. If the document expires before gracePeriod, the scanner will complete the scan and return an advisory error.
It is the application's responsibility to decide if the scanned Passport should be registered or not.
| Parameter | |
|---|---|
| context | Context: Application's context. |
| expiryDateGracePeriod | int: Number of days to allow as grace period ahead of Passport document expiry. |
| iPassportResponseListener | IPassportResponseListener: The block to execute after the Passport document scanning is completed. |
public PassportScannerHelper(Context context, BIDScannerView bidScannerView, View scannerOverlay, int expiryDateGracePeriod, boolean isDataRequiredOnFail, IPassportResponseListener iPassportResponseListener)
- Creates an object of PassportScannerHelper. The scanner will throw an error if the document has already expired. If the document expires before gracePeriod, the scanner will complete the scan and return an advisory error.
It is the application's responsibility to decide if the scanned Passport should be registered or not.
| Parameter | |
|---|---|
| context | Context: Application's context. |
| bidScannerView | BIDScannerView: An object of BIDScannerView. |
| scannerOverlay | View: An overlay to be placed on top of BIDScannerView object. |
| expiryDateGracePeriod | int: Number of days to allow as grace period ahead of Passport document expiry. |
| isDataRequiredOnFail | boolean: Indicates if the scanner must return the Passport document data. The default value is false. |
| callback | IPassportResponseListener: The block to execute after the Passport document scanning is completed. |
public PassportScannerHelper(Context context, BIDScannerView bidScannerView, View scannerOverlay, int expiryDateGracePeriod, IPassportResponseListener iPassportResponseListener)
- Creates an object of PassportScannerHelper. The methods does not return the data in case Passport document scanning is failed. The scanner will throw an error if the document has already expired. If the document expires before gracePeriod, the scanner will complete the scan and return an advisory error.
It is the application's responsibility to decide if the scanned Passport should be registered or not.
| Parameter | |
|---|---|
| context | Context: Application's context. |
| bidScannerView | BIDScannerView: An object of BIDScannerView. |
| scannerOverlay | View: An overlay to be placed on top of BIDScannerView object. |
| expiryDateGracePeriod | int: Number of days to allow as grace period ahead of Passport document expiry. |
| callback | IPassportResponseListener: The block to execute after the Passport document scanning is completed. |
Method Summary
| Type | Name | Description |
|---|---|---|
| void | onNewIntent(Tag tag) | Once RFID chip is detected, activity will get RFID chip data in Override method onNewIntent(Intent intent).Call below code and send tag back to Passport Scanner Helper. Tag tag = intent.getExtras().getParcelable(NfcAdapter.EXTRA_TAG) |
| void | startPassportScanning() | Starts the Passport document scanner. |
| void | startRFIDScanning(LinkedHashMap<String, Object> dataObject, String signToken) | Starts Passport document's RFID scanning with default timeout of 15 seconds. |
| void | startRFIDScanning(LinkedHashMap<String, Object> dataObject, String signToken, long rfidScanTimeOut) | Starts Passport document's RFID scanning with custom defined timeout. |
| void | stopRFIDScanning() | Stops Passport document's RFID scanning. |
| void | stopScanning() | Stops the Passport document scanner. |
Method Detail
onNewIntent
public void onNewIntent(Tag tag)
- Once RFID chip is detected, activity will get RFID chip data in Override method onNewIntent(Intent intent).Call below code and send tag back to Passport Scanner Helper.
Tag tag = intent.getExtras().getParcelable(NfcAdapter.***EXTRA_TAG***)
startPassportScanning
public void startPassportScanning()
- Starts the Passport document scanner.
startRFIDScanning
public void startRFIDScanning(LinkedHashMap<String, Object> dataObject, String signToken)
- Starts Passport document's RFID scanning with default timeout of 15 seconds.
| Parameters | |
|---|---|
| dataObject | LinkedHashMap<String, Object>: The Passport document data retrieved after Passport scanning is complete. |
| signToken | String: A token which carries information about scanned Passport. This is used to verify if the Passport document is modified or not before storing it to BlockID blockchain platform. |
startRFIDScanning
public void startRFIDScanning(LinkedHashMap<String, Object> dataObject, String signToken, long rfidScanTimeOut)
- Starts Passport document's RFID scanning with custom defined timeout.
| Parameters | |
|---|---|
| dataObject | LinkedHashMap<String, Object>: The Passport document data retrieved after Passport scanning is complete. |
| signToken | String: A token which carries information about scanned Passport. This is used to verify if the Passport document is modified or not before storing it to BlockID blockchain platform. |
| rfidScanTimeOut | long: A custom timeout value for RFID scan. |
stopRFIDScanning
public void stopRFIDScanning()
- Stops Passport document's RFID scanning.
stopScanning
public void stopScanning()
- Stops the Passport document scanner.
Interface Summary
| Name | Description |
|---|---|
| IPassportResponseListener | Callback for event when Passport document scanning is completed. |
IPassportResponseListener
public interface IPassportResponseListener
↳ package com.onekosmos.blockid.sdk.cameramodule.camera.passportModule
- Callback for event when Passport document scanning is completed.
Method Details
void onPassportResponse(LinkedHashMap<String, Object> bidPassport, String signatureToken, ErrorManager.ErrorResponse error);
- A callback method which is triggered after the Passport document scanning is completed.
| Parameters | |
|---|---|
| bidPassport | LinkedHashMap<String, Object>: Returns the Passport document data after the scanning is completed. |
| signatureToken | String: A token which carries information about scanned Passport. This is used to verify if the Passport document is modified or not before storing it to BlockID blockchain platform. |
| error | ErrorManager.ErrorResponse: In case of error, an object of ErrorManager.ErrorResponse is returned. |