Method Detail

• getRequiredPermissions

   final List<String> getRequiredPermissions(Boolean includeBluetooth)

  The dangerous runtime permissions the SDK needs on the current device, version-gated. Foreground set only — it deliberately EXCLUDES Manifest.permission.ACCESS_BACKGROUND_LOCATION, which Android 11+ requires be requested separately and only after foreground location is granted (see requestBackgroundLocationPermission).

  Pass this to your own ActivityResultContracts.RequestMultiplePermissions launcher, or use requestPermissions.

  Parameters:

  includeBluetooth - include BLUETOOTH_SCAN (Android 12+) for BLE collection.

• hasRequiredPermissions

   final Boolean hasRequiredPermissions(Context context, Boolean includeBluetooth)

  True when every foreground permission the SDK needs is currently granted. includeBluetooth defaults to false here — unlike the request methods, which request Bluetooth by default — because Bluetooth is optional: a denied "Nearby devices" grant must not make the SDK appear unusable. Pass true only when you specifically want to verify the BLE scan grant as well.

• hasBackgroundLocationPermission

   final Boolean hasBackgroundLocationPermission(Context context)

  True when Manifest.permission.ACCESS_BACKGROUND_LOCATION is granted (always true below API 29, where the permission does not exist as a separate grant).

• requestPermissions

   final List<String> requestPermissions(Activity activity, Integer requestCode, Boolean includeBluetooth)

  Request the SDK's foreground runtime permissions from activity. Only the not-yet-granted permissions are requested; the grant result is delivered to the activity's onRequestPermissionsResult(requestCode, ...). To keep collecting while the host app is backgrounded, follow up with requestBackgroundLocationPermission once foreground location is granted.

  Parameters:

  includeBluetooth - also request BLUETOOTH_SCAN (Android 12+).

• requestBackgroundLocationPermission

   final Boolean requestBackgroundLocationPermission(Activity activity, Integer requestCode)

  Request Manifest.permission.ACCESS_BACKGROUND_LOCATION (Android 10+), required to keep collecting when the host app is backgrounded / screen-off. Call this ONLY after foreground location is already granted — on Android 11+ the OS routes this request to a Settings screen ("Allow all the time"). No-op below API 29 or when already granted; the result (when a dialog is shown) arrives at the activity's onRequestPermissionsResult(requestCode, ...).

• init

   final Unit init(Context context, String notificationTitle, String notificationText, Function1<Result<Unit>, Unit> callback)

• startDeliveryByPlaceID

   final Unit startDeliveryByPlaceID(String placeID, String deliveryId, Function1<Result<String>, Unit> callback)

• startDeliveryByPlaceID

   final Unit startDeliveryByPlaceID(String placeID, String deliveryId, Double timeoutSeconds, Boolean manualForeground, Double autoStopAfterDropoffSeconds, String customerId, String driverId, Function1<Result<String>, Unit> callback)

• retryGnssCallbacks

   final Unit retryGnssCallbacks()

  Retry GNSS callback registration after permissions have been granted. Call this after the user grants location permissions to enable GNSS data collection.

• startDeliveryByPlusCode

  @Deprecated(message = Use startDeliveryByAddressString(address, deliveryId, coordinates, timeoutSeconds, callback) instead.) final Unit startDeliveryByPlusCode(String plusCode, String deliveryId, Function1<Result<String>, Unit> callback)

• startDeliveryByPlusCode

  @Deprecated(message = Use startDeliveryByAddressString(address, deliveryId, coordinates, timeoutSeconds, callback) instead.) final Unit startDeliveryByPlusCode(String plusCode, String deliveryId, Double timeoutSeconds, String customerId, String driverId, Function1<Result<String>, Unit> callback)

• startDeliveryByAddressString

   final Unit startDeliveryByAddressString(String address, String deliveryId, Function1<Result<String>, Unit> callback)

• startDeliveryByAddressString

   final Unit startDeliveryByAddressString(String address, String deliveryId, Double timeoutSeconds, Function1<Result<String>, Unit> callback)

• startDeliveryByAddressString

   final Unit startDeliveryByAddressString(String address, String deliveryId, LatLngObject coordinates, Double timeoutSeconds, Boolean manualForeground, Double autoStopAfterDropoffSeconds, String customerId, String driverId, Function1<Result<String>, Unit> callback)

• startDeliveryByLatLng

  @Deprecated(message = Use startDeliveryByAddressType(...) or startDeliveryByAddressString(...) with coordinates instead.) final Unit startDeliveryByLatLng(Double latitude, Double longitude, String deliveryId, Function1<Result<String>, Unit> callback)

• startDeliveryByLatLng

  @Deprecated(message = Use startDeliveryByAddressType(...) or startDeliveryByAddressString(...) with coordinates instead.) final Unit startDeliveryByLatLng(Double latitude, Double longitude, String subUnit, String deliveryId, Double timeoutSeconds, String customerId, String driverId, Function1<Result<String>, Unit> callback)

• startDeliveryByAddressType

   final Unit startDeliveryByAddressType(AddressType address, String deliveryId, Function1<Result<String>, Unit> callback)

• startDeliveryByAddressType

   final Unit startDeliveryByAddressType(AddressType address, String deliveryId, Double timeoutSeconds, Function1<Result<String>, Unit> callback)

