location/aws.sdk.kotlin.services.location.model/ForecastedEvent

ForecastedEvent

A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.

Types

Builder

class Builder

Companion

object Companion

Properties

eventId

val eventId: String

The forecasted event identifier.

eventType

val eventType: ForecastedGeofenceEventType

The event type, forecasting three states for which a device can be in relative to a geofence:

forecastedBreachTime

val forecastedBreachTime: Instant?

The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofenceId

val geofenceId: String

The geofence identifier pertaining to the forecasted event.

geofenceProperties

val geofenceProperties: Map<String, String>?

The geofence properties.

isDeviceInGeofence

val isDeviceInGeofence: Boolean

Indicates if the device is located within the geofence.

nearestDistance

val nearestDistance: Double

The closest distance from the device's position to the geofence.

Functions

copy

inline fun copy(block: ForecastedEvent.Builder.() -> Unit = {}): ForecastedEvent

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String