AWSLocationForecastedEvent

Objective-C

@interface AWSLocationForecastedEvent

Swift

class AWSLocationForecastedEvent

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.

Required parameters: [EventId, GeofenceId, IsDeviceInGeofence, NearestDistance, EventType]

  • The forecasted event identifier.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable eventId;

    Swift

    var eventId: String? { get set }

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

    ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

    EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

    IDLE: If a device is inside of a geofence, and the device is not moving.

    Declaration

    Objective-C

    @property (nonatomic) AWSLocationForecastedGeofenceEventType eventType;

    Swift

    var eventType: AWSLocationForecastedGeofenceEventType { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable forecastedBreachTime;

    Swift

    var forecastedBreachTime: Date? { get set }

  • The geofence identifier pertaining to the forecasted event.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable geofenceId;

    Swift

    var geofenceId: String? { get set }

  • The geofence properties.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable geofenceProperties;

    Swift

    var geofenceProperties: [String : String]? { get set }

  • Indicates if the device is located within the geofence.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable isDeviceInGeofence;

    Swift

    var isDeviceInGeofence: NSNumber? { get set }

  • The closest distance from the device’s position to the geofence.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable nearestDistance;

    Swift

    var nearestDistance: NSNumber? { get set }