iOS Developer Library

Developer

EKStructuredLocation Class Reference

Options
Deployment Target:

On This Page
Language:

EKStructuredLocation

The EKStructuredLocation class specifies a geofence that can be used to trigger the alarm of a calendar item. Use locationWithTitle: to create a new structured location, then set it to the structuredLocation property of an EKAlarm object.

Inheritance


Conforms To


Import Statement


Swift

import EventKit

Objective-C

@import EventKit;

Availability


Available in iOS 6.0 and later.
  • Creates a new structured location.

    Declaration

    Swift

    init!(title title: String!) -> EKStructuredLocation

    Objective-C

    + (EKStructuredLocation *)locationWithTitle:(NSString *)title

    Parameters

    title

    The title of the location.

    Return Value

    The structured location object.

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in iOS 6.0 and later.

  • title title Property

    The title of the location.

    Declaration

    Swift

    var title: String!

    Objective-C

    @property(nonatomic, retain) NSString *title

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in iOS 6.0 and later.

  • The core location.

    Declaration

    Swift

    var geoLocation: CLLocation!

    Objective-C

    @property(nonatomic, retain) CLLocation *geoLocation

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in iOS 6.0 and later.

  • radius radius Property

    A minimum distance from the core location that would trigger the alarm or reminder.

    Declaration

    Swift

    var radius: Double

    Objective-C

    @property(nonatomic) double radius

    Discussion

    To use the default radius, set this property to 0.

    Import Statement

    Objective-C

    @import EventKit;

    Swift

    import EventKit

    Availability

    Available in iOS 6.0 and later.