:right-sidebar: True Recurrence =================================================================== .. currentmodule:: gi.repository.ICalGLib .. class:: Recurrence(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.ICalGLib.Object`, :class:`~gi.repository.GObject.Object` This is the ICalRecurrence instance. Constructors ------------ .. rst-class:: interim-class .. class:: Recurrence :no-index: .. classmethod:: new() -> ~gi.repository.ICalGLib.Recurrence Creates a new :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 .. classmethod:: new_from_string(str: str) -> ~gi.repository.ICalGLib.Recurrence Converts a string to a :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 :param str: The string representation of the :obj:`~gi.repository.ICalGLib.Recurrence` Methods ------- .. rst-class:: interim-class .. class:: Recurrence :no-index: .. method:: clear() -> None Resets an :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 .. classmethod:: day_day_of_week() -> ~gi.repository.ICalGLib.RecurrenceWeekday Decodes a day to a weekday in a week. .. versionadded:: 1.0 .. classmethod:: day_position() -> int Decodes a day to a position of the weekday. .. versionadded:: 1.0 .. classmethod:: frequency_from_string() -> ~gi.repository.ICalGLib.RecurrenceFrequency Converts a string representation to an enum representation for the frequency. .. versionadded:: 2.0 .. classmethod:: frequency_to_string() -> str Converts a enum representation to a string representation for the frequency. .. versionadded:: 2.0 .. method:: get_by_day(index: int) -> int Gets the by_day value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.DAY_SIZE`. .. versionadded:: 1.0 :param index: The index in by_day of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.DAY_SIZE` .. method:: get_by_day_array() -> list[int] Gets the by_day array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_DAY_SIZE. .. versionadded:: 1.0 .. method:: get_by_hour(index: int) -> int Gets the by_hour value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.HOUR_SIZE`. .. versionadded:: 1.0 :param index: The index in by_hour of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.HOUR_SIZE` .. method:: get_by_hour_array() -> list[int] Gets the by_hour array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_HOUR_SIZE. .. versionadded:: 1.0 .. method:: get_by_minute(index: int) -> int Gets the by_minute value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.MINUTE_SIZE`. .. versionadded:: 1.0 :param index: The index in by_minute of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.MINUTE_SIZE` .. method:: get_by_minute_array() -> list[int] Gets the by_minute array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_MINUTE_SIZE. .. versionadded:: 1.0 .. method:: get_by_month(index: int) -> int Gets the by_month value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.MONTH_SIZE`. .. versionadded:: 1.0 :param index: The index in by_month of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.MONTH_SIZE` .. method:: get_by_month_array() -> list[int] Gets the by_month array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_MONTH_SIZE. .. versionadded:: 1.0 .. method:: get_by_month_day(index: int) -> int Gets the by_month_day value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.MONTHDAY_SIZE`. .. versionadded:: 1.0 :param index: The index in by_month_day of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.MONTHDAY_SIZE` .. method:: get_by_month_day_array() -> list[int] Gets the by_month_day array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_MONTHDAY_SIZE. .. versionadded:: 1.0 .. method:: get_by_second(index: int) -> int Gets the by_second value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.SECOND_SIZE`. .. versionadded:: 1.0 :param index: The index in by_second of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.SECOND_SIZE` .. method:: get_by_second_array() -> list[int] Gets the by_second array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size if I_CAL_BY_SECOND_SIZE. .. versionadded:: 1.0 .. method:: get_by_set_pos(index: int) -> int Gets the by_set_pos value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.SETPOS_SIZE`. .. versionadded:: 1.0 :param index: The index in by_set_pos of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.SETPOS_SIZE` .. method:: get_by_set_pos_array() -> list[int] Gets the by_set_pos array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_SETPOS_SIZE. .. versionadded:: 1.0 .. method:: get_by_week_no(index: int) -> int Gets the by_week_no value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.WEEKNO_SIZE`. .. versionadded:: 1.0 :param index: The index in by_week_no of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.WEEKNO_SIZE` .. method:: get_by_week_no_array() -> list[int] Gets the by_week_no array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_WEEKNO_SIZE. .. versionadded:: 1.0 .. method:: get_by_year_day(index: int) -> int Gets the by_year_day value at index ``index``\. The index should be less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.YEARDAY_SIZE`. .. versionadded:: 1.0 :param index: The index in by_year_day of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than :const:`~gi.repository.ICalGLib.RecurrenceArraySizes.YEARDAY_SIZE` .. method:: get_by_year_day_array() -> list[int] Gets the by_year_day array from :obj:`~gi.repository.ICalGLib.Recurrence`\. The array size is I_CAL_BY_YEARDAY_SIZE. .. versionadded:: 1.0 .. method:: get_count() -> int Gets the count from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 .. method:: get_freq() -> ~gi.repository.ICalGLib.RecurrenceFrequency Gets the freq from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 .. method:: get_interval() -> int Gets the interval from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 .. method:: get_until() -> ~gi.repository.ICalGLib.Time Gets the until from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 .. method:: get_week_start() -> ~gi.repository.ICalGLib.RecurrenceWeekday Gets the week_start from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 .. classmethod:: month_is_leap() -> bool Decodes a month and check whether it is a leap month. .. versionadded:: 2.0 .. classmethod:: month_month() -> int .. versionadded:: 2.0 .. classmethod:: rscale_is_supported() -> bool Checks whether rscale is supported. .. versionadded:: 2.0 .. classmethod:: rscale_supported_calendars() -> ~gi.repository.ICalGLib.Array Gets an array of calendars supporting rscale (currently always return NULL). .. versionadded:: 2.0 .. method:: set_by_day(index: int, value: int) -> None Sets the by_day array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size if I_CAL_BY_DAY_SIZE. .. versionadded:: 1.0 :param index: The index in by_day of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_day of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_hour(index: int, value: int) -> None Sets the by_hour array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size is I_CAL_BY_HOUR_SIZE. .. versionadded:: 1.0 :param index: The index in by_hour of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_hour of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_minute(index: int, value: int) -> None Sets the by_minute array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size is I_CAL_BY_MINUTE_SIZE. .. versionadded:: 1.0 :param index: The index in by_minute of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_minute of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_month(index: int, value: int) -> None Sets the by_month array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size is I_CAL_BY_MONTH_SIZE. .. versionadded:: 1.0 :param index: The index in by_month of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_month of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_month_day(index: int, value: int) -> None Sets the by_month_day array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size if I_CAL_BY_MONTHDAY_SIZE. .. versionadded:: 1.0 :param index: The index in by_month_day of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_month_day of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_second(index: int, value: int) -> None Sets the by_second array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size is I_CAL_BY_SECOND_SIZE. .. versionadded:: 1.0 :param index: The index in by_second of :obj:`~gi.repository.ICalGLib.Recurrence`\, less than I_CAL_BY_SECOND_SIZE :param value: The value to be set into by_second of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_set_pos(index: int, value: int) -> None Sets the by_set_pos array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size is I_CAL_BY_SETPOS_SIZE. .. versionadded:: 1.0 :param index: The index in by_set_pos of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_set_pos of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_week_no(index: int, value: int) -> None Sets the by_week_no array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size is I_CAL_BY_WEEKNO_SIZE. .. versionadded:: 1.0 :param index: The index in by_week_no of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_week_no of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_by_year_day(index: int, value: int) -> None Sets the by_year_day array from :obj:`~gi.repository.ICalGLib.Recurrence` at the given index. The array size if I_CAL_BY_YEARDAY_SIZE. .. versionadded:: 1.0 :param index: The index in by_year_day of :obj:`~gi.repository.ICalGLib.Recurrence` :param value: The value to be set into by_year_day of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: 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. .. versionadded:: 1.0 :param values: The array of values .. method:: set_count(count: int) -> None Sets the count from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 :param count: The count of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: set_freq(freq: ~gi.repository.ICalGLib.RecurrenceFrequency) -> None Sets the freq from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 :param freq: The freq of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: set_interval(interval: int) -> None Sets the interval from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 :param interval: The interval of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: set_until(until: ~gi.repository.ICalGLib.Time) -> None Sets the until from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 :param until: The until of :obj:`~gi.repository.ICalGLib.Recurrence` .. method:: set_week_start(week_start: ~gi.repository.ICalGLib.RecurrenceWeekday) -> None Sets the week_start from :obj:`~gi.repository.ICalGLib.Recurrence`\. .. versionadded:: 1.0 :param week_start: The week_start of :obj:`~gi.repository.ICalGLib.Recurrence` .. classmethod:: skip_from_string() -> ~gi.repository.ICalGLib.RecurrenceSkip Converts a string representation to an enum representation for the skip. .. versionadded:: 2.0 .. classmethod:: skip_to_string() -> str Converts a enum representation to a string representation for the skip. .. versionadded:: 2.0 .. method:: to_string() -> str Converts a :obj:`~gi.repository.ICalGLib.Recurrence` to a string. .. versionadded:: 1.0 .. classmethod:: weekday_from_string() -> ~gi.repository.ICalGLib.RecurrenceWeekday Converts a string representation to an enum representation for the weekday. .. versionadded:: 1.0 .. classmethod:: weekday_to_string() -> str Converts a enum representation to a string representation for the weekday. .. versionadded:: 2.0