Method Detail

• 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, Function1<Result<String>, Unit> callback)

• 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, 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, 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, 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, Function1<Result<String>, Unit> callback)

• newEvent

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

• newEvent

   final Unit newEvent(String eventName, String deliveryId)

• markDropoff

   final Unit markDropoff(String deliveryId, DropoffType dropoffType)

• stopDelivery

   final Unit stopDelivery(String deliveryId)

• 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)

• 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.