EKRecurrenceEnd Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/EventKit.framework
Availability
Available in iOS 4.0 and later.
Companion guide
Declared in
EKRecurrenceEnd.h

Overview

The EKRecurrenceEnd class defines the end of a recurrence rule defined by an EKRecurrenceRule object. The recurrence end can be specified by a date (date-based) or by a maximum count of occurrences (count-based). An event which is set to never end should have its EKRecurrenceEnd set to nil.

Tasks

Creating a Recurrence End

Accessing Recurrence End Properties

Properties

endDate

The end date of the recurrence end, or nil if the recurrence end is count-based. (read-only)

@property(readonly) NSDate *endDate
Availability
  • Available in iOS 4.0 and later.
Declared In
EKRecurrenceEnd.h

occurrenceCount

The occurrence count of the recurrence end, or 0 if the recurrence end is date-based. (read-only)

@property(readonly) NSUInteger occurrenceCount
Availability
  • Available in iOS 4.0 and later.
Declared In
EKRecurrenceEnd.h

Class Methods

recurrenceEndWithEndDate:

Initializes and returns a date-based recurrence end with a given end date.

+ (id)recurrenceEndWithEndDate:(NSDate *)endDate
Parameters
endDate

The end date.

Return Value

The initialized recurrence end.

Discussion

The end date argument must be a valid NSDate and not nil; otherwise an exception will be raised.

Availability
  • Available in iOS 4.0 and later.
Declared In
EKRecurrenceEnd.h

recurrenceEndWithOccurrenceCount:

Initializes and returns a count-based recurrence end with a given maximum occurrence count.

+ (id)recurrenceEndWithOccurrenceCount:(NSUInteger)occurrenceCount
Parameters
occurrenceCount

The maximum occurrence count.

Return Value

The initialized recurrence end.

Discussion

The maximum occurrence count argument must be a positive integer and not 0; otherwise an exception will be raised.

Availability
  • Available in iOS 4.0 and later.
Declared In
EKRecurrenceEnd.h