Package-level declarations

Types

Link copied to clipboard
@MapboxExperimental
fun interface AddFeatureCallback

Callback that returns the result of adding a feature to be monitored.

Link copied to clipboard
@MapboxExperimental
fun interface AddObserverCallback

Callback that returns the result of adding a geofence monitored features' observer.

Link copied to clipboard
@MapboxExperimental
fun interface ClearFeaturesCallback

Callback that returns the result of clearing all monitored features.

Link copied to clipboard
@MapboxExperimental
fun interface ConfigureCallback

Callback that provides the result of a request to configure the Geofencing API object.

Link copied to clipboard
@MapboxExperimental
class GeofenceState : Serializable

Geofencing state for the feature.

Link copied to clipboard
@MapboxExperimental
class GeofencingError : Serializable

Geofencing error code with brief explanation.

Link copied to clipboard
@MapboxExperimental
enum GeofencingErrorType : Enum<GeofencingErrorType>

Geofencing error codes.

Link copied to clipboard
@MapboxExperimental
class GeofencingEvent : Serializable

Geofencing event created onEntry/onDwell/onExit.

Link copied to clipboard
@MapboxExperimental
class GeofencingFactory

A factory class used to instantiate a Geofencing API object.

Link copied to clipboard
@MapboxExperimental
interface GeofencingObserver

Geofencing observer for monitoring entry/dwell/exit from features as well as errors.

Link copied to clipboard
@MapboxExperimental
class GeofencingOptions : Serializable

Configuration options affecting the behavior of the geofencing service.

Link copied to clipboard
@MapboxExperimental
object GeofencingPropertiesKeys

Use the following keys in the properties of your GeoJSON Feature to configure geofencing engine per Feature. For example: { "geometry":{"coordinates":11.7846331,48.3527223,"type":"Point"}, "properties":{"MBX_GEOFENCE_DWELL_TIME":10, "MBX_GEOFENCE_POINT_RADIUS":100}, "type":"Feature" }

Link copied to clipboard
@MapboxExperimental
interface GeofencingService

Geofencing API for detecting entry/exit states of monitored features' geometries.

Link copied to clipboard
@MapboxExperimental
class GeofencingUtils
@MapboxExperimental
fun interface GeofencingUtilsUserConsentResponseCallback
Link copied to clipboard
@MapboxExperimental
fun interface GetFeatureCallback

Callback that returns the result of retrieving a feature.

Link copied to clipboard
@MapboxExperimental
fun interface GetOptionsCallback

Callback that retrieves the current set of geofencing options from a given Geofencing API object.

Link copied to clipboard
@MapboxExperimental
fun interface RemoveFeatureCallback

Callback that returns the result of removing a monitored feature.

Link copied to clipboard
@MapboxExperimental
fun interface RemoveObserverCallback

Callback that returns the result of removing a geofence monitored features' observer.

Functions

Link copied to clipboard

DSL builder for GeofenceState

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard