Class

EKRecurrenceRule

A class that describes the recurrence pattern for a recurring event.

Declaration

@interface EKRecurrenceRule : EKObject

Overview

After you create a recurrence rule, assign it to an event with the recurrenceRule method of EKEvent.

Recurrence rules can have an end, represented by an EKRecurrenceEnd object. The end can be based on a specific date or a maximum number of occurrences.

Topics

Creating a Basic Recurrence Rule

EKSpan

An object that indicates whether modifications should apply to a single event or all future events of a recurring event.

- initRecurrenceWithFrequency:interval:end:

Initializes and returns a simple recurrence rule with a given frequency, interval, and end.

Creating a Complex Recurrence Rule

- initRecurrenceWithFrequency:interval:daysOfTheWeek:daysOfTheMonth:monthsOfTheYear:weeksOfTheYear:daysOfTheYear:setPositions:end:

Initializes and returns a recurrence rule with a given frequency and additional scheduling information.

Accessing Recurrence Rule Properties

EKRecurrenceFrequency

The frequency for recurrence rules.

calendarIdentifier

The identifier for the recurrence rule’s calendar.

recurrenceEnd

Indicates when the recurrence rule ends.

frequency

The frequency of the recurrence rule.

interval

Specifies how often the recurrence rule repeats over the unit of time indicated by its frequency.

firstDayOfTheWeek

Indicates which day of the week the recurrence rule treats as the first day of the week.

daysOfTheWeek

The days of the week associated with the recurrence rule, as an array of EKRecurrenceDayOfWeek objects.

daysOfTheMonth

The days of the month associated with the recurrence rule, as an array of NSNumber objects.

daysOfTheYear

The days of the year associated with the recurrence rule, as an array of NSNumber objects.

weeksOfTheYear

The weeks of the year associated with the recurrence rule, as an array of NSNumber objects.

monthsOfTheYear

The months of the year associated with the recurrence rule, as an array of NSNumber objects.

setPositions

An array of ordinal numbers that filters which recurrences to include in the recurrence rule’s frequency.

Relationships

Inherits From

Conforms To

See Also

Recurrence

Creating a Recurring Event

Set up an event or reminder that repeats.

EKRecurrenceDayOfWeek

A class that represents the day of the week.

EKRecurrenceEnd

A class that defines the end of a recurrence rule.