@capgo/background-geolocation 8.0.31 → 8.0.33

package/dist/docs.json

@@ -137,6 +137,225 @@
         ],
         "slug": "setplannedroute"
       },
+      {
+        "name": "setupGeofencing",
+        "signature": "(options: GeofenceSetupOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The geofence configuration options",
+            "type": "GeofenceSetupOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The geofence configuration options"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves once geofencing is configured"
+          },
+          {
+            "name": "since",
+            "text": "8.0.30"
+          },
+          {
+            "name": "example",
+            "text": "await BackgroundGeolocation.setupGeofencing({\n  url: \"https://api.example.com/geofences\",\n  notifyOnEntry: true,\n  notifyOnExit: true,\n  payload: { userId: \"123\" }\n});"
+          }
+        ],
+        "docs": "Configures native geofence transition handling.\n\nCall this before adding geofences when you need native background POSTs\nor default entry/exit settings.",
+        "complexTypes": [
+          "GeofenceSetupOptions"
+        ],
+        "slug": "setupgeofencing"
+      },
+      {
+        "name": "addGeofence",
+        "signature": "(options: AddGeofenceOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The geofence region options",
+            "type": "AddGeofenceOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The geofence region options"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when native monitoring starts"
+          },
+          {
+            "name": "since",
+            "text": "8.0.30"
+          },
+          {
+            "name": "example",
+            "text": "await BackgroundGeolocation.addGeofence({\n  identifier: \"office\",\n  latitude: 40.7128,\n  longitude: -74.006,\n  radius: 150\n});"
+          }
+        ],
+        "docs": "Starts monitoring a circular native geofence.",
+        "complexTypes": [
+          "AddGeofenceOptions"
+        ],
+        "slug": "addgeofence"
+      },
+      {
+        "name": "removeGeofence",
+        "signature": "(options: RemoveGeofenceOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The geofence identifier",
+            "type": "RemoveGeofenceOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The geofence identifier"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when native monitoring stops"
+          },
+          {
+            "name": "since",
+            "text": "8.0.30"
+          },
+          {
+            "name": "example",
+            "text": "await BackgroundGeolocation.removeGeofence({ identifier: \"office\" });"
+          }
+        ],
+        "docs": "Stops monitoring one geofence.",
+        "complexTypes": [
+          "RemoveGeofenceOptions"
+        ],
+        "slug": "removegeofence"
+      },
+      {
+        "name": "removeAllGeofences",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise that resolves when all native geofences are removed"
+          },
+          {
+            "name": "since",
+            "text": "8.0.30"
+          },
+          {
+            "name": "example",
+            "text": "await BackgroundGeolocation.removeAllGeofences();"
+          }
+        ],
+        "docs": "Stops monitoring every geofence registered by this plugin.",
+        "complexTypes": [],
+        "slug": "removeallgeofences"
+      },
+      {
+        "name": "getMonitoredGeofences",
+        "signature": "() => Promise<MonitoredGeofencesResult>",
+        "parameters": [],
+        "returns": "Promise<MonitoredGeofencesResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise with monitored geofence identifiers"
+          },
+          {
+            "name": "since",
+            "text": "8.0.30"
+          },
+          {
+            "name": "example",
+            "text": "const { regions } = await BackgroundGeolocation.getMonitoredGeofences();"
+          }
+        ],
+        "docs": "Lists the geofence identifiers currently monitored by this plugin.",
+        "complexTypes": [
+          "MonitoredGeofencesResult"
+        ],
+        "slug": "getmonitoredgeofences"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'geofenceTransition', listenerFunc: (event: GeofenceTransitionEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'geofenceTransition'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: GeofenceTransitionEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.30"
+          },
+          {
+            "name": "example",
+            "text": "const handle = await BackgroundGeolocation.addListener(\n  \"geofenceTransition\",\n  (event) => console.log(event.identifier, event.transition)\n);"
+          }
+        ],
+        "docs": "Listens for geofence enter/exit transitions while the WebView is alive.\n\nNative `url` delivery configured through `setupGeofencing` is used for\nbackground-safe delivery.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "GeofenceTransitionEvent"
+        ],
+        "slug": "addlistenergeofencetransition-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'geofenceError', listenerFunc: (event: GeofenceErrorEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'geofenceError'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: GeofenceErrorEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.30"
+          },
+          {
+            "name": "example",
+            "text": "const handle = await BackgroundGeolocation.addListener(\n  \"geofenceError\",\n  (event) => console.error(event.identifier, event.message)\n);"
+          }
+        ],
+        "docs": "Listens for native geofence monitoring errors while the WebView is alive.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "GeofenceErrorEvent"
+        ],
+        "slug": "addlistenergeofenceerror-"
+      },
       {
         "name": "getPluginVersion",
         "signature": "() => Promise<{ version: string; }>",
@@ -518,9 +737,526 @@
           "type": "number"
         }
       ]
