npm package: @neosyn-ee/capacitor-ibeacon
Description: The plugin is designed to detect iBeacons in proximity, retrieve their metadata (UUID, major, minor, RSSI, estimated accuracy, and proximity), and notify the application when entering or exiting iBeacon regions.
Author: Rossella Mascia
Latest version: 1.0.6

# capacitor-ibeacon

The plugin is designed to detect iBeacons in proximity, retrieve their metadata (UUID, major, minor, RSSI, estimated accuracy, and proximity), and notify the application when entering or exiting iBeacon regions.

## Install

```bash
npm install capacitor-ibeacon
npx cap sync
```

## API

<docgen-index>

* [`startMonitoring(...)`](#startmonitoring)
* [`stopMonitoring(...)`](#stopmonitoring)
* [`stopAllMonitoring()`](#stopallmonitoring)
* [`addListener('onBeaconsRanged', ...)`](#addlisteneronbeaconsranged-)
* [`addListener('onRegionEntered', ...)`](#addlisteneronregionentered-)
* [`addListener('onRegionExited', ...)`](#addlisteneronregionexited-)
* [`checkAuthorizationStatus()`](#checkauthorizationstatus)
* [`requestPermissions()`](#requestpermissions)
* [Interfaces](#interfaces)

</docgen-index>

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

### startMonitoring(...)

```typescript
startMonitoring(options: { uuidString: string; major?: number; minor?: number; }) => Promise<void>
```

| Param         | Type                                                                 |
| ------------- | -------------------------------------------------------------------- |
| **`options`** | <code>{ uuidString: string; major?: number; minor?: number; }</code> |

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


### stopMonitoring(...)

```typescript
stopMonitoring(options: { uuid: string; }) => Promise<void>
```

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

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


### stopAllMonitoring()

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

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


### addListener('onBeaconsRanged', ...)

```typescript
addListener(eventName: 'onBeaconsRanged', listenerFunc: (info: { beacons: BeaconInfo[]; }) => void) => PluginListenerHandle
```

| Param              | Type                                                       |
| ------------------ | ---------------------------------------------------------- |
| **`eventName`**    | <code>'onBeaconsRanged'</code>                             |
| **`listenerFunc`** | <code>(info: { beacons: BeaconInfo[]; }) =&gt; void</code> |

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

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


### addListener('onRegionEntered', ...)

```typescript
addListener(eventName: 'onRegionEntered', listenerFunc: (info: { identifier: string; }) => void) => PluginListenerHandle
```

| Param              | Type                                                    |
| ------------------ | ------------------------------------------------------- |
| **`eventName`**    | <code>'onRegionEntered'</code>                          |
| **`listenerFunc`** | <code>(info: { identifier: string; }) =&gt; void</code> |

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

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


### addListener('onRegionExited', ...)

```typescript
addListener(eventName: 'onRegionExited', listenerFunc: (info: { identifier: string; }) => void) => PluginListenerHandle
```

| Param              | Type                                                    |
| ------------------ | ------------------------------------------------------- |
| **`eventName`**    | <code>'onRegionExited'</code>                           |
| **`listenerFunc`** | <code>(info: { identifier: string; }) =&gt; void</code> |

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

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


### checkAuthorizationStatus()

```typescript
checkAuthorizationStatus() => Promise<{ status: string; }>
```

**Returns:** <code>Promise&lt;{ status: string; }&gt;</code>

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


### requestPermissions()

```typescript
requestPermissions() => Promise<{ authorized: boolean; }>
```

**Returns:** <code>Promise&lt;{ authorized: boolean; }&gt;</code>

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


### Interfaces


#### PluginListenerHandle

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


#### BeaconInfo

| Prop             | Type                                                                       |
| ---------------- | -------------------------------------------------------------------------- |
| **`uuid`**       | <code>string</code>                                                        |
| **`major`**      | <code>number</code>                                                        |
| **`minor`**      | <code>number</code>                                                        |
| **`proximity`**  | <code>'Unknown' \| 'Immediate' \| 'Near' \| 'Far' \| 'NotRecovered'</code> |
| **`accuracy`**   | <code>number</code>                                                        |
| **`rssi`**       | <code>number</code>                                                        |
| **`macAddress`** | <code>string</code>                                                        |

</docgen-api>