---

CalRecurrenceEnd Class Reference

Overview

CalRecurrenceEnd objects are used to describe a property of CalRecurrenceRule objects that defines how long a recurrence is scheduled to repeat.

You can create a recurrence end either using the recurrenceEndWithEndDate: method specifying the date after which the event no longer repeats, or using the recurrenceEndWithOccurrenceCount: method specifying the number of times it should repeat.

Tasks

Creating

• + recurrenceEndWithEndDate:
• + recurrenceEndWithOccurrenceCount:

Getting Properties

•   usesEndDate  property
•   endDate  property
•   occurrenceCount  property

Properties

For more about Objective-C properties, see “Properties” in The Objective-C 2.0 Programming Language.

endDate

The end date if the recurrence uses an end date value; nil if it uses an occurrence count.

@property(readonly) NSDate *endDate;

Availability

• Available in Mac OS X v10.5 and later.

Declared In

CalRecurrenceRule.h

occurrenceCount

The occurrence count—number of times an event repeats—if the recurrence uses a number value; 0 if it uses an end date.

@property(readonly) NSUInteger occurrenceCount;

Availability

• Available in Mac OS X v10.5 and later.

Declared In

CalRecurrenceRule.h

usesEndDate

YES if the recurrence uses an end date; NO if it uses a occurrence count.

@property(readonly) BOOL usesEndDate;

Availability

• Available in Mac OS X v10.5 and later.

Declared In

CalRecurrenceRule.h

Class Methods

recurrenceEndWithEndDate:

Creates and returns a newly allocated CalRecurrenceEnd object with the specified end date.

+ (id)recurrenceEndWithEndDate:(NSDate *)endDate

Parameters

endDate

The date a recurring event should end. Raises an exception if you pass nil.

Return Value

A newly allocated CalRecurrenceEnd object.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

CalRecurrenceRule.h

recurrenceEndWithOccurrenceCount:

Creates and returns a newly allocated CalRecurrenceEnd object with the specified recurrence count.

+ (id)recurrenceEndWithOccurrenceCount:(NSUInteger)occurrenceCount

Parameters

occurrenceCount

The number of times a recurring event should repeat. Raises an exception if you pass 0 or a negative number.

Return Value

A newly allocated CalRecurrenceEnd object.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

CalRecurrenceRule.h

---