-    }
-  ],
-  "enums": [],
-  "typeAliases": [],
+    },
+    {
+      "name": "GeofenceSetupOptions",
+      "slug": "geofencesetupoptions",
+      "docs": "Options for configuring native geofence transition handling.\n\nWhen `url` is provided, native iOS and Android code sends a JSON `POST`\nwhenever a monitored region is entered or exited. This keeps geofence\nhandling useful when the WebView is suspended.",
+      "tags": [
+        {
+          "text": "8.0.30",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "\"https://api.example.com/geofences\"",
+              "name": "example"
+            }
+          ],
+          "docs": "Endpoint that receives geofence transition payloads.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "notifyOnEntry",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether entry transitions should be monitored.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "notifyOnExit",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether exit transitions should be monitored.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "payload",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "{ \"userId\": \"123\" }",
+              "name": "example"
+            }
+          ],
+          "docs": "Base JSON payload merged into every native transition POST and listener event.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        },
+        {
+          "name": "requestPermissions",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether the plugin should request the native location permission needed for geofencing.\n\niOS geofencing needs Always location authorization. Android background geofencing\nneeds foreground location and, on Android 10+, background location permission.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "AddGeofenceOptions",
+      "slug": "addgeofenceoptions",
+      "docs": "A circular geofence region.",
+      "tags": [
+        {
+          "text": "8.0.30",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "latitude",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "40.7128",
+              "name": "example"
+            }
+          ],
+          "docs": "Latitude in degrees for the region center.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "longitude",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "-74.006",
+              "name": "example"
+            }
+          ],
+          "docs": "Longitude in degrees for the region center.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "radius",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "50",
+              "name": "default"
+            },
+            {
+              "text": "150",
+              "name": "example"
+            }
+          ],
+          "docs": "Region radius in meters.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "identifier",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "\"office\"",
+              "name": "example"
+            }
+          ],
+          "docs": "Stable identifier for the geofence.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "notifyOnEntry",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            }
+          ],
+          "docs": "Overrides the setup-level entry setting for this region.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "notifyOnExit",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            }
+          ],
+          "docs": "Overrides the setup-level exit setting for this region.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "payload",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "{ \"storeId\": \"nyc-1\" }",
+              "name": "example"
+            }
+          ],
+          "docs": "Region-specific payload merged over the setup payload.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "RemoveGeofenceOptions",
+      "slug": "removegeofenceoptions",
+      "docs": "Options for removing a monitored geofence.",
+      "tags": [
+        {
+          "text": "8.0.30",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifier",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "\"office\"",
+              "name": "example"
+            }
+          ],
+          "docs": "Identifier passed to `addGeofence`.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "MonitoredGeofencesResult",
+      "slug": "monitoredgeofencesresult",
+      "docs": "Result returned when listing monitored geofences.",
+      "tags": [
+        {
+          "text": "8.0.30",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "regions",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "[\"office\", \"warehouse\"]",
+              "name": "example"
+            }
+          ],
+          "docs": "Identifiers for all geofences currently monitored by this plugin.",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "GeofenceTransitionEvent",
+      "slug": "geofencetransitionevent",
+      "docs": "Event emitted when a monitored geofence is entered or exited.\n\nThe same data is also sent to the configured `url`, when one is set.",
+      "tags": [
+        {
+          "text": "8.0.30",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifier",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "\"office\"",
+              "name": "example"
+            }
+          ],
+          "docs": "Identifier of the geofence that changed state.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "transition",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "\"enter\"",
+              "name": "example"
+            }
+          ],
+          "docs": "Transition name.",
+          "complexTypes": [],
+          "type": "'enter' | 'exit'"
+        },
+        {
+          "name": "enter",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "`true` for entry transitions, `false` for exit transitions.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "latitude",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "40.7128",
+              "name": "example"
+            }
+          ],
+          "docs": "Latitude in degrees for the monitored region center, when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "longitude",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "-74.006",
+              "name": "example"
+            }
+          ],
+          "docs": "Longitude in degrees for the monitored region center, when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "radius",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "150",
+              "name": "example"
+            }
+          ],
+          "docs": "Region radius in meters, when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "payload",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            }
+          ],
+          "docs": "Merged setup and region payload.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "GeofenceErrorEvent",
+      "slug": "geofenceerrorevent",
+      "docs": "Event emitted when native geofence monitoring fails.",
+      "tags": [
+        {
+          "text": "8.0.30",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifier",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "\"office\"",
+              "name": "example"
+            }
+          ],
+          "docs": "Identifier of the geofence that failed, when native APIs provide it.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "code",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            },
+            {
+              "text": "5",
+              "name": "example"
+            }
+          ],
+          "docs": "Native platform error code.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            }
+          ],
+          "docs": "Native platform error message.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "domain",
+          "tags": [
+            {
+              "text": "8.0.30",
+              "name": "since"
+            }
+          ],
+          "docs": "Native error domain, when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    }
+  ],
   "pluginConfigs": []
 }