Instance Method

rangeOfWeekendStartDate:interval:containingDate:

Returns whether a given date falls within a weekend period, and if so, returns by reference the start date and time interval of the weekend range.

Declaration

- (BOOL)rangeOfWeekendStartDate:(out NSDate * _Nullable *)datep interval:(out NSTimeInterval *)tip containingDate:(NSDate *)date;

Parameters

datep

Upon return, contains the starting date of the next weekend period.

tip

Upon return, contains the time interval of the next weekend period.

date

The date to use to perform the calculation.

Return Value

YES if the given date falls within a weekend period, otherwise NO.

Discussion

Note that a particular calendar day may not necessarily fall entirely within a weekend period, as weekends can start in the middle of a day in some calendars and locales.

See Also

Getting Calendar Information

calendarIdentifier

An identifier for the calendar.

firstWeekday

The index of the first weekday of the receiver.

locale

The locale of the receiver.

timeZone

The time zone for the calendar.

- maximumRangeOfUnit:

Returns the maximum range limits of the values that a given unit can take on.

- minimumRangeOfUnit:

Returns the minimum range limits of the values that a given unit can take on.

minimumDaysInFirstWeek

The minimum number of days in the first week of the receiver.

- ordinalityOfUnit:inUnit:forDate:

Returns, for a given absolute time, the ordinal number of a smaller calendar unit (such as a day) within a specified larger calendar unit (such as a week).

- rangeOfUnit:inUnit:forDate:

Returns the range of absolute time values that a smaller calendar unit (such as a day) can take on in a larger calendar unit (such as a month) that includes a specified absolute time.

- rangeOfUnit:startDate:interval:forDate:

Returns by reference the starting time and duration of a given calendar unit that contains a given date.

NSCalendarUnit

Calendrical units such as year, month, day and hour.