Recurrence

class Recurrence(**properties: Any)

Superclasses: Object, Object

This is the ICalRecurrence instance.

Constructors

class Recurrence

classmethod new() → Recurrence

Creates a new Recurrence.

Added in version 1.0.

classmethod new_from_string(str: str) → Recurrence

Converts a string to a Recurrence.

Added in version 1.0.

Parameters:

str – The string representation of the Recurrence

Methods

class Recurrence

clear() → None

Resets an Recurrence.

Added in version 1.0.

classmethod day_day_of_week() → RecurrenceWeekday

Decodes a day to a weekday in a week.

Added in version 1.0.

classmethod day_position() → int

Decodes a day to a position of the weekday.

Added in version 1.0.

classmethod frequency_from_string() → RecurrenceFrequency

Converts a string representation to an enum representation for the frequency.

Added in version 2.0.

classmethod frequency_to_string() → str

Converts a enum representation to a string representation for the frequency.

Added in version 2.0.

get_by_day(index: int) → int

Gets the by_day value at index index. The index should be less than DAY_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_day of Recurrence, less than DAY_SIZE

get_by_day_array() → list[int]

Gets the by_day array from Recurrence. The array size is I_CAL_BY_DAY_SIZE.

Added in version 1.0.

get_by_hour(index: int) → int

Gets the by_hour value at index index. The index should be less than HOUR_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_hour of Recurrence, less than HOUR_SIZE

get_by_hour_array() → list[int]

Gets the by_hour array from Recurrence. The array size is I_CAL_BY_HOUR_SIZE.

Added in version 1.0.

get_by_minute(index: int) → int

Gets the by_minute value at index index. The index should be less than MINUTE_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_minute of Recurrence, less than MINUTE_SIZE

get_by_minute_array() → list[int]

Gets the by_minute array from Recurrence. The array size is I_CAL_BY_MINUTE_SIZE.

Added in version 1.0.

get_by_month(index: int) → int

Gets the by_month value at index index. The index should be less than MONTH_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_month of Recurrence, less than MONTH_SIZE

get_by_month_array() → list[int]

Gets the by_month array from Recurrence. The array size is I_CAL_BY_MONTH_SIZE.

Added in version 1.0.

get_by_month_day(index: int) → int

Gets the by_month_day value at index index. The index should be less than MONTHDAY_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_month_day of Recurrence, less than MONTHDAY_SIZE

get_by_month_day_array() → list[int]

Gets the by_month_day array from Recurrence. The array size is I_CAL_BY_MONTHDAY_SIZE.

Added in version 1.0.

get_by_second(index: int) → int

Gets the by_second value at index index. The index should be less than SECOND_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_second of Recurrence, less than SECOND_SIZE

get_by_second_array() → list[int]

Gets the by_second array from Recurrence. The array size if I_CAL_BY_SECOND_SIZE.

Added in version 1.0.

get_by_set_pos(index: int) → int

Gets the by_set_pos value at index index. The index should be less than SETPOS_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_set_pos of Recurrence, less than SETPOS_SIZE

get_by_set_pos_array() → list[int]

Gets the by_set_pos array from Recurrence. The array size is I_CAL_BY_SETPOS_SIZE.

Added in version 1.0.

get_by_week_no(index: int) → int

Gets the by_week_no value at index index. The index should be less than WEEKNO_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_week_no of Recurrence, less than WEEKNO_SIZE

get_by_week_no_array() → list[int]

Gets the by_week_no array from Recurrence. The array size is I_CAL_BY_WEEKNO_SIZE.

Added in version 1.0.

get_by_year_day(index: int) → int

Gets the by_year_day value at index index. The index should be less than YEARDAY_SIZE.

Added in version 1.0.

Parameters:

index – The index in by_year_day of Recurrence, less than YEARDAY_SIZE

get_by_year_day_array() → list[int]

Gets the by_year_day array from Recurrence. The array size is I_CAL_BY_YEARDAY_SIZE.

Added in version 1.0.

get_count() → int

Gets the count from Recurrence.

Added in version 1.0.

get_freq() → RecurrenceFrequency

Gets the freq from Recurrence.

Added in version 1.0.

get_interval() → int

Gets the interval from Recurrence.

Added in version 1.0.

get_until() → Time

Gets the until from Recurrence.

Added in version 1.0.

get_week_start() → RecurrenceWeekday

Gets the week_start from Recurrence.

Added in version 1.0.

classmethod month_is_leap() → bool

Decodes a month and check whether it is a leap month.

Added in version 2.0.

classmethod month_month() → int

Added in version 2.0.

classmethod rscale_is_supported() → bool

Checks whether rscale is supported.

Added in version 2.0.

classmethod rscale_supported_calendars() → Array

Gets an array of calendars supporting rscale (currently always return NULL).

