All properties
This is a list of all properties
Action
Bases: Property
The ACTION property defines the action to be invoked when an alarm is triggered.
Source code in ical_library/ical_properties/pass_properties.py
126 127 128 129 |
|
Attach
Bases: Property
The ATTACH property provides the capability to associate a document object with a calendar component.
Source code in ical_library/ical_properties/pass_properties.py
76 77 78 79 |
|
Attendee
Bases: _CalAddress
The ATTENDEE property defines an "Attendee" within a calendar component.
Source code in ical_library/ical_properties/cal_address.py
40 41 42 43 |
|
CalScale
Bases: Property
The CALSCALE property defines the calendar scale used for the calendar information specified in the iCalendar object.
Source code in ical_library/ical_properties/pass_properties.py
19 20 21 22 23 24 25 |
|
Categories
Bases: Property
The CATEGORIES property defines the categories for a calendar component.
Source code in ical_library/ical_properties/pass_properties.py
82 83 84 85 |
|
Class
Bases: Property
The CLASS property defines the access classification for a calendar component.
Source code in ical_library/ical_properties/pass_properties.py
34 35 36 37 |
|
Comment
Bases: Property
The COMMENT property specifies non-processing information intended to provide a comment to the calendar user.
Source code in ical_library/ical_properties/pass_properties.py
138 139 140 141 |
|
Completed
Bases: _DTSingular
The COMPLETED property defines the date and time that a to-do was actually completed.
Source code in ical_library/ical_properties/dt.py
106 107 108 109 |
|
Contact
Bases: Property
The CONTACT property is used to represent contact information or alternately a reference to contact information associated with the calendar component.
Source code in ical_library/ical_properties/pass_properties.py
88 89 90 91 92 93 94 |
|
Created
Bases: _DTSingular
The CREATED property defines the date and time that the calendar information was created by the calendar user agent in the calendar store.
Source code in ical_library/ical_properties/dt.py
113 114 115 116 117 118 119 |
|
DTEnd
Bases: _DTBoth
The DTEND property specifies the date and time that a calendar component ends.
Source code in ical_library/ical_properties/dt.py
60 61 62 63 |
|
DTStamp
Bases: _DTBoth
The DTSTAMP property is defined as followed.
In the case of an iCalendar object that specifies a "METHOD" property, this property specifies the date and time that the instance of the iCalendar object was created. In the case of an iCalendar object that doesn't specify a "METHOD" property, this property specifies the date and time that the information associated with the calendar component was last revised in the calendar store.
Source code in ical_library/ical_properties/dt.py
93 94 95 96 97 98 99 100 101 102 |
|
DTStart
Bases: _DTBoth
The DTSTART property specifies when the calendar component begins..
Source code in ical_library/ical_properties/dt.py
53 54 55 56 |
|
Description
Bases: Property
The DESCRIPTION property provides a more complete description of the calendar component than that provided by the "SUMMARY" property.
Source code in ical_library/ical_properties/pass_properties.py
40 41 42 43 44 45 46 |
|
Due
Bases: _DTBoth
This DUE property defines the date and time that a to-do is expected to be completed..
Source code in ical_library/ical_properties/dt.py
67 68 69 70 |
|
EXDate
Bases: _ExOrRDate
The EXDATE property defines the list of DATE-TIME exceptions for recurring events, to-dos, journal entries, or time zone definitions.
Source code in ical_library/ical_properties/periods.py
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
|
excluded_date_times: Union[List[DateTime], List[Date]]
property
A list of all excluded Dates or DateTimes. The type will be according to kind reported by self.kind()
.
kind: Optional[Literal['DATE-TIME', 'DATE']]
property
The kind of the values. It is either DATE-TIME or DATE. The default is DATE-TIME.
FreeBusyProperty
Bases: _PeriodFunctionality
The FREEBUSY property defines one or more free or busy time intervals.
Note: This class is called FreeBusyProperty to not be confused with the VFreeBusy component.
Source code in ical_library/ical_properties/periods.py
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
|
free_busy_type: str
property
Specifies the free or busy time type.
Values are usually in the following list but can be anything: FREE, BUSY, BUSY-UNAVAILABLE, BUSY-TENTATIVE
periods: List[Tuple[DateTime, DateTime]]
property
All the periods present in this property for which we define a free or busy time.
Returns:
Type | Description |
---|---|
A list of tuples, where each tuple values consists of two DateTimes indicating the start and end respectively. |
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not FREEBUSYPROPERTY but FREEBUSY.
Source code in ical_library/ical_properties/periods.py
121 122 123 124 |
|
GEO
Bases: Property
The GEO property specifies information related to the global position for the activity specified by a calendar component.
Source code in ical_library/ical_properties/geo.py
6 7 8 9 10 11 12 13 14 15 16 |
|
geo_value: Tuple[float, float]
property
Return the value as two floats representing the latitude and longitude.
ICALDuration
Bases: Property
The DURATION property specifies a positive duration of time.
Source code in ical_library/ical_properties/ical_duration.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
|
duration: pendulum.Duration
property
Return the value as a parsed pendulum.Duration. Example value: PT1H0M0S.
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not ICALDURATION but DURATION.
Source code in ical_library/ical_properties/ical_duration.py
17 18 19 20 |
|
LastModified
Bases: _DTSingular
The LAST-MODIFIED property specifies the date and time that the information associated with the calendar component was last revised in the calendar store.
Source code in ical_library/ical_properties/dt.py
123 124 125 126 127 128 129 130 131 132 |
|
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not LASTMODIFIED but LAST-MODIFIED.
Source code in ical_library/ical_properties/dt.py
129 130 131 132 |
|
Location
Bases: Property
The LOCATION property defines the intended venue for the activity defined by a calendar component.
Source code in ical_library/ical_properties/pass_properties.py
49 50 51 52 |
|
Method
Bases: Property
The METHOD property defines the iCalendar object method associated with the calendar object.
Source code in ical_library/ical_properties/pass_properties.py
28 29 30 31 |
|
Organizer
Bases: _CalAddress
The ORGANIZER property defines the organizer for a calendar component.
Source code in ical_library/ical_properties/cal_address.py
46 47 48 49 |
|
PercentComplete
Bases: _IntProperty
The PERCENT-COMPLETE property is used by an assignee or delegatee of a to-do to convey the percent completion of a to-do to the "Organizer".
Source code in ical_library/ical_properties/ints.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
|
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not PERCENTCOMPLETE but PERCENT-COMPLETE.
Source code in ical_library/ical_properties/ints.py
43 44 45 46 |
|
Priority
Bases: _IntProperty
The PRIORITY property represents the relative priority for a calendar component.
Source code in ical_library/ical_properties/ints.py
13 14 15 16 |
|
ProdID
Bases: Property
The PRODID property specifies the identifier for the product that created the iCalendar object.
Source code in ical_library/ical_properties/pass_properties.py
4 5 6 7 |
|
RDate
Bases: _ExOrRDate
The RDATE property defines the list of DATE-TIME values for recurring events, to-dos, journal entries, or time zone definitions.
Source code in ical_library/ical_properties/periods.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|
all_values: Union[List[DateTime], List[Date], List[Tuple[DateTime, DateTime]]]
property
A list of all recurring Dates, DateTimes or Periods. The periods are defined by tuples containing two
datetimes representing the start and stop respectively. The returned types in the list will be according to
the kind reported by self.kind()
.
kind: Optional[Literal['DATE-TIME', 'DATE', 'PERIOD']]
property
The kind of the values. It is either DATE-TIME, DATE or PERIOD. The default is DATE-TIME.
compute_max_end_date(component_duration)
To speed up the computation of the Timelines range, it's good to know the ending of the last recurring event of a recurrence property. This does not need to be perfect, it should just be an estimate (so we don't check EXDate and such).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
component_duration |
Duration
|
The duration of the component which has the recurring properties. |
required |
Returns:
Type | Description |
---|---|
DateTime
|
An estimate of the maximum end date across all occurrences. This value should always be at least the actual highest recurrence end date |
Source code in ical_library/ical_properties/periods.py
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|
RRule
Bases: Property
The RRULE property defines a rule or repeating pattern for recurring events, to-dos, journal entries, or time zone definitions.
For more in depth restrictions and possibilities we refer you to the RTFC 5545
section 3.3.10. Recurrence Rule
.
Source code in ical_library/ical_properties/rrule.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
|
by_day_dateutil: Optional[Tuple[weekday, ...]]
property
Return the by_day in the format dateutil expects which is a tuple of weekday instance.
Returns:
Type | Description |
---|---|
None or a tuple of weekday instances which is a type native to dateutil. |
by_easter: Optional[Tuple[int, ...]]
property
According to dateutil, this is an extension of the RFC specification.. I can't find it. If anyone can, please file an issue or a PR to add it here as a reference.
The BYEASTER rule part specifies the offset from the Easter Sunday.
Returns:
Type | Description |
---|---|
None or an integer in the range of 1 to 366 or -366 to -1 or None. |
by_hour: Optional[Tuple[int, ...]]
property
The BYHOUR rule part specifies a COMMA-separated list of hours of the day.
Returns:
Type | Description |
---|---|
None or a list of integers in the range of 0 to 23. |
by_minute: Optional[Tuple[int, ...]]
property
The BYMINUTE rule part specifies a COMMA-separated list of minutes within an hour.
Returns:
Type | Description |
---|---|
None or a list of integers in the range of 0 to 59. |
by_month: Optional[Tuple[int, ...]]
property
The BYMONTH rule part specifies a COMMA-separated list of months of the year.
Returns:
Type | Description |
---|---|
None or a list of integers in the range of 1 to 12. |
by_month_day: Optional[Tuple[int, ...]]
property
The BYMONTHDAY rule part specifies a COMMA-separated list of days of the month. For example: -10 represents the tenth to the last day of the month.
Returns:
Type | Description |
---|---|
None or a tuple of integers in the range of 1 to 31 or -31 to -1. |
by_second: Optional[Tuple[int, ...]]
property
The BYSECOND rule part specifies a COMMA-separated list of seconds within a minute.
Returns:
Type | Description |
---|---|
None or a list of integers in the range of 0 to 60. |
by_set_pos: Optional[Tuple[int, ...]]
property
The BYSETPOS rule part specifies a COMMA-separated list of values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule. BYSETPOS operates on a set of recurrence instances in one interval of the recurrence rule. For example, in a WEEKLY rule, the interval would be one week A set of recurrence instances starts at the beginning of the interval defined by the FREQ rule part.
Returns:
Type | Description |
---|---|
None or a list of integers in the range of 1 to 366 or -366 to -1. |
by_week_no: Optional[Tuple[int, ...]]
property
The BYWEEKNO rule part specifies a COMMA-separated list of ordinals specifying weeks of the year. For example: 3 represents the third week of the year.
Returns:
Type | Description |
---|---|
None or an integer in the range of 1 to 53 or -53 to -1. |
by_year_day: Optional[Tuple[int, ...]]
property
The BYYEARDAY rule part specifies a COMMA-separated list of days of the year. For example: -1 represents the last day of the year (December 31st).
Returns:
Type | Description |
---|---|
None or a tuple of integers in the range of 1 to 366 or -366 to -1. |
count: Optional[int]
property
The COUNT rule defines the number of occurrences at which to range-bound the recurrence. This is optional but may not occur together with UNTIL.
Returns:
Type | Description |
---|---|
None or a positive integer. |
freq: str
property
The FREQUENCY rule identifies the type of recurrence rule. Possible values are: SECONDLY, MINUTELY, HOURLY, DAILY, WEEKLY, MONTHLY and YEARLY. This is the only required field.
Returns:
Type | Description |
---|---|
The frequency as a string. |
freq_dateutil: int
property
Return the frequency in the format dateutil expects which is a map of the string to an integer.
Returns:
Type | Description |
---|---|
An integer in the range of 0 to 6. |
interval: int
property
The INTERVAL rule contains a positive integer representing at which intervals the recurrence rule repeats.
Returns:
Type | Description |
---|---|
A positive integer. |
until: Optional[Union[Date, DateTime]]
property
The UNTIL rule defines a DATE or DATE-TIME value that bounds the recurrence rule in an inclusive manner. This is optional but may not occur together with COUNT.
Returns:
Type | Description |
---|---|
None or a positive integer. |
value_as_dict: Dict[str, str]
property
Parse all recurrence rule parts as a dictionary, so it can be used as an easy lookup.
Returns:
Type | Description |
---|---|
A dict mapping of str to str containing all recurrence rule parts. |
wkst: Optional[str]
property
The WKST rule part specifies the day on which the workweek starts.
Returns:
Type | Description |
---|---|
A string that is the value of MO, TU, WE, TH, FR, SA, or SU or None. |
wkst_dateutil: Optional[int]
property
Return the wkst in the format dateutil expects which is an integer. 0 for MO, 1 for TU, 2 for WE, ...
Returns:
Type | Description |
---|---|
An integer in the range of 0 to 6 or None. |
by_day()
The BYDAY rule part specifies a COMMA-separated list of days of the week; SU indicates Sunday; MO indicates Monday; TU indicates Tuesday; WE indicates Wednesday; TH indicates Thursday; FR indicates Friday; and SA indicates Saturday.
Each BYDAY value can also be preceded by a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of a specific day within the MONTHLY or YEARLY "RRULE".
Example values are SU,TU or +2SU,-3TU
Source code in ical_library/ical_properties/rrule.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
|
compute_max_end_date(starting_datetime, component_duration)
To speed up the computation of the Timelines range, it's good to know the ending of the last recurring event of a recurrence property. This does not need to be perfect, it should just be an estimate (so we don't check EXDate and such).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
starting_datetime |
Union[Date, DateTime]
|
The starting datetime from which we start computing the next occurrences. |
required |
component_duration |
Duration
|
The duration of the component which has the recurring properties. |
required |
Returns:
Type | Description |
---|---|
DateTime
|
An estimate of the maximum end date across all occurrences. This value should always be at least the actual highest recurrence end date |
Source code in ical_library/ical_properties/rrule.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
|
convert_str_to_optional_integer_tuple(value)
staticmethod
Converts a string to a Tuple of integers.
Returns:
Type | Description |
---|---|
Optional[Tuple[int, ...]]
|
None or a Tuple of integers if the value exists, otherwise None. |
Source code in ical_library/ical_properties/rrule.py
78 79 80 81 82 83 84 85 86 |
|
sequence_iterator(starting_datetime, max_datetime)
Given a starting datetime, we compute dates according to the RRule specification until the end of the sequence according to the specification is reached or until we reached the max_datetime.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
starting_datetime |
Union[Date, DateTime]
|
The starting datetime from which we start computing the next occurrences. |
required |
max_datetime |
Union[Date, DateTime]
|
The maximum datetime. If we reach this datetime, we stop the iteration.. |
required |
Returns:
Type | Description |
---|---|
Iterator[DateTime]
|
Yield all datetimes(except itself) in the sequence. |
Source code in ical_library/ical_properties/rrule.py
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
|
RecurrenceID
Bases: _DTBoth
The RECURRENCE-ID property is defined as followed.
This property is used in conjunction with the "UID" and "SEQUENCE" properties to identify a specific instance of a recurring "VEVENT", "VTODO", or "VJOURNAL" calendar component. The property value is the original value of the "DTSTART" property of the recurrence instance. Value Type: The default value type is DATE-TIME. The value type can be set to a DATE value type. This property MUST have the same value type as the "DTSTART" property contained within the recurring component. Furthermore, this property MUST be specified as a date with local time if and only if the "DTSTART" property contained within the recurring component is specified as a date with local time.
Source code in ical_library/ical_properties/dt.py
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
|
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not LASTMODIFIED but LAST-MODIFIED.
Source code in ical_library/ical_properties/dt.py
86 87 88 89 |
|
RelatedTo
Bases: Property
The RELATED-TO property is used to represent a relationship or reference between one calendar component and another.
Source code in ical_library/ical_properties/pass_properties.py
106 107 108 109 110 111 112 113 114 |
|
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not RELATEDTO but RELATED-TO.
Source code in ical_library/ical_properties/pass_properties.py
111 112 113 114 |
|
Repeat
Bases: _IntProperty
The REPEAT property defines the number of times the alarm should be repeated, after the initial trigger.
Source code in ical_library/ical_properties/ints.py
27 28 29 30 |
|
RequestStatus
Bases: Property
The REQUEST-STATUS property defines the status code returned for a scheduling request.
Source code in ical_library/ical_properties/pass_properties.py
97 98 99 100 101 102 103 |
|
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not REQUESTSTATUS but REQUEST-STATUS.
Source code in ical_library/ical_properties/pass_properties.py
100 101 102 103 |
|
Resources
Bases: Property
The RESOURCES property defines the equipment or resources anticipated for an activity specified by a calendar component.
Source code in ical_library/ical_properties/pass_properties.py
117 118 119 120 121 122 123 |
|
Sequence
Bases: _IntProperty
The SEQUENCE property defines the revision sequence number of the calendar component within a sequence of revisions.
Source code in ical_library/ical_properties/ints.py
19 20 21 22 23 24 |
|
Status
Bases: Property
The STATUS property defines the overall status or confirmation for the calendar component.
Source code in ical_library/ical_properties/pass_properties.py
55 56 57 58 |
|
Summary
Bases: Property
The SUMMARY property defines a short summary or subject for the calendar component.
Source code in ical_library/ical_properties/pass_properties.py
168 169 170 171 172 173 |
|
TZID
Bases: Property
The TZID property specifies the text value that uniquely identifies the "VTIMEZONE" calendar component in the scope of an iCalendar object.
Source code in ical_library/ical_properties/pass_properties.py
150 151 152 153 154 155 156 |
|
TZName
Bases: Property
The TZNAME property specifies the customary designation for a time zone description.
Source code in ical_library/ical_properties/pass_properties.py
144 145 146 147 |
|
TZOffsetFrom
Bases: _TZOffset
The TZOFFSETFROM property specifies the offset that is in use prior to this time zone observance.
Source code in ical_library/ical_properties/tz_offset.py
33 34 35 36 |
|
TZOffsetTo
Bases: _TZOffset
The TZOFFSETTO property specifies the offset that is in use prior to this time zone observance.
Source code in ical_library/ical_properties/tz_offset.py
27 28 29 30 |
|
TZURL
Bases: Property
The TZURL property provides a means for a "VTIMEZONE" component to point to a network location that can be used to retrieve an up- to-date version of itself.
Source code in ical_library/ical_properties/pass_properties.py
159 160 161 162 163 164 165 |
|
TimeTransparency
Bases: Property
The TRANSP property defines whether an event is transparent to busy time searches.
Source code in ical_library/ical_properties/pass_properties.py
61 62 63 64 65 66 67 |
|
get_ical_name_of_class()
classmethod
Overwrite the iCal name of this class as it is not TIMETRANSPARANCY but TRANSP.
Source code in ical_library/ical_properties/pass_properties.py
64 65 66 67 |
|
Trigger
Bases: Property
The TRIGGER property specifies when an alarm will trigger.
Source code in ical_library/ical_properties/trigger.py
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
|
kind: Literal['DATE-TIME', 'DURATION']
property
Return the type of the property value.
parse_value()
Parse the value of this property based on the VALUE property parameter.
Source code in ical_library/ical_properties/trigger.py
18 19 20 21 22 23 24 25 26 27 28 29 |
|
trigger_relation()
Get the trigger relation, whether the duration should be relative to the start or the end of a component.
Source code in ical_library/ical_properties/trigger.py
31 32 33 |
|
UID
Bases: Property
The UID property defines the persistent, globally unique identifier for the calendar component.
Source code in ical_library/ical_properties/pass_properties.py
132 133 134 135 |
|
URL
Bases: Property
The URL property defines a Uniform Resource Locator (URL) associated with the iCalendar object.
Source code in ical_library/ical_properties/pass_properties.py
70 71 72 73 |
|
Version
Bases: Property
The VERSION property specifies the identifier corresponding to the highest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object.
Source code in ical_library/ical_properties/pass_properties.py
10 11 12 13 14 15 16 |
|