@capgo/capacitor-ibeacon 7.0.0

package/dist/docs.json

@@ -0,0 +1,542 @@
+{
+  "api": {
+    "name": "CapacitorIbeaconPlugin",
+    "slug": "capacitoribeaconplugin",
+    "docs": "Capacitor iBeacon Plugin - Proximity detection and beacon region monitoring.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "startMonitoringForRegion",
+        "signature": "(options: BeaconRegion) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Region to monitor",
+            "type": "BeaconRegion"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Region to monitor"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when monitoring starts"
+          },
+          {
+            "name": "throws",
+            "text": "Error if monitoring fails to start"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorIbeacon.startMonitoringForRegion({\n  identifier: 'MyBeaconRegion',\n  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'\n});\n```"
+          }
+        ],
+        "docs": "Start monitoring for a beacon region. Triggers events when entering/exiting the region.",
+        "complexTypes": [
+          "BeaconRegion"
+        ],
+        "slug": "startmonitoringforregion"
+      },
+      {
+        "name": "stopMonitoringForRegion",
+        "signature": "(options: BeaconRegion) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Region to stop monitoring",
+            "type": "BeaconRegion"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Region to stop monitoring"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when monitoring stops"
+          },
+          {
+            "name": "throws",
+            "text": "Error if stopping monitoring fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorIbeacon.stopMonitoringForRegion({\n  identifier: 'MyBeaconRegion',\n  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'\n});\n```"
+          }
+        ],
+        "docs": "Stop monitoring for a beacon region.",
+        "complexTypes": [
+          "BeaconRegion"
+        ],
+        "slug": "stopmonitoringforregion"
+      },
+      {
+        "name": "startRangingBeaconsInRegion",
+        "signature": "(options: BeaconRegion) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Region to range beacons in",
+            "type": "BeaconRegion"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Region to range beacons in"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when ranging starts"
+          },
+          {
+            "name": "throws",
+            "text": "Error if ranging fails to start"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorIbeacon.startRangingBeaconsInRegion({\n  identifier: 'MyBeaconRegion',\n  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'\n});\n```"
+          }
+        ],
+        "docs": "Start ranging beacons in a region. Provides continuous distance updates.",
+        "complexTypes": [
+          "BeaconRegion"
+        ],
+        "slug": "startrangingbeaconsinregion"
+      },
+      {
+        "name": "stopRangingBeaconsInRegion",
+        "signature": "(options: BeaconRegion) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Region to stop ranging beacons in",
+            "type": "BeaconRegion"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Region to stop ranging beacons in"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when ranging stops"
+          },
+          {
+            "name": "throws",
+            "text": "Error if stopping ranging fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorIbeacon.stopRangingBeaconsInRegion({\n  identifier: 'MyBeaconRegion',\n  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'\n});\n```"
+          }
+        ],
+        "docs": "Stop ranging beacons in a region.",
+        "complexTypes": [
+          "BeaconRegion"
+        ],
+        "slug": "stoprangingbeaconsinregion"
+      },
+      {
+        "name": "startAdvertising",
+        "signature": "(options: BeaconAdvertisingOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Beacon advertising parameters",
+            "type": "BeaconAdvertisingOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Beacon advertising parameters"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when advertising starts"
+          },
+          {
+            "name": "throws",
+            "text": "Error if advertising fails to start or on Android"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "platform",
+            "text": "iOS"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorIbeacon.startAdvertising({\n  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',\n  major: 1,\n  minor: 2,\n  identifier: 'MyBeacon'\n});\n```"
+          }
+        ],
+        "docs": "Start advertising the device as an iBeacon (iOS only).",
+        "complexTypes": [
+          "BeaconAdvertisingOptions"
+        ],
+        "slug": "startadvertising"
+      },
+      {
+        "name": "stopAdvertising",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when advertising stops"
+          },
+          {
+            "name": "throws",
+            "text": "Error if stopping advertising fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "platform",
+            "text": "iOS"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorIbeacon.stopAdvertising();\n```"
+          }
+        ],
+        "docs": "Stop advertising the device as an iBeacon (iOS only).",
+        "complexTypes": [],
+        "slug": "stopadvertising"
+      },
+      {
+        "name": "requestWhenInUseAuthorization",
+        "signature": "() => Promise<{ status: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ status: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with authorization status"
+          },
+          {
+            "name": "throws",
+            "text": "Error if request fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { status } = await CapacitorIbeacon.requestWhenInUseAuthorization();\nconsole.log('Authorization status:', status);\n```"
+          }
+        ],
+        "docs": "Request \"When In Use\" location authorization (required for ranging/monitoring).",
+        "complexTypes": [],
+        "slug": "requestwheninuseauthorization"
+      },
+      {
+        "name": "requestAlwaysAuthorization",
+        "signature": "() => Promise<{ status: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ status: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with authorization status"
+          },
+          {
+            "name": "throws",
+            "text": "Error if request fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { status } = await CapacitorIbeacon.requestAlwaysAuthorization();\nconsole.log('Authorization status:', status);\n```"
+          }
+        ],
+        "docs": "Request \"Always\" location authorization (required for background monitoring).",
+        "complexTypes": [],
+        "slug": "requestalwaysauthorization"
+      },
+      {
+        "name": "getAuthorizationStatus",
+        "signature": "() => Promise<{ status: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ status: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with authorization status"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting status fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { status } = await CapacitorIbeacon.getAuthorizationStatus();\nconsole.log('Current status:', status);\n```"
+          }
+        ],
+        "docs": "Get current location authorization status.",
+        "complexTypes": [],
+        "slug": "getauthorizationstatus"
+      },
+      {
+        "name": "isBluetoothEnabled",
+        "signature": "() => Promise<{ enabled: boolean; }>",
+        "parameters": [],
+        "returns": "Promise<{ enabled: boolean; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with Bluetooth state"
+          },
+          {
+            "name": "throws",
+            "text": "Error if checking state fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { enabled } = await CapacitorIbeacon.isBluetoothEnabled();\nif (!enabled) {\n  console.log('Please enable Bluetooth');\n}\n```"
+          }
+        ],
+        "docs": "Check if Bluetooth is enabled on the device.",
+        "complexTypes": [],
+        "slug": "isbluetoothenabled"
+      },
+      {
+        "name": "isRangingAvailable",
+        "signature": "() => Promise<{ available: boolean; }>",
+        "parameters": [],
+        "returns": "Promise<{ available: boolean; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with availability status"
+          },
+          {
+            "name": "throws",
+            "text": "Error if checking availability fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { available } = await CapacitorIbeacon.isRangingAvailable();\nif (available) {\n  console.log('Ranging is supported');\n}\n```"
+          }
+        ],
+        "docs": "Check if ranging is available on the device.",
+        "complexTypes": [],
+        "slug": "israngingavailable"
+      },
+      {
+        "name": "enableARMAFilter",
+        "signature": "(options: { enabled: boolean; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- ARMA filter configuration",
+            "type": "{ enabled: boolean; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - ARMA filter configuration"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when filter is configured"
+          },
+          {
+            "name": "throws",
+            "text": "Error if configuration fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "platform",
+            "text": "Android"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorIbeacon.enableARMAFilter({\n  enabled: true\n});\n```"
+          }
+        ],
+        "docs": "Enable ARMA filtering for distance calculations (Android only).",
+        "complexTypes": [],
+        "slug": "enablearmafilter"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await CapacitorIbeacon.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "BeaconRegion",
+      "slug": "beaconregion",
+      "docs": "Beacon region definition for monitoring and ranging.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifier",
+          "tags": [],
+          "docs": "Unique identifier for this region.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "uuid",
+          "tags": [],
+          "docs": "UUID of the beacon(s) to detect.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "major",
+          "tags": [],
+          "docs": "Major value for filtering (optional).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "minor",
+          "tags": [],
+          "docs": "Minor value for filtering (optional).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "notifyEntryStateOnDisplay",
+          "tags": [],
+          "docs": "Notify when device enters region (iOS only).",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "BeaconAdvertisingOptions",
+      "slug": "beaconadvertisingoptions",
+      "docs": "Beacon advertising options for transmitting as an iBeacon (iOS only).",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "uuid",
+          "tags": [],
+          "docs": "UUID to advertise.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "major",
+          "tags": [],
+          "docs": "Major value (0-65535).",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "minor",
+          "tags": [],
+          "docs": "Minor value (0-65535).",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "identifier",
+          "tags": [],
+          "docs": "Identifier for the advertising beacon.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "measuredPower",
+          "tags": [],
+          "docs": "Measured power (RSSI at 1 meter). Optional, defaults to -59.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}