🔍 Code Extractor

class RecurrencePattern

Maturity: 33

Describes the frequency by which a recurring event repeats.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/mail/recurrence_pattern.py
Lines:
5 - 37
Complexity:
moderate

Purpose

Describes the frequency by which a recurring event repeats.

Source Code

class RecurrencePattern(ClientValue):
    """Describes the frequency by which a recurring event repeats."""

    def __init__(
        self,
        day_of_month=None,
        days_of_week=None,
        first_day_of_week=None,
        index=None,
        interval=None,
        month=None,
        pattern_type=None,
    ):
        """
        :param int day_of_month: The day of the month on which the event occurs. Required if type is absoluteMonthly
            or absoluteYearly.
        :param list[str] days_of_week: A collection of the days of the week on which the event occurs
        :param str first_day_of_week: The first day of the week
        :param str index: Specifies on which instance of the allowed days specified in daysOfWeek the event occurs,
             counted from the first instance in the month.
        :param int interval: The number of units between occurrences, where units can be in days, weeks, months,
             or years, depending on the type. Required.
        :param int month: The month in which the event occurs. This is a number from 1 to 12.
        :param str pattern_type: The recurrence pattern type: daily, weekly, absoluteMonthly, relativeMonthly,
             absoluteYearly, relativeYearly
        """
        self.dayOfMonth = day_of_month
        self.daysOfWeek = StringCollection(days_of_week)
        self.firstDayOfWeek = first_day_of_week
        self.index = index
        self.interval = interval
        self.month = month
        self.type = pattern_type

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Parameter of type ClientValue

Return Value

Returns unspecified type

Class Interface

Methods

__init__(self, day_of_month, days_of_week, first_day_of_week, index, interval, month, pattern_type)

Purpose: :param int day_of_month: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly. :param list[str] days_of_week: A collection of the days of the week on which the event occurs :param str first_day_of_week: The first day of the week :param str index: Specifies on which instance of the allowed days specified in daysOfWeek the event occurs, counted from the first instance in the month. :param int interval: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required. :param int month: The month in which the event occurs. This is a number from 1 to 12. :param str pattern_type: The recurrence pattern type: daily, weekly, absoluteMonthly, relativeMonthly, absoluteYearly, relativeYearly

Parameters:

  • day_of_month: Parameter
  • days_of_week: Parameter
  • first_day_of_week: Parameter
  • index: Parameter
  • interval: Parameter
  • month: Parameter
  • pattern_type: Parameter

Returns: None

Required Imports

from office365.runtime.client_value import ClientValue
from office365.runtime.types.collections import StringCollection

Usage Example

# Example usage:
# result = RecurrencePattern(bases)

Tags

class recurrencepattern

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class PatternedRecurrence 62.1% similar

    A class representing a recurrence pattern and range for scheduling recurring events, access reviews, role assignments, and other Microsoft 365/Azure AD objects.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/mail/patterned_recurrence.py

  • class RecurrenceRange 51.1% similar

    A data class representing a date range over which a recurring event occurs, used in Azure AD for access reviews, calendar events, and access package assignments.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/mail/recurrence_range.py

  • class Reminder 38.2% similar

    A reminder for an event in a user calendar.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/events/reminder.py

  • class PatternBasedExtractor 37.1% similar

    Extract flocks based on farm-level In-Ovo usage patterns.

    From: /tf/active/vicechatdev/pattern_based_extraction.py

  • class DateTimeFormat 35.0% similar

    An enumeration-style class that defines constants for specifying date and time format options.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/fields/date_time_format.py
← Back to Browse