capacitor-v710-barcodescanner
v1.0.0
Published
Capacitor plugin for Handheld V710 barcode scanner (Android).
Readme
capacitor-v710-barcodescanner
Capacitor plugin for V710 barcode scanner (Android).
Install
npm install capacitor-v710-barcodescanner
npx cap syncAPI
available()registerScanningReceiver()unregisterScanningReceiver()registerScanDataReceiver()unregisterScanDataReceiver()addListener('scanningReceiver', ...)addListener('scanData', ...)unregisterAll()removeAllListeners()- Interfaces
available()
available() => Promise<{ value: boolean; }>Indicates whether the hardware/SDK is available. By convention in Capacitor, we return { value }.
Returns: Promise<{ value: boolean; }>
Since: 1.0.0
registerScanningReceiver()
registerScanningReceiver() => Promise<void>Registers the native receiver for scanner status.
Since: 1.0.0
unregisterScanningReceiver()
unregisterScanningReceiver() => Promise<void>Unregisters the native receiver for scanner status.
Since: 1.0.0
registerScanDataReceiver()
registerScanDataReceiver() => Promise<void>Registers the native receiver for scanner data.
Since: 1.0.0
unregisterScanDataReceiver()
unregisterScanDataReceiver() => Promise<void>Unregisters the native receiver for scanner data.
Since: 1.0.0
addListener('scanningReceiver', ...)
addListener(eventName: 'scanningReceiver', listenerFunc: (data: { active: boolean; }) => void) => Promise<PluginListenerHandle>Listener to receive scanner status.
| Param | Type |
| ------------------ | ---------------------------------------------------- |
| eventName | 'scanningReceiver' |
| listenerFunc | (data: { active: boolean; }) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
addListener('scanData', ...)
addListener(eventName: 'scanData', listenerFunc: (data: ScanData) => void) => Promise<PluginListenerHandle>Listener to receive scan data.
| Param | Type |
| ------------------ | ---------------------------------------------------------------- |
| eventName | 'scanData' |
| listenerFunc | (data: ScanData) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
unregisterAll()
unregisterAll() => Promise<void>Unregisters all native receivers.
Since: 1.0.0
removeAllListeners()
removeAllListeners() => Promise<void>Removes all listeners for all events.
Since: 1.0.0
Interfaces
PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| remove | () => Promise<void> |
ScanData
| Prop | Type |
| ---------------- | -------------------- |
| prefix | string |
| suffix | string |
| additional | boolean |
| clear | boolean |
| focusInput | boolean |
| data | string |
| type | string |
