AFGeofenceEvent

sealed class AFGeofenceEvent

Represents various events related to geofencing operations.

These events are emitted to notify the application about:

  • Successful registration or unregistration of geofences.

  • Transitions such as entering, exiting, or dwelling within a geofence.

  • Periodic heartbeat updates with current location.

  • Errors encountered during geofencing operations.

Inheritors

Types

Link copied to clipboard
data class Dwell(val geofenceId: String, val location: AFGeoLocation?) : AFGeofenceEvent

Indicates that the device has dwelled within a geofence for the specified duration.

Link copied to clipboard
data class Entered(val geofenceId: String, val location: AFGeoLocation?) : AFGeofenceEvent

Indicates that the device has entered a geofence.

Link copied to clipboard
data class Error(val throwable: Throwable) : AFGeofenceEvent

Signals an error that occurred within the geofencing service.

Link copied to clipboard
data class Exited(val geofenceId: String, val location: AFGeoLocation?) : AFGeofenceEvent

Indicates that the device has exited a geofence.

Link copied to clipboard
data class Heartbeat(val location: AFGeoLocation?) : AFGeofenceEvent

A periodic event providing the device's current location, or null if location is unavailable. This serves as a heartbeat to indicate the geofencing service is active and to provide location updates.

Link copied to clipboard
data class Registered(val geofenceIds: List<String>) : AFGeofenceEvent

Indicates that one or more geofences have been successfully registered with the system.

Link copied to clipboard
data class Unregistered(val geofenceIds: List<String>? = null) : AFGeofenceEvent

Indicates that geofences have been unregistered.