Added in version 2.0.

set_by_day(index: int, value: int) → None

Sets the by_day array from Recurrence at the given index. The array size if I_CAL_BY_DAY_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_day of Recurrence

• value – The value to be set into by_day of Recurrence

set_by_day_array(values: list[int]) → None

Sets the by_day array in recur at once. The array size can be less than I_CAL_BY_DAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_hour(index: int, value: int) → None

Sets the by_hour array from Recurrence at the given index. The array size is I_CAL_BY_HOUR_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_hour of Recurrence

• value – The value to be set into by_hour of Recurrence

set_by_hour_array(values: list[int]) → None

Sets the by_hour array in recur at once. The array size can be less than I_CAL_BY_HOUR_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_minute(index: int, value: int) → None

Sets the by_minute array from Recurrence at the given index. The array size is I_CAL_BY_MINUTE_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_minute of Recurrence

• value – The value to be set into by_minute of Recurrence

set_by_minute_array(values: list[int]) → None

Sets the by_minute array in recur at once. The array size can be less than I_CAL_BY_MINUTE_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_month(index: int, value: int) → None

Sets the by_month array from Recurrence at the given index. The array size is I_CAL_BY_MONTH_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_month of Recurrence

• value – The value to be set into by_month of Recurrence

set_by_month_array(values: list[int]) → None

Sets the by_month array in recur at once. The array size can be less than I_CAL_BY_MONTH_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_month_day(index: int, value: int) → None

Sets the by_month_day array from Recurrence at the given index. The array size if I_CAL_BY_MONTHDAY_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_month_day of Recurrence

• value – The value to be set into by_month_day of Recurrence

set_by_month_day_array(values: list[int]) → None

Sets the by_month_day array in recur at once. The array size can be less than I_CAL_BY_MONTHDAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_second(index: int, value: int) → None

Sets the by_second array from Recurrence at the given index. The array size is I_CAL_BY_SECOND_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_second of Recurrence, less than I_CAL_BY_SECOND_SIZE

• value – The value to be set into by_second of Recurrence

set_by_second_array(values: list[int]) → None

Sets the by_second array in recur at once. The array size can be less than I_CAL_BY_SECOND_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_set_pos(index: int, value: int) → None

Sets the by_set_pos array from Recurrence at the given index. The array size is I_CAL_BY_SETPOS_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_set_pos of Recurrence

• value – The value to be set into by_set_pos of Recurrence

set_by_set_pos_array(values: list[int]) → None

Sets the by_set_pos array in recur at once. The array size can be less than I_CAL_BY_SETPOS_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_week_no(index: int, value: int) → None

Sets the by_week_no array from Recurrence at the given index. The array size is I_CAL_BY_WEEKNO_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_week_no of Recurrence

• value – The value to be set into by_week_no of Recurrence

set_by_week_no_array(values: list[int]) → None

Sets the by_week_no array in recur at once. The array size can be less than I_CAL_BY_WEEKNO_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_by_year_day(index: int, value: int) → None

Sets the by_year_day array from Recurrence at the given index. The array size if I_CAL_BY_YEARDAY_SIZE.

Added in version 1.0.

Parameters:

• index – The index in by_year_day of Recurrence

• value – The value to be set into by_year_day of Recurrence

set_by_year_day_array(values: list[int]) → None

Sets the by_year_day array in recur at once. The array size can be less than I_CAL_BY_YEARDAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

Added in version 1.0.

Parameters:

values – The array of values

set_count(count: int) → None

Sets the count from Recurrence.

Added in version 1.0.

Parameters:

count – The count of Recurrence

set_freq(freq: RecurrenceFrequency) → None

Sets the freq from Recurrence.

Added in version 1.0.

Parameters:

freq – The freq of Recurrence

set_interval(interval: int) → None

Sets the interval from Recurrence.

Added in version 1.0.

Parameters:

interval – The interval of Recurrence

set_until(until: Time) → None

Sets the until from Recurrence.

Added in version 1.0.

Parameters:

until – The until of Recurrence

set_week_start(week_start: RecurrenceWeekday) → None

Sets the week_start from Recurrence.

Added in version 1.0.

Parameters:

week_start – The week_start of Recurrence

classmethod skip_from_string() → RecurrenceSkip

Converts a string representation to an enum representation for the skip.

Added in version 2.0.

classmethod skip_to_string() → str

Converts a enum representation to a string representation for the skip.

Added in version 2.0.

to_string() → str

Converts a Recurrence to a string.

Added in version 1.0.

classmethod weekday_from_string() → RecurrenceWeekday

Converts a string representation to an enum representation for the weekday.

Added in version 1.0.

classmethod weekday_to_string() → str

Converts a enum representation to a string representation for the weekday.

Added in version 2.0.