API Reference

Complete reference for all Aila SDK methods and properties. Each method is documented on its own page in the sidebar.

Quick Start

import AilaSDK from 'react-native-aila-sdk';

// Initialize SDK
const { multiScanMode, beepMode } = AilaSDK.getConstants();

await AilaSDK.init({
  multiScanMode: multiScanMode.AilaMultiScanModeOn,
  beepMode: beepMode.AilaBeepModeOff,
});

// Activate license
AilaSDK.readLicense('your-license-key-here');

// Listen for scans
AilaSDK.onScan((event) => {
  console.log('Scanned:', event.scanText);
});

// Start scanning
AilaSDK.startScanning();

Method Categories

Initialization & Configuration

• init() - Initialize the SDK
• setConfiguration() - Update configuration
• readLicense() - Activate license
• setLicenseProfile() - Set cloud licensing profile
• getConstants() - Get SDK constants

Scanning Operations

• startScanning() - Begin scanning
• stopScanning() - Stop scanning
• resetScan() - Reset for next scan

Camera & Capture

• enableCamera() - Enable camera
• disableCamera() - Disable camera
• capturePhoto() - Capture card image

Hardware Control

• enableSpeaker() - Enable speaker
• disableSpeaker() - Disable speaker
• beep() - Trigger beep and flash
• overrideLightLevels() - Control LED intensity
• overrideLightTimeout() - Control light timeout

Device Information

• getSDKVersion() - Get SDK version
• getFirmwareVersionNumber() - Get firmware version
• getSerialNumber() - Get serial number
• getHardwareDescription() - Get hardware description
• getHardwareClass() - Get hardware class
• getConnectionInfo() - Get connection info
• getChargerWattage() - Get charger wattage
• getSDKLicenseInfo() - Get license info
• comsTest() - Test RSM connectivity

Events

• onScan - Scan complete event
• onMRZDetected - MRZ detected event
• onHardwareChange - Hardware connection change
• onId1CardCapture - Card capture complete
• onId1CardDetected - Card detected in tray
• onMotionDetected - Motion detected
• onSessionLost - Session lost