NAME

Net::ICal::Recurrence -- Represent a single recurrence rule

SYNOPSIS

use Net::ICal::Recurrence;
$rrule = new Net::ICal::Recurrence([ OPTION_PAIRS ]) ;

DESCRIPTION

Recurrence holds a single recurrence property, ala section 4.3.10 of RFC 2445.

CONSTRUCTOR

new([ OPTIONS_PAIRS ])

Create a new recurrence rule. Values for any of the below settings may be specified at intialization time.

METHODS

All of the methods that set multi-valued attributes (e.g., bysecond) accept either a single value or a reference to an array.

freq (FREQ)

Specify the frequency of the recurrence. Allowable values are:

SECONDLY MINUTELY HOURLY DAILY WEEKLY MONTHLY YEARLY

count(N)

Specify that the recurrence rule occurs for N recurrences, at most. May not be used in conjunction with until.

until(ICAL_TIME)

Specify that the recurrence rule occurs until ICAL_TIME at the latest. ICAL_TIME is a Net::ICal::Time object. May not be used in conjunction with count.

interval(N)

Specify how often the recurrence rule repeats. Defaults to '1'.

bysecond([ SECOND , ... ])

Specify the valid of seconds within a minute. SECONDs range from 0 to 59. Use an arrayref to specify more than one value.

byminute([ MINUTE , ... ])

Specify the valid of minutes within an hour. MINUTEs range from 0 to 59. Use an arrayref to specify more than one value.

byhour([ HOUR , ... ])

Specify the valid of hours within a day. HOURs range from 0 to 23. Use an arrayref to specify more than one value.

byday([ WDAY , ... ])

Specify the valid weekdays. Weekdays must be one of

MO TU WE TH FR SA SU

and may be preceded with an ordinal week number. If the recurrence frequency is MONTHLY, the ordinal specifies the valid week within the month. If the recurrence frequency is YEARLY, the ordinal specify the valid week within the year. A negative ordinal specifys an offset from the end of the month or year.

bymonthday([ MONTHDAY, ... ])

Specify the valid days within the month. A negative number specifies an offset from the end of the month.

byyearday([ YEARDAY, ... ])

Specify the valid day(s) within the year (i.e., 1 is January 1st). A negative number specifies an offset from the end of the year.

byweekno([ WEEKNO, ... ])

Specify the valid week(s) within the year. A negative number specifies an offset from the end of the year.

bymonth([ MONTH, ... ])

Specify the valid months within the year.

bysetpos([ N, ... ])

Specify the valid recurrences for the recurrence rule. Use this when you need something more complex than INTERVAL. N may be negative, and would specify an occurrence before the start time of the event.

wkst(WEEKDAY)

Specify the starting day of the week as applicable to week calculations. The default is MO. The allowable options are the same weekday codes as for byday.

as_ical_value()

Return an iCal format RRULE string

SEE ALSO

Net::ICal(3)