🔍 Code Extractor

class Reminder

Maturity: 32

A reminder for an event in a user calendar.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/events/reminder.py
Lines:
6 - 42
Complexity:
moderate

Purpose

A reminder for an event in a user calendar.

Source Code

class Reminder(ClientValue):
    """A reminder for an event in a user calendar."""

    def __init__(
        self,
        change_key=None,
        event_end_time=DateTimeTimeZone(),
        event_id=None,
        event_location=Location(),
        event_start_time=DateTimeTimeZone(),
        event_subject=None,
        event_web_link=None,
        reminder_fire_time=DateTimeTimeZone(),
    ):
        """
        :param str change_key: Identifies the version of the reminder. Every time the reminder is changed, changeKey
            changes as well. This allows Exchange to apply changes to the correct version of the object.
        :param DateTimeTimeZone event_end_time: The date, time and time zone that the event ends.
        :param str event_id: The unique ID of the event. Read only.
        :param Location event_location: The location of the event.
        :param DateTimeTimeZone event_start_time: The date, time, and time zone that the event starts.
        :param str event_subject: The text of the event's subject line.
        :param str event_web_link: The URL to open the event in Outlook on the web.
             The event will open in the browser if you are logged in to your mailbox via Outlook on the web.
             You will be prompted to login if you are not already logged in with the browser.
             This URL cannot be accessed from within an iFrame.
        :param DateTimeTimeZone reminder_fire_time: The date, time, and time zone that the reminder is set to occur.
        """
        super(Reminder, self).__init__()
        self.changeKey = change_key
        self.eventStartTime = event_start_time
        self.eventEndTime = event_end_time
        self.eventId = event_id
        self.eventLocation = event_location
        self.eventSubject = event_subject
        self.eventWebLink = event_web_link
        self.reminderFireTime = reminder_fire_time

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Parameter of type ClientValue

Return Value

Returns unspecified type

Class Interface

Methods

__init__(self, change_key, event_end_time, event_id, event_location, event_start_time, event_subject, event_web_link, reminder_fire_time)

Purpose: :param str change_key: Identifies the version of the reminder. Every time the reminder is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. :param DateTimeTimeZone event_end_time: The date, time and time zone that the event ends. :param str event_id: The unique ID of the event. Read only. :param Location event_location: The location of the event. :param DateTimeTimeZone event_start_time: The date, time, and time zone that the event starts. :param str event_subject: The text of the event's subject line. :param str event_web_link: The URL to open the event in Outlook on the web. The event will open in the browser if you are logged in to your mailbox via Outlook on the web. You will be prompted to login if you are not already logged in with the browser. This URL cannot be accessed from within an iFrame. :param DateTimeTimeZone reminder_fire_time: The date, time, and time zone that the reminder is set to occur.

Parameters:

  • change_key: Parameter
  • event_end_time: Parameter
  • event_id: Parameter
  • event_location: Parameter
  • event_start_time: Parameter
  • event_subject: Parameter
  • event_web_link: Parameter
  • reminder_fire_time: Parameter

Returns: None

Required Imports

from office365.outlook.calendar.dateTimeTimeZone import DateTimeTimeZone
from office365.outlook.mail.location import Location
from office365.runtime.client_value import ClientValue

Usage Example

# Example usage:
# result = Reminder(bases)

Tags

class reminder

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class Calendar 54.2% similar

    A Calendar class representing a Microsoft 365 calendar container for events, which can be a user calendar or a Microsoft 365 group's default calendar.

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

  • class Event 53.2% similar

    Represents a calendar event in Microsoft 365, providing methods to manage event responses (accept, decline, cancel), reminders, and access to event properties like attendees, attachments, and scheduling details.

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

  • class CalendarGroup 50.1% similar

    A class representing a group of user calendars in Microsoft Office 365, providing access to calendar group properties and associated calendars.

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

  • class ScheduleItem 49.0% similar

    A data class representing a calendar schedule item that describes the availability of a user or resource (room/equipment) corresponding to an actual event on their default calendar.

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

  • class EventMessage 46.4% similar

    A class representing an event message in Outlook, which can be a meeting request, cancellation, or response (acceptance, tentative acceptance, or decline).

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/mail/messages/event_message.py
← Back to Browse