Skip to main content

init()

Initialize the Aila SDK with configuration options.

AilaCordovaPlugin.init(params)

Parameters

  • params (Object) - Configuration object with the following properties:
    • multiScanMode (String, optional) - Multi-scan mode setting
    • duplicateFilter (String, optional) - Duplicate filtering mode
    • gs1ParsingMode (String, optional) - GS1 parsing mode
    • upceExpansionMode (String, optional) - UPC-E expansion mode
    • beepMode (String, optional) - Automatic beep mode
    • focusMode (String, optional) - Camera focus algorithm
    • id1CardDetectionMode (String, optional) - ID-1 card detection mode
    • imageCaptureDebugMode (String, optional) - Image capture debug mode
    • rsm (String, optional) - Remote status monitoring mode
    • powerManagementMode (String, optional) - Power management mode
    • mrzMode (String, optional) - MRZ scanning mode
    • mrzDetectionMode (String, optional) - MRZ detection mode
    • dlParsingMode (String, optional) - Driver's license parsing mode
    • enabledCameraPosition (String, optional) - Camera position selection
    • cloudLicensing (String, optional) - Cloud licensing mode
    • debugLevel (String, optional) - Logging verbosity level
    • codesConfiguration (Array, optional) - Array of barcode type configurations
      • type (String) - Code type constant
      • enabled (Boolean) - Whether the code type is enabled

Returns

Promise that resolves when initialization is complete.

Example

const AilaSDK = cordova.plugins.AilaCordovaPlugin;
const constants = cordova.plugins.AilaSDKConstants;

AilaSDK.init({
multiScanMode: constants.multiScanMode.AilaMultiScanModeOff,
duplicateFilter: constants.duplicateFilter.AilaDuplicateFilterOff,
beepMode: constants.beepMode.AilaBeepModeOff,
mrzMode: constants.mrzMode.AilaMRZModeOff,
codesConfiguration: [
{
type: constants.AilaCodeType.AilaCodeTypeQR,
enabled: true
},
{
type: constants.AilaCodeType.AilaCodeType128,
enabled: true
}
]
}).then(() => {
console.log('SDK initialized successfully');
}).catch((error) => {
console.error('Initialization failed:', error);
});

Notes

  • Initialize the SDK early in your app lifecycle, typically in the deviceready event handler
  • After initialization, call readLicense() to load your license key
  • You can update configuration later using setConfig()