• startDeliveryByAddressType

   final Unit startDeliveryByAddressType(AddressType address, String deliveryId, LatLngObject coordinates, Double timeoutSeconds, Boolean manualForeground, Double autoStopAfterDropoffSeconds, String customerId, String driverId, Function1<Result<String>, Unit> callback)

• newEvent

   final Unit newEvent(String eventName, String deliveryId, Double timestamp, Function1<Result<String>, Unit> callback)

• newEvent

   final Unit newEvent(String eventName, String deliveryId, Double timestamp)

• markDropoff

   final Unit markDropoff(String deliveryId, DropoffType dropoffType)

• stopDelivery

   final Unit stopDelivery(String deliveryId)

  Stop a delivery. If an auto-stop delay is configured for it (the autoStopAfterDropoffSeconds argument to startDelivery*, or misc.autoStopAfterDropoffSeconds from server config), the actual teardown is DEFERRED by that many seconds — collection continues, then a Doze-safe alarm fires the real stop. A second stopDelivery during the delay is a no-op. No delay -> stops now.

• startRouteGeofencing

   final Unit startRouteGeofencing(List<DeliveryStop> stops, RouteGeofenceOptions options, Function1<Result<Unit>, Unit> callback)

  Begin in-SDK route geofencing for stops. The SDK fences each stop and auto-starts/stops sessions on enter/exit (exit gated on markDropoff). Requires location permission; for background operation also requires ACCESS_BACKGROUND_LOCATION ("Allow all the time").

• updateRouteStops

   final Unit updateRouteStops(List<DeliveryStop> stops, Function1<Result<Unit>, Unit> callback)

  Replace the active route's stop set mid-route (add/remove). Re-diffs geofence registration.

• stopRouteGeofencing

   final Unit stopRouteGeofencing()

  Stop route geofencing: clear all geofences, stop any active route sessions, end the service.

• resumeRouteGeofencingIfNeeded

   final Unit resumeRouteGeofencingIfNeeded()

  Idempotent restore of route geofencing from persisted state. The host should call this on every launch (including OS-initiated background relaunches) so the SDK re-asserts monitoring without the host re-supplying the stop list. No-op if no route is active.

• setAPIKey

   final Unit setAPIKey(String key, Boolean shouldGetConfig)

  Set the bearer token used by every Network call and (by default) trigger an immediate config fetch.

  Parameters:

  key - the JWT to send as Authorization: Bearer <key>.

  shouldGetConfig - when true (default) the SDK kicks off a config fetch right now — typical production flow, so motion / location / fields config is ready before the host calls startDeliveryByX(...).

• enableDevMode

   final Boolean enableDevMode()

  Securely enables dev mode after validating the API token. This function checks if the current API key has dev mode privileges before enabling it.

• validateDevModeAccess

   final Boolean validateDevModeAccess()

  Validates whether the current API key has dev mode privileges without changing devMode state.

• disableDevMode

   final Unit disableDevMode()

  Disables dev mode safely. This is the only way to disable dev mode since devMode has a private setter.

• getDevMode

   final Boolean getDevMode()

• setDevMode

   final Unit setDevMode(Boolean devMode)

• getManualForeground

   final Boolean getManualForeground()

  When true, the SDK will NOT promote its internal TrackingService to the foreground. It expects the host app to already be running a foreground service that keeps the process alive for background tracking. Exposed read-only to the host app; set per-delivery via the startDeliveryByX(...) functions and persisted to SharedPreferences so TrackingService can read it after process recreation.

• setManualForeground

   final Unit setManualForeground(Boolean manualForeground)

• getAutoStopAfterDropoffSeconds

   final Double getAutoStopAfterDropoffSeconds()

  Host-app override for the post-dropoff auto-stop timer, in seconds.

  • If null (default), the SDK falls back to the value in remote config (com.doorstepai.sdks.tracking.internal.MiscConfiguration.autoStopAfterDropoffSeconds).

  • If non-null, this value ALWAYS wins over remote config.

  • If the resolved value is null or <= 0, no auto-stop is scheduled.

  When scheduled, the timer is backed by android.app.AlarmManager with setAndAllowWhileIdle, so it is Doze-safe and reliable for long values (10 minutes up to several hours). It does NOT require the SCHEDULE_EXACT_ALARM permission.

  Exposed read-only to the host app; set per-delivery via the startDeliveryByX(...) functions.

• setAutoStopAfterDropoffSeconds

   final Unit setAutoStopAfterDropoffSeconds(Double autoStopAfterDropoffSeconds)

• getPERMISSION_REQUEST_CODE

   final Integer getPERMISSION_REQUEST_CODE()

  Request code used by requestPermissions when the caller doesn't supply one.

• getBACKGROUND_LOCATION_REQUEST_CODE

   final Integer getBACKGROUND_LOCATION_REQUEST_CODE()

  Request code used by requestBackgroundLocationPermission when none is supplied.

• getGeofenceSessionEvents

   final Flow<GeofenceSessionEvent> getGeofenceSessionEvents()

  Hot stream of route-geofencing session start/stop events, so the host can update UI without polling. Replays the most recent event to late subscribers.

• getMonitoredStops

   final List<DeliveryStop> getMonitoredStops()

• getConfigFetched

   final Flow<Long> getConfigFetched()

  Hot stream of "config fetch succeeded" events. Each emission carries the wall-clock timestamp (ms since epoch) of the successful landing. Replays the most recent value so a late subscriber sees the current state immediately. Useful for surfacing "Config fetched at HH:mm:ss" in a host-app status panel without poking at SDK internals.