1.0.32 • Published 1 month ago

@captureid/capacitor5-cidplugin v1.0.32

Weekly downloads
-
License
MIT
Repository
github
Last release
1 month ago

@captureid/capacitor-cidplugin

Capacitor Plugin for CaptureID Library Family

Install

npm install @captureid/capacitor-cidplugin
npx cap sync

API

initCaptureIDLib()

initCaptureIDLib() => void

showDeviceControlBar(...)

showDeviceControlBar(options: { show: boolean; }) => void
ParamType
options{ show: boolean; }

activateLicense(...)

activateLicense(options: { productKey: string; customer: string; }) => void
ParamType
options{ productKey: string; customer: string; }

setConfiguration(...)

setConfiguration(options: { config: CIDControlBarConfig; }) => void
ParamType
options{ config: CIDControlBarConfig; }

enableRFIDSupport(...)

enableRFIDSupport(options: { enable: boolean; }) => void
ParamType
options{ enable: boolean; }

enableCameraScanSupport(...)

enableCameraScanSupport(options: { enable: boolean; }) => void
ParamType
options{ enable: boolean; }

enableScanSupport(...)

enableScanSupport(options: { enable: boolean; }) => void
ParamType
options{ enable: boolean; }

enablePrintSupport(...)

enablePrintSupport(options: { enable: boolean; }) => void
ParamType
options{ enable: boolean; }

enableBTScanSupport(...)

enableBTScanSupport(options: { enable: boolean; }) => void
ParamType
options{ enable: boolean; }

startScanner()

startScanner() => Promise<void>

connectRFIDReader()

connectRFIDReader() => Promise<void>

connectBTScanner()

connectBTScanner() => Promise<void>

selectBTScanner()

selectBTScanner() => Promise<void>

selectRFIDReader()

selectRFIDReader() => Promise<void>

selectPrinter()

selectPrinter() => Promise<void>

getPluginVersions()

getPluginVersions() => Promise<LibraryVersionList>

Returns: Promise<LibraryVersionList>


enableCIDControlBar(...)

enableCIDControlBar(options: { enable: boolean; }) => void
ParamType
options{ enable: boolean; }

enableScanCommandButton(...)

enableScanCommandButton(options: { enable: boolean; }) => void
ParamType
options{ enable: boolean; }

addListener(string, ...)

addListener(eventName: string, listenerFunc: (data: any) => void) => PluginListenerHandle
ParamType
eventNamestring
listenerFunc(data: any) => void

Returns: PluginListenerHandle


removeAllListeners()

removeAllListeners() => void

Interfaces

CIDControlBarConfig

PropType
fixedboolean
enabledboolean
visibleboolean
orientationCIDOrienatation
commandCommandBarConfig
controlControlBarConfig

CommandBarConfig

PropType
backgroundColorstring
buttonsCommandButton[]

CommandButton

PropType
typestring
iconSourcestring
iconTextstring
iconColorButtonColors
visibleboolean
stateCIDButtonState

ButtonColors

PropType
enabledButtonStateColors
disabledButtonStateColors
selectedButtonStateColors

ButtonStateColors

PropType
backgroundstring
iconstring

ControlBarConfig

PropType
backgroundColorstring
buttonwidthnumber
buttonsCommandButton[]

LibraryVersionList

PropType
librariesLibraryVersion[]

LibraryVersion

PropType
namestring
versionstring

PluginListenerHandle

PropType
remove() => Promise<void>

Enums

CIDOrienatation

MembersValue
LEFT1
TOP2
RIGHT3
BOTTOM4

CIDButtonState

MembersValue
ENABLED0
DISABLED1
ACTIVE2
1.0.29

1 month ago

1.0.28

1 month ago

1.0.27

1 month ago

1.0.32

1 month ago

1.0.31

1 month ago

1.0.30

1 month ago

1.0.26

1 month ago

1.0.25

1 month ago

1.0.24

1 month ago

1.0.23

6 months ago

1.0.22

7 months ago

1.0.21

7 months ago