API reference
The same shape on every platform: 12 core methods, plus diagnostics, license, and permissions, and one stream per feature. Names are identical across Android, iOS, Flutter, and React Native — only the language syntax differs.
Methods
Section titled “Methods”| Method | What it does |
|---|---|
configure(config) | Apply settings (optional; may be called while tracking to live-tune). |
start() | Begin tracking. Never throws — observe state. |
stop() | Stop tracking. |
getCurrentLocation(timeout?, accuracy?) | One immediate fix, independent of tracking. null on timeout. |
getLocations(from, to) | Read stored history in a range. |
deleteLocations(before?) | Delete history (all if omitted); returns rows removed. |
sync() | Force an immediate upload. |
setExtras(extras) | Custom string → string fields sent with every upload. |
pendingUploadCount() | Locations not yet uploaded. |
addGeofences(geofences) | Register circular regions. |
removeGeofences(ids) | Unregister by id. |
listGeofences() | The current geofence set. |
getPermissionStatus() | Current location-permission grant. Read-only; never prompts. |
getLog / exportLog / clearLog / setLogLevel / log | Diagnostics & troubleshooting. |
licenseStatus() | Current license status (observational). |
resumeIfNeeded() | Resume a session active before the process was killed (wrappers; native resumes automatically). |
Streams
Section titled “Streams”One observable per feature — subscribe the way that’s idiomatic (Android Flow/StateFlow, iOS AsyncStream, wrappers on* subscriptions):
| Stream | Delivers |
|---|---|
state | Idle → Tracking → Stopped(reason) transitions. |
locations | Each admitted fix, live. |
geofenceEvents | Enter / exit crossings. |
syncStatus | Upload progress and outcomes. |
authChanges | Token rotations from native refresh. |
licenseStatusUpdates | License status transitions. |
logs | Diagnostic log entries, live. |
Generated per-platform reference
Section titled “Generated per-platform reference”Full, generated API docs with every type and signature:
iOS — DocC BeekonKit reference.
Android — Dokka Kotlin reference.
iOS SDK source Swift source on GitHub.
Android SDK source Kotlin source on GitHub.
Flutter — pub.dev Dartdoc for beekon_flutter.
Flutter SDK source Dart plugin on GitHub.
React Native — npm @wayq/beekon-rn, fully typed.
React Native SDK source TurboModule on GitHub.