RadarEvent

Objective-C

@interface RadarEvent : NSObject

Swift

class RadarEvent : NSObject

Represents a change in user state.

  • _id

    The Radar ID of the event.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSString *_id;

    Swift

    var _id: String { get }

  • The datetime when the event occurred on the device.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSDate *createdAt;

    Swift

    var createdAt: Date { get }

  • The datetime when the event was created on the server.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSDate *actualCreatedAt;

    Swift

    var actualCreatedAt: Date { get }

  • A boolean indicating whether the event was generated with your live API key.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL live;

    Swift

    var live: Bool { get }

  • The type of the event.

    Declaration

    Objective-C

    @property (nonatomic, readonly) RadarEventType type;

    Swift

    var type: RadarEventType { get }

  • The custom type of the event. This will only be set if the type is RadarEventTypeCustom.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *customType;

    Swift

    var customType: String? { get }

  • The geofence for which the event was generated. May be nil for non-geofence events.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RadarGeofence *geofence;

    Swift

    var geofence: RadarGeofence? { get }

  • The place for which the event was generated. May be nil for non-place events.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RadarPlace *place;

    Swift

    var place: RadarPlace? { get }

  • The region for which the event was generated. May be null for non-region events.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RadarRegion *region;

    Swift

    var region: RadarRegion? { get }

  • The beacon for which the event was generated. May be nil for non-beacon events.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RadarBeacon *beacon;

    Swift

    var beacon: RadarBeacon? { get }

  • The trip for which the event was generated. May be nil for non-trip events.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RadarTrip *trip;

    Swift

    var trip: RadarTrip? { get }

  • For place entry events, alternate place candidates. May be nil for non-place events.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSArray<RadarPlace *> *alternatePlaces;

    Swift

    var alternatePlaces: [RadarPlace]? { get }

  • For accepted place entry events, the verified place. May be nil for non-place events or unverified events.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RadarPlace *verifiedPlace;

    Swift

    var verifiedPlace: RadarPlace? { get }

  • The verification of the event.

    Declaration

    Objective-C

    @property (nonatomic, readonly) RadarEventVerification verification;

    Swift

    var verification: RadarEventVerification { get }

  • The confidence level of the event.

    Declaration

    Objective-C

    @property (nonatomic, readonly) RadarEventConfidence confidence;

    Swift

    var confidence: RadarEventConfidence { get }

  • The duration between entry and exit events, in minutes, for exit events. 0 for entry events.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float duration;

    Swift

    var duration: Float { get }

  • The location of the event.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) CLLocation *location;

    Swift

    var location: CLLocation { get }

  • The metadata of the event. Present on custom events only.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSDictionary *metadata;

    Swift

    var metadata: [AnyHashable : Any] { get }