npm package: @captureid/capacitor3-cidplugin
Description: Capacitor Plugin for CaptureID Library Family
Author: Uwe Hoppe P4IT GmbH & Co. KG
Latest version: 1.0.9

# @captureid/capacitor-cidplugin

Capacitor Plugin for CaptureID Library Family

## Install

```bash
npm install @captureid/capacitor-cidplugin
npx cap sync
```

## API

<docgen-index>

* [`initCaptureIDLib()`](#initcaptureidlib)
* [`showDeviceControlBar(...)`](#showdevicecontrolbar)
* [`activateLicense(...)`](#activatelicense)
* [`setConfiguration(...)`](#setconfiguration)
* [`enableRFIDSupport(...)`](#enablerfidsupport)
* [`enableCameraScanSupport(...)`](#enablecamerascansupport)
* [`enableScanSupport(...)`](#enablescansupport)
* [`enablePrintSupport(...)`](#enableprintsupport)
* [`enableBTScanSupport(...)`](#enablebtscansupport)
* [`startScanner()`](#startscanner)
* [`connectRFIDReader()`](#connectrfidreader)
* [`connectBTScanner()`](#connectbtscanner)
* [`selectBTScanner()`](#selectbtscanner)
* [`selectRFIDReader()`](#selectrfidreader)
* [`selectPrinter()`](#selectprinter)
* [`getPluginVersions()`](#getpluginversions)
* [`enableCIDControlBar(...)`](#enablecidcontrolbar)
* [`enableScanCommandButton(...)`](#enablescancommandbutton)
* [`addListener(string, ...)`](#addlistenerstring)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Enums](#enums)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### initCaptureIDLib()

```typescript
initCaptureIDLib() => void
```

--------------------


### showDeviceControlBar(...)

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

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ show: boolean; }</code> |

--------------------


### activateLicense(...)

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

| Param         | Type                                                   |
| ------------- | ------------------------------------------------------ |
| **`options`** | <code>{ productKey: string; customer: string; }</code> |

--------------------


### setConfiguration(...)

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

| Param         | Type                                                                             |
| ------------- | -------------------------------------------------------------------------------- |
| **`options`** | <code>{ config: <a href="#cidcontrolbarconfig">CIDControlBarConfig</a>; }</code> |

--------------------


### enableRFIDSupport(...)

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

| Param         | Type                              |
| ------------- | --------------------------------- |
| **`options`** | <code>{ enable: boolean; }</code> |

--------------------


### enableCameraScanSupport(...)

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

| Param         | Type                              |
| ------------- | --------------------------------- |
| **`options`** | <code>{ enable: boolean; }</code> |

--------------------


### enableScanSupport(...)

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

| Param         | Type                              |
| ------------- | --------------------------------- |
| **`options`** | <code>{ enable: boolean; }</code> |

--------------------


### enablePrintSupport(...)

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

| Param         | Type                              |
| ------------- | --------------------------------- |
| **`options`** | <code>{ enable: boolean; }</code> |

--------------------


### enableBTScanSupport(...)

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

| Param         | Type                              |
| ------------- | --------------------------------- |
| **`options`** | <code>{ enable: boolean; }</code> |

--------------------


### startScanner()

```typescript
startScanner() => Promise<void>
```

--------------------


### connectRFIDReader()

```typescript
connectRFIDReader() => Promise<void>
```

--------------------


### connectBTScanner()

```typescript
connectBTScanner() => Promise<void>
```

--------------------


### selectBTScanner()

```typescript
selectBTScanner() => Promise<void>
```

--------------------


### selectRFIDReader()

```typescript
selectRFIDReader() => Promise<void>
```

--------------------


### selectPrinter()

```typescript
selectPrinter() => Promise<void>
```

--------------------


### getPluginVersions()

```typescript
getPluginVersions() => Promise<LibraryVersionList>
```

**Returns:** <code>Promise&lt;<a href="#libraryversionlist">LibraryVersionList</a>&gt;</code>

--------------------


### enableCIDControlBar(...)

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

| Param         | Type                              |
| ------------- | --------------------------------- |
| **`options`** | <code>{ enable: boolean; }</code> |

--------------------


### enableScanCommandButton(...)

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

| Param         | Type                              |
| ------------- | --------------------------------- |
| **`options`** | <code>{ enable: boolean; }</code> |

--------------------


### addListener(string, ...)

```typescript
addListener(eventName: string, listenerFunc: (data: any) => void) => PluginListenerHandle
```

| Param              | Type                                |
| ------------------ | ----------------------------------- |
| **`eventName`**    | <code>string</code>                 |
| **`listenerFunc`** | <code>(data: any) =&gt; void</code> |

**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

--------------------


### removeAllListeners()

```typescript
removeAllListeners() => void
```

--------------------


### Interfaces


#### CIDControlBarConfig

| Prop              | Type                                                          |
| ----------------- | ------------------------------------------------------------- |
| **`fixed`**       | <code>boolean</code>                                          |
| **`enabled`**     | <code>boolean</code>                                          |
| **`visible`**     | <code>boolean</code>                                          |
| **`orientation`** | <code><a href="#cidorienatation">CIDOrienatation</a></code>   |
| **`command`**     | <code><a href="#commandbarconfig">CommandBarConfig</a></code> |
| **`control`**     | <code><a href="#controlbarconfig">ControlBarConfig</a></code> |


#### CommandBarConfig

| Prop                  | Type                         |
| --------------------- | ---------------------------- |
| **`backgroundColor`** | <code>string</code>          |
| **`buttons`**         | <code>CommandButton[]</code> |


#### CommandButton

| Prop             | Type                                                      |
| ---------------- | --------------------------------------------------------- |
| **`type`**       | <code>string</code>                                       |
| **`iconSource`** | <code>string</code>                                       |
| **`iconText`**   | <code>string</code>                                       |
| **`iconColor`**  | <code><a href="#buttoncolors">ButtonColors</a></code>     |
| **`visible`**    | <code>boolean</code>                                      |
| **`state`**      | <code><a href="#cidbuttonstate">CIDButtonState</a></code> |


#### ButtonColors

| Prop           | Type                                                            |
| -------------- | --------------------------------------------------------------- |
| **`enabled`**  | <code><a href="#buttonstatecolors">ButtonStateColors</a></code> |
| **`disabled`** | <code><a href="#buttonstatecolors">ButtonStateColors</a></code> |
| **`selected`** | <code><a href="#buttonstatecolors">ButtonStateColors</a></code> |


#### ButtonStateColors

| Prop             | Type                |
| ---------------- | ------------------- |
| **`background`** | <code>string</code> |
| **`icon`**       | <code>string</code> |


#### ControlBarConfig

| Prop                  | Type                         |
| --------------------- | ---------------------------- |
| **`backgroundColor`** | <code>string</code>          |
| **`buttonwidth`**     | <code>number</code>          |
| **`buttons`**         | <code>CommandButton[]</code> |


#### LibraryVersionList

| Prop            | Type                          |
| --------------- | ----------------------------- |
| **`libraries`** | <code>LibraryVersion[]</code> |


#### LibraryVersion

| Prop          | Type                |
| ------------- | ------------------- |
| **`name`**    | <code>string</code> |
| **`version`** | <code>string</code> |


#### PluginListenerHandle

| Prop         | Type                                      |
| ------------ | ----------------------------------------- |
| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |


### Enums


#### CIDOrienatation

| Members      | Value          |
| ------------ | -------------- |
| **`LEFT`**   | <code>1</code> |
| **`TOP`**    | <code>2</code> |
| **`RIGHT`**  | <code>3</code> |
| **`BOTTOM`** | <code>4</code> |


#### CIDButtonState

| Members        | Value          |
| -------------- | -------------- |
| **`ENABLED`**  | <code>0</code> |
| **`DISABLED`** | <code>1</code> |
| **`ACTIVE`**   | <code>2</code> |

</docgen-api>