.. _package-rst-calendar:
======================
Package rst.calendar
======================
*Not documented*
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"32" [label=< | CalendarQueryResult |
|
| TimeZone | timezone |
| EventWithTimes | event |
| Todo | todo |
>,shape=box,style=filled,fillcolor="white"];
"33" [label=< | EventWithTimes |
|
| Event | event |
| TimePeriod | time |
>,shape=box,style=filled,fillcolor="white"];
"34" [label=< | TimePeriod |
|
| DateTime | start |
| DateTime | end |
>,shape=box,style=filled,fillcolor="white"];
"31" [label=< | CalendarQuery |
|
| DateTime | start_time |
| DateTime | end_time |
| BOOL | search_todos |
| BOOL | search_events |
| BOOL | calculate_time_periods |
>,shape=box,style=filled,fillcolor="white"];
"30" [label=< | CalendarUpdate |
|
| TimeZone | timezones |
| Event | changed_events |
| Todo | changed_todos |
| ASCII-STRING | removed_entry_ids |
>,shape=box,style=filled,fillcolor="white"];
"29" [label=< | CalendarList |
|
| ASCII-STRING | calendar_id |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | CalendarComponents |
|
| TimeZone | timezones |
| Event | events |
| Todo | todos |
>,shape=box,style=filled,fillcolor="white"];
"27" [label=< | Todo |
|
| Entry | entry |
| DateTime | completed_utc |
| UINT32 | percent |
| TodoStatus | todo_status |
| DateTime | due |
| INT64 | duration |
>,shape=box,style=filled,fillcolor="white"];
"28" [label=< | TodoStatus |
|
| NEEDS_ACTION | 1 |
| COMPLETED | 2 |
| IN_PROCESS | 3 |
| CANCELED | 4 |
>,shape=box,style=filled,fillcolor="white"];
"11" [label=< | Event |
|
| Entry | entry |
| EventStatus | event_status |
| Transparency | transparency |
| DateTime | end_date_time |
| INT64 | duration |
>,shape=box,style=filled,fillcolor="white"];
"26" [label=< | Transparency |
|
| TRANSPARENT | 1 |
| OPAQUE | 2 |
>,shape=box,style=filled,fillcolor="white"];
"25" [label=< | EventStatus |
|
| TENTATIVE | 1 |
| CONFIRMED | 2 |
| CANCELED | 3 |
>,shape=box,style=filled,fillcolor="white"];
"12" [label=< | Entry |
|
| Visibility | visibility |
| DateTime | created_utc |
| ASCII-STRING | description |
| DateTime | date_time_start |
| FLOAT64 | geo_latitude |
| FLOAT64 | geo_longitude |
| DateTime | last_modified |
| ASCII-STRING | location |
| Organizer | organizer |
| UINT32 | priority |
| DateTime | date_time_stamp |
| UINT32 | sequence_number |
| ASCII-STRING | summary |
| ASCII-STRING | uid |
| ASCII-STRING | url |
| RecurrenceId | recurrence_id |
| ASCII-STRING | attach |
| Attendee | attendees |
| ASCII-STRING | categories |
| ASCII-STRING | comments |
| ASCII-STRING | contacts |
| Recurrence | recurrence |
| RequestStatus | request_status |
| Relationship | related |
| ASCII-STRING | resources |
>,shape=box,style=filled,fillcolor="white"];
"23" [label=< | Relationship |
|
| Type | relationship_type |
| ASCII-STRING | uid |
>,shape=box,style=filled,fillcolor="white"];
"24" [label=< | Type |
|
| PARENT | 1 |
| CHILD | 2 |
| SIBLING | 3 |
>,shape=box,style=filled,fillcolor="white"];
"22" [label=< | RequestStatus |
|
| ASCII-STRING | language |
| ASCII-STRING | status_code |
| ASCII-STRING | status_description |
| ASCII-STRING | exception_text_data |
>,shape=box,style=filled,fillcolor="white"];
"18" [label=< | Attendee |
|
| ASCII-STRING | calendar_adress |
| UserType | calendar_user_type |
| ASCII-STRING | member |
| Role | participation_role |
| ParticipationStatus | participation_status |
| BOOL | reply_requested |
| ASCII-STRING | delegated_to |
| ASCII-STRING | delegated_from |
| ASCII-STRING | sent_by |
| ASCII-STRING | common_name |
| ASCII-STRING | directory |
| ASCII-STRING | language |
>,shape=box,style=filled,fillcolor="white"];
"21" [label=< | ParticipationStatus |
|
| NEEDS_ACTION | 1 |
| ACCEPTED | 2 |
| DECLINED | 3 |
>,shape=box,style=filled,fillcolor="white"];
"20" [label=< | Role |
|
| CHAIR | 1 |
| REQUIRED_PARTICIPANT | 2 |
| OPTIONAL_PARTICIPANT | 3 |
| NON_PARTICIPANT | 4 |
>,shape=box,style=filled,fillcolor="white"];
"19" [label=< | UserType |
|
| INDIVIDUAL | 1 |
| GROUP | 2 |
| RESOURCE | 3 |
| ROOM | 4 |
>,shape=box,style=filled,fillcolor="white"];
"15" [label=< | RecurrenceId |
|
| Type | type |
| Range | range |
| DateTime | rid |
>,shape=box,style=filled,fillcolor="white"];
"17" [label=< | Range |
|
| SINGLE | 1 |
| THIS_AND_FUTURE | 2 |
| THIS_AND_PRIOR | 3 |
>,shape=box,style=filled,fillcolor="white"];
"16" [label=< | Type |
|
| DATE_TIME | 1 |
| DATE | 2 |
>,shape=box,style=filled,fillcolor="white"];
"14" [label=< | Organizer |
|
| ASCII-STRING | calendar_address |
| ASCII-STRING | common_name |
| ASCII-STRING | directory |
| ASCII-STRING | sent_by |
| ASCII-STRING | language |
>,shape=box,style=filled,fillcolor="white"];
"13" [label=< | Visibility |
|
| PUBLIC | 1 |
| PRIVATE | 2 |
| CONFIDENTIAL | 3 |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | TimeZone |
|
| ASCII-STRING | timezone_id |
| DateTime | last_modified_utc |
| ASCII-STRING | timezone_url |
| ASCII-STRING | x_location |
| Observance | standards |
| Observance | daylights |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | Observance |
|
| Type | type |
| DateTime | start_utc |
| ASCII-STRING | name |
| Recurrence | recurrence |
| INT64 | offset_from |
| INT64 | offset_to |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | Recurrence |
|
| DateTime | recurrence_dates |
| RecurrenceRule | recurrence_rules |
| DateTime | exclude_dates |
| RecurrenceRule | exclude_rules |
>,shape=box,style=filled,fillcolor="white"];
"8" [label=< | RecurrenceRule |
|
| DateTime | until_date_utc |
| UINT32 | count |
| Frequency | frequency |
| UINT32 | interval |
| UINT32 | by_second |
| UINT32 | by_minute |
| UINT32 | by_hour |
| Weekday | by_week_day |
| INT32 | by_day_number |
| INT32 | by_month_day |
| INT32 | by_year_day |
| INT32 | by_week_number |
| UINT32 | by_month |
| INT32 | by_set_pos |
| Weekday | week_start |
>,shape=box,style=filled,fillcolor="white"];
"10" [label=< | Weekday |
|
| SUNDAY | 1 |
| MONDAY | 2 |
| TUESDAY | 3 |
| WEDNESDAY | 4 |
| THURSDAY | 5 |
| FRIDAY | 6 |
| SATURDAY | 7 |
>,shape=box,style=filled,fillcolor="white"];
"9" [label=< | Frequency |
|
| SECONDLY | 1 |
| MINUTELY | 2 |
| HOURLY | 3 |
| DAILY | 4 |
| WEEKLY | 5 |
| MONTHLY | 6 |
| YEARLY | 7 |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | Type |
|
| STANDARD | 1 |
| DAYLIGHT | 2 |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | DateTime |
|
| Type | date_time_type |
| ASCII-STRING | timezone_id |
| UINT64 | milliseconds_since_epoch |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | Type |
|
| UTC | 1 |
| FLOATING | 2 |
| LOCAL | 3 |
>,shape=box,style=filled,fillcolor="white"];
"32" -> "33"[dir=both,arrowtail=odiamond];
"32" -> "34"[dir=both,arrowtail=odiamond];
"32":todo -> "27"[];
"32":event -> "33"[];
"32":timezone -> "2"[];
"33":time -> "34"[];
"33":event -> "11"[];
"34":end -> "3"[];
"34":start -> "3"[];
"31":end_time -> "3"[];
"31":start_time -> "3"[];
"30":changed_todos -> "27"[];
"30":changed_events -> "11"[];
"30":timezones -> "2"[];
"1":todos -> "27"[];
"1":events -> "11"[];
"1":timezones -> "2"[];
"27" -> "28"[dir=both,arrowtail=odiamond];
"27":due -> "3"[];
"27":todo_status -> "28"[];
"27":completed_utc -> "3"[];
"27":entry -> "12"[];
"11" -> "26"[dir=both,arrowtail=odiamond];
"11" -> "25"[dir=both,arrowtail=odiamond];
"11":end_date_time -> "3"[];
"11":transparency -> "26"[];
"11":event_status -> "25"[];
"11":entry -> "12"[];
"12" -> "13"[dir=both,arrowtail=odiamond];
"12":related -> "23"[];
"12":request_status -> "22"[];
"12":recurrence -> "7"[];
"12":attendees -> "18"[];
"12":recurrence_id -> "15"[];
"12":date_time_stamp -> "3"[];
"12":organizer -> "14"[];
"12":last_modified -> "3"[];
"12":date_time_start -> "3"[];
"12":created_utc -> "3"[];
"12":visibility -> "13"[];
"23" -> "24"[dir=both,arrowtail=odiamond];
"23":relationship_type -> "24"[];
"18" -> "21"[dir=both,arrowtail=odiamond];
"18" -> "20"[dir=both,arrowtail=odiamond];
"18" -> "19"[dir=both,arrowtail=odiamond];
"18":participation_status -> "21"[];
"18":participation_role -> "20"[];
"18":calendar_user_type -> "19"[];
"15" -> "17"[dir=both,arrowtail=odiamond];
"15" -> "16"[dir=both,arrowtail=odiamond];
"15":rid -> "3"[];
"15":range -> "17"[];
"15":type -> "16"[];
"2":daylights -> "5"[];
"2":standards -> "5"[];
"2":last_modified_utc -> "3"[];
"5" -> "6"[dir=both,arrowtail=odiamond];
"5":recurrence -> "7"[];
"5":start_utc -> "3"[];
"5":type -> "6"[];
"7":exclude_rules -> "8"[];
"7":exclude_dates -> "3"[];
"7":recurrence_rules -> "8"[];
"7":recurrence_dates -> "3"[];
"8" -> "10"[dir=both,arrowtail=odiamond];
"8" -> "9"[dir=both,arrowtail=odiamond];
"8":week_start -> "10"[];
"8":by_week_day -> "10"[];
"8":frequency -> "9"[];
"8":until_date_utc -> "3"[];
"3" -> "4"[dir=both,arrowtail=odiamond];
"3":date_time_type -> "4"[];
.. container:: mess4ge-list
.. container:: messages
* :ref:`CalendarComponents `
* :ref:`CalendarList `
* :ref:`CalendarUpdate `
* :ref:`CalendarQuery `
* :ref:`CalendarQueryResult `
* :ref:`Todo `
* :ref:`Event `
* :ref:`Entry `
* :ref:`RequestStatus `
* :ref:`Organizer `
* :ref:`Attendee `
* :ref:`RecurrenceId `
* :ref:`TimeZone `
* :ref:`Observance `
* :ref:`Recurrence `
* :ref:`RecurrenceRule `
* :ref:`DateTime `
* :ref:`Relationship `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-calendar-calendarcomponents:
Message CalendarComponents
--------------------------
.. container:: message-rst-calendar-calendarcomponents-multi
.. container:: message-rst-calendar-calendarcomponents-documentation
.. py:class:: rst.calendar.CalendarComponents
A container message for multiple calendar components.
.. codeauthor:: Viktor Richter
.. py:attribute:: timezones
:type: array of :py:class:`rst.calendar.TimeZone`
A set of TimeZones
.. py:attribute:: events
:type: array of :py:class:`rst.calendar.Event`
A set of Events
.. py:attribute:: todos
:type: array of :py:class:`rst.calendar.Todo`
A set of Todos
.. container:: message-rst-calendar-calendarcomponents-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/CalendarComponents.proto
:lines: 16-33
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16
.. _message-rst-calendar-calendarlist:
Message CalendarList
--------------------
.. container:: message-rst-calendar-calendarlist-multi
.. container:: message-rst-calendar-calendarlist-documentation
.. py:class:: rst.calendar.CalendarList
A List of available calendars.
.. codeauthor:: Viktor Richter
.. py:attribute:: calendar_id
:type: array of :py:class:`ASCII-STRING`
A List of calender id.
.. container:: message-rst-calendar-calendarlist-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/CalendarList.proto
:lines: 12-19
:language: protobuf
:emphasize-lines: 6-6
.. _message-rst-calendar-calendarupdate:
Message CalendarUpdate
----------------------
.. container:: message-rst-calendar-calendarupdate-multi
.. container:: message-rst-calendar-calendarupdate-documentation
.. py:class:: rst.calendar.CalendarUpdate
Describes changes between two calendar versions.
.. codeauthor:: Viktor Richter
.. py:attribute:: timezones
:type: array of :py:class:`rst.calendar.TimeZone`
A set of messages needed by the
messages and messages in this message.
.. py:attribute:: changed_events
:type: array of :py:class:`rst.calendar.Event`
A set of messages which changed between the two
versions.
.. py:attribute:: changed_todos
:type: array of :py:class:`rst.calendar.Todo`
A set of messages which changed between the two
versions.
.. py:attribute:: removed_entry_ids
:type: array of :py:class:`ASCII-STRING`
A set of ids of entries ( and messages)
which were removed between the two versions.
.. container:: message-rst-calendar-calendarupdate-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/CalendarUpdate.proto
:lines: 16-42
:language: protobuf
:emphasize-lines: 7-7,13-13,19-19,25-25
.. _message-rst-calendar-calendarquery:
Message CalendarQuery
---------------------
.. container:: message-rst-calendar-calendarquery-multi
.. container:: message-rst-calendar-calendarquery-documentation
.. py:class:: rst.calendar.CalendarQuery
A request for calendar data.
.. codeauthor:: Viktor Richter
.. py:attribute:: start_time
:type: :py:class:`rst.calendar.DateTime`
Ignore calendar components before start time.
.. py:attribute:: end_time
:type: :py:class:`rst.calendar.DateTime`
Ignore calendar components afrer end time.
.. py:attribute:: search_todos
:type: :py:class:`BOOL`
Search for entries.
.. py:attribute:: search_events
:type: :py:class:`BOOL`
Search for entries.
.. py:attribute:: calculate_time_periods
:type: :py:class:`BOOL`
If this is true, each entry which is between :py:attr:`start_time `
and :py:attr:`end_time ` will be augmented with a list of time
periods in which it occurs.
.. container:: message-rst-calendar-calendarquery-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/CalendarQuery.proto
:lines: 14-43
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16,21-21,28-28
.. _message-rst-calendar-calendarqueryresult:
Message CalendarQueryResult
---------------------------
.. container:: message-rst-calendar-calendarqueryresult-multi
.. container:: message-rst-calendar-calendarqueryresult-documentation
.. py:class:: rst.calendar.CalendarQueryResult
The answer to a .
.. codeauthor:: Viktor Richter
.. py:attribute:: timezone
:type: array of :py:class:`rst.calendar.TimeZone`
The list of timezones needed by the and
messages contained in this message.
.. py:attribute:: event
:type: array of :py:class:`rst.calendar.CalendarQueryResult.EventWithTimes`
A list of messages that match the corresponding and their occurrence times (when requested).
.. py:attribute:: todo
:type: array of :py:class:`rst.calendar.Todo`
A list of messages that match the corresponding .
.. container:: message-rst-calendar-calendarqueryresult-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/CalendarQueryResult.proto
:lines: 17-71
:language: protobuf
:emphasize-lines: 40-40,46-46,52-52
.. _message-rst-calendar-calendarqueryresult-timeperiod:
Message TimePeriod
------------------
.. container:: message-rst-calendar-calendarqueryresult-timeperiod-multi
.. container:: message-rst-calendar-calendarqueryresult-timeperiod-documentation
.. py:class:: rst.calendar.CalendarQueryResult.TimePeriod
Describes one specific time period.
.. py:attribute:: start
:type: :py:class:`rst.calendar.DateTime`
When the time period starts.
.. py:attribute:: end
:type: :py:class:`rst.calendar.DateTime`
When the time period ends.
.. container:: message-rst-calendar-calendarqueryresult-timeperiod-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/CalendarQueryResult.proto
:lines: 22-33
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-calendar-calendarqueryresult-eventwithtimes:
Message EventWithTimes
----------------------
.. container:: message-rst-calendar-calendarqueryresult-eventwithtimes-multi
.. container:: message-rst-calendar-calendarqueryresult-eventwithtimes-documentation
.. py:class:: rst.calendar.CalendarQueryResult.EventWithTimes
Describes an event and optionally all of its occurrences.
.. py:attribute:: event
:type: :py:class:`rst.calendar.Event`
The event description.
.. py:attribute:: time
:type: array of :py:class:`rst.calendar.CalendarQueryResult.TimePeriod`
Time periods where this event applies to.
.. container:: message-rst-calendar-calendarqueryresult-eventwithtimes-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/CalendarQueryResult.proto
:lines: 38-50
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-calendar-todo:
Message Todo
------------
.. container:: message-rst-calendar-todo-multi
.. container:: message-rst-calendar-todo-documentation
.. py:class:: rst.calendar.Todo
A description of an calendar todo following the icalendar definitions.
This message represents a VTODO component in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: entry
:type: :py:class:`rst.calendar.Entry`
This field holds all properties that Todo has in common with Event.
It corresponds to the following properties: class, created, description,
dtstamp, dtstart, geo, last-mod, location, organizer, priority, seq,
summary, uid, url, recurid, attach, attendee, categories, comment,
contact, exdate, exrule, rstatus, related, resources, rdate and rrule
int the VTODO component in RFC 2445.
.. py:attribute:: completed_utc
:type: :py:class:`rst.calendar.DateTime`
**Constraint**: ``value.type == DateTime.Type.UTC``
Specifies the date and time this Todo was completed in utc.
This field corresponds to the completed property of VTODO in RFC 2445.
.. py:attribute:: percent
:type: :py:class:`UINT32`
**Constraint**: ``0 <= value <= 100``
Specifies the completion status of the Todo in percent as a positive
integer (0-100).
This field corresponds to the completed property of VTODO in RFC 2445.
.. py:attribute:: todo_status
:type: :py:class:`rst.calendar.Todo.TodoStatus`
The overall status of the Todo.
This field corresponds to the status property of VTODO in RFC 2445.
.. py:attribute:: due
:type: :py:class:`rst.calendar.DateTime`
Specifies due which date the Todo needs to be done.
Either due or duration can be specified but not both at the same time.
This field corresponds to the due property of VTODO in RFC 2445.
.. py:attribute:: duration
:type: :py:class:`INT64`
Specifies the duration of the Todo in milliseconds.
Either due or duration can be specified but not both at the same time.
This field corresponds to the duration property of VTODO in RFC 2445.
.. container:: message-rst-calendar-todo-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Todo.proto
:lines: 20-99
:language: protobuf
:emphasize-lines: 38-38,46-46,55-55,62-62,70-70,78-78
.. _message-rst-calendar-todo-todostatus:
Message TodoStatus
------------------
.. container:: message-rst-calendar-todo-todostatus-multi
.. container:: message-rst-calendar-todo-todostatus-documentation
.. py:class:: rst.calendar.Todo.TodoStatus
The overall status of a todo.
.. py:attribute:: NEEDS_ACTION
= 1
Used for todos that need an action.
.. py:attribute:: COMPLETED
= 2
Used for completed todos.
.. py:attribute:: IN_PROCESS
= 3
Used for todos that are currently in process of.
.. py:attribute:: CANCELED
= 4
Used for canceled todos.
.. container:: message-rst-calendar-todo-todostatus-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Todo.proto
:lines: 25-46
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16,21-21
.. _message-rst-calendar-event:
Message Event
-------------
.. container:: message-rst-calendar-event-multi
.. container:: message-rst-calendar-event-documentation
.. py:class:: rst.calendar.Event
A description of a calendar event following the iCalendar definitions.
This message represents a VEVENT component in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: entry
:type: :py:class:`rst.calendar.Entry`
This field holds all properties that Event has in common with Todo.
It corresponds to the following properties: class, created, description,
dtstamp, dtstart, geo, last-mod, location, organizer, priority, seq,
summary, uid, url, recurid, attach, attendee, categories, comment,
contact, exdate, exrule, rstatus, related, resources, rdate and rrule
int the VTODO component in RFC 2445.
.. py:attribute:: event_status
:type: :py:class:`rst.calendar.Event.EventStatus`
The overall status of the event.
This field corresponds to the status property of VEVENT in RFC 2445.
.. py:attribute:: transparency
:type: :py:class:`rst.calendar.Event.Transparency`
Specifies whether this event is transparent to busy-time searches or not.
This field corresponds to the transp property of VEVENT in RFC 2445.
corresponds to TRANSP
.. py:attribute:: end_date_time
:type: :py:class:`rst.calendar.DateTime`
Specifies the date and time when the event ends.
Either end_date_time or duration can be specified but not both at the
same time.
This field corresponds to the dtend property of VEVENT in RFC 2445.
.. py:attribute:: duration
:type: :py:class:`INT64`
Specifies the duration of the event in milliseconds.
Either end_date_time or duration can be specified but not both at the
same time.
This field corresponds to the duration property of VEVENT in RFC 2445.
.. container:: message-rst-calendar-event-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Event.proto
:lines: 20-102
:language: protobuf
:emphasize-lines: 49-49,56-56,64-64,73-73,82-82
.. _message-rst-calendar-event-eventstatus:
Message EventStatus
-------------------
.. container:: message-rst-calendar-event-eventstatus-multi
.. container:: message-rst-calendar-event-eventstatus-documentation
.. py:class:: rst.calendar.Event.EventStatus
The overall status of an event.
.. py:attribute:: TENTATIVE
= 1
Used for tentative events.
.. py:attribute:: CONFIRMED
= 2
Used for confirmed events.
.. py:attribute:: CANCELED
= 3
Used for canceled events.
.. container:: message-rst-calendar-event-eventstatus-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Event.proto
:lines: 25-41
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16
.. _message-rst-calendar-event-transparency:
Message Transparency
--------------------
.. container:: message-rst-calendar-event-transparency-multi
.. container:: message-rst-calendar-event-transparency-documentation
.. py:class:: rst.calendar.Event.Transparency
The transparency of an event.
.. py:attribute:: TRANSPARENT
= 1
Used for events which do not consume time in the calendar.
.. py:attribute:: OPAQUE
= 2
Used for events which actually consume time in the calendar.
.. container:: message-rst-calendar-event-transparency-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Event.proto
:lines: 46-57
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-calendar-entry:
Message Entry
-------------
.. container:: message-rst-calendar-entry-multi
.. container:: message-rst-calendar-entry-documentation
.. py:class:: rst.calendar.Entry
A description of a calendar entry holding the common properties of
VEVENT and VTODO components from RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: visibility
:type: :py:class:`rst.calendar.Entry.Visibility`
Specifies the visibility classification of this entry.
This field corresponds to the class property of an entry in RFC 2445.
.. py:attribute:: created_utc
:type: :py:class:`rst.calendar.DateTime`
**Constraint**: ``value.type == DateTime.Type.UTC``
Specifies when the entry was created in utc time.
More precisely: Tells when the entry was first created in the
calendar store.
This field corresponds to the created property of an entry in RFC 2445.
.. py:attribute:: description
:type: :py:class:`ASCII-STRING`
A more complete description of the entry.
This field corresponds to the description property of an entry in
RFC 2445.
.. py:attribute:: date_time_start
:type: :py:class:`rst.calendar.DateTime`
Specifies when the entry starts.
This field corresponds to the dtstart property of an entry in RFC 2445.
.. py:attribute:: geo_latitude
:type: :py:class:`FLOAT64`
Specifies the global position of the associated activity.
This field corresponds to the latitude part of the geo property of an
entry in RFC 2445.
.. py:attribute:: geo_longitude
:type: :py:class:`FLOAT64`
Specifies the global position of the associated activity.
This field corresponds to the longitude part of the geo property of an
entry in RFC 2445.
.. py:attribute:: last_modified
:type: :py:class:`rst.calendar.DateTime`
**Constraint**: ``value.type == DateTime.Type.UTC``
Specifies when the entry was modified the last time in utc time.
More precisely: Tells when the entry was last modified in the
calendar store.
This field corresponds to the last-mod property of an entry in RFC 2445.
.. py:attribute:: location
:type: :py:class:`ASCII-STRING`
Specifies where the entry will take place.
This field corresponds to the location property of an entry in RFC 2445.
.. py:attribute:: organizer
:type: :py:class:`rst.calendar.Organizer`
Defines the organizer of the entry.
This field corresponds to the organizer property of an entry in RFC 2445.
.. py:attribute:: priority
:type: :py:class:`UINT32`
**Constraint**: ``0 <= value <= 9``
The priority of the entry as an integer between 0 and 9.
0 means not defined, 1 means highest, 9 means lowest priority.
This field corresponds to the priority property of an entry in RFC 2445.
.. py:attribute:: date_time_stamp
:type: :py:class:`rst.calendar.DateTime`
Specifies when the entry was created.
More precise: When the iCalendar object representation of the calendar
service information was created or last modified.
This field corresponds to the dtstamp property of an entry in RFC 2445.
.. py:attribute:: sequence_number
:type: :py:class:`UINT32`
This is incremented every time the entry is changed significantly.
This field corresponds to the seq property of an entry in RFC 2445.
.. py:attribute:: summary
:type: :py:class:`ASCII-STRING`
A short summary or the subject of the entry.
This field corresponds to the summary property of an entry in RFC 2445.
.. py:attribute:: uid
:type: :py:class:`ASCII-STRING`
The globally unique id of the entry.
This field corresponds to the uid property of an entry in RFC 2445.
.. py:attribute:: url
:type: :py:class:`ASCII-STRING`
The Uniform Resource Locator associated with this entry.
This field corresponds to the url property of an entry in RFC 2445.
.. py:attribute:: recurrence_id
:type: :py:class:`rst.calendar.RecurrenceId`
Combined with uid and sequence, this can be used to reference a specific
entry in a recurrence set.
This field corresponds to the recurid property of an entry in RFC 2445.
.. py:attribute:: attach
:type: array of :py:class:`ASCII-STRING`
This provides a means to attach a document via URI or binary attachment
as string.
This field corresponds to the attach property of an entry in RFC 2445.
.. py:attribute:: attendees
:type: array of :py:class:`rst.calendar.Attendee`
Specifies attendees to this entry.
This field corresponds to the attendee property of an entry in RFC 2445.
.. py:attribute:: categories
:type: array of :py:class:`ASCII-STRING`
A list of categories, this entry is associated with.
This field corresponds to the categories property of an entry in RFC 2445.
.. py:attribute:: comments
:type: array of :py:class:`ASCII-STRING`
Provides a comment to this entry.
This field corresponds to the comment property of an entry in RFC 2445.
.. py:attribute:: contacts
:type: array of :py:class:`ASCII-STRING`
Contact information or reference to contact information.
This field corresponds to the contact property of an entry in RFC 2445.
.. py:attribute:: recurrence
:type: :py:class:`rst.calendar.Recurrence`
Specifies a set of dates when the entry is.
This field corresponds to rdate, rrule, exdate and exrule properties of
an entry in RFC 2445.
.. py:attribute:: request_status
:type: array of :py:class:`rst.calendar.RequestStatus`
Holds the status code of a scheduling request.
This field corresponds to the rstatus property of an entry in RFC 2445.
.. py:attribute:: related
:type: array of :py:class:`rst.calendar.Relationship`
Represents relationships to other calendar components.
This field corresponds to the related property of an entry in RFC 2445.
.. py:attribute:: resources
:type: array of :py:class:`ASCII-STRING`
Specifies the equipment or resources needed for this entry.
This field corresponds to the resources property of an entry in RFC 2445.
.. container:: message-rst-calendar-entry-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Entry.proto
:lines: 25-245
:language: protobuf
:emphasize-lines: 31-31,42-42,50-50,57-57,65-65,73-73,84-84,91-91,98-98,108-108,118-118,125-125,132-132,139-139,146-146,154-154,162-162,169-169,176-176,183-183,190-190,198-198,205-205,212-212,219-219
.. _message-rst-calendar-entry-visibility:
Message Visibility
------------------
.. container:: message-rst-calendar-entry-visibility-multi
.. container:: message-rst-calendar-entry-visibility-documentation
.. py:class:: rst.calendar.Entry.Visibility
This enum is used to restrict access or visibility of of the entry.
It represents the possible values of a CLASS in RFC 2445
.. py:attribute:: PUBLIC
= 1
The entry can be seen by everyone.
.. py:attribute:: PRIVATE
= 2
The entry is private.
.. py:attribute:: CONFIDENTIAL
= 3
The entry is confidential.
.. container:: message-rst-calendar-entry-visibility-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Entry.proto
:lines: 32-48
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16
.. _message-rst-calendar-requeststatus:
Message RequestStatus
---------------------
.. container:: message-rst-calendar-requeststatus-multi
.. container:: message-rst-calendar-requeststatus-documentation
.. py:class:: rst.calendar.RequestStatus
A description of a status code used in scheduling requests.
This message represents a REQUEST-STATUS property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: language
:type: :py:class:`ASCII-STRING`
Specifies the language used in the status code as defined in
http://www.ietf.org/rfc/rfc1766.txt.
This field corresponds to the languageparm parameter of REQUEST-STATUS
in RFC 2445.
.. py:attribute:: status_code
:type: :py:class:`ASCII-STRING`
A hierarchical numeric status code as string.
3-tuple of integers separated by a period character.
example: "3.1.2"
The level of the integer corresponds to the level of status code
granularity (least granularity to highest from left to right).
The return status interpretation of the leftmost integer is following:
1.xx preliminary success, completion is pending
2.xx completed successfully
3.xx not successful, error in the syntax or semantic of the request
4.xx scheduling error, an error occurred within the calendaring service
not directly related to the request itself.
This field corresponds to the statcode parameter of REQUEST-STATUS
in RFC 2445.
.. py:attribute:: status_description
:type: :py:class:`ASCII-STRING`
A status description text.
This field corresponds to the statdesc parameter of REQUEST-STATUS
in RFC 2445.
.. py:attribute:: exception_text_data
:type: :py:class:`ASCII-STRING`
Exception data as text. Can be the offending property name and value or
a complete property line.
This field corresponds to the extdata parameter of REQUEST-STATUS
in RFC 2445.
.. container:: message-rst-calendar-requeststatus-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/RequestStatus.proto
:lines: 17-65
:language: protobuf
:emphasize-lines: 10-10,30-30,38-38,47-47
.. _message-rst-calendar-organizer:
Message Organizer
-----------------
.. container:: message-rst-calendar-organizer-multi
.. container:: message-rst-calendar-organizer-documentation
.. py:class:: rst.calendar.Organizer
A description of a organizer of a calendar component.
This message represents a ORGANIZER property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: calendar_address
:type: :py:class:`ASCII-STRING`
Specifies the organizers calendar user address as URI.
Can for example be a MAILTO.
This field corresponds to cal-address of an ORGANIZER in RFC 2445.
.. py:attribute:: common_name
:type: :py:class:`ASCII-STRING`
Specifies the common or display name of the organizer.
This field corresponds to cnparam of an ORGANIZER in RFC 2445.
.. py:attribute:: directory
:type: :py:class:`ASCII-STRING`
Specifies a reference (uri) to the directory entry associated with the
calendar user acting as organizer.
This field corresponds to dirparam of an ORGANIZER in RFC 2445.
.. py:attribute:: sent_by
:type: :py:class:`ASCII-STRING`
Specifies another user that is acting on behalf of the organizer.
This field corresponds to sentbyparam of an ORGANIZER in RFC 2445.
.. py:attribute:: language
:type: :py:class:`ASCII-STRING`
Specifies the language as defined in http://www.ietf.org/rfc/rfc1766.txt.
If specified the language applies to the common_name field.
This field corresponds to languageparam of an ORGANIZER in RFC 2445.
.. container:: message-rst-calendar-organizer-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Organizer.proto
:lines: 17-57
:language: protobuf
:emphasize-lines: 9-9,16-16,24-24,31-31,39-39
.. _message-rst-calendar-attendee:
Message Attendee
----------------
.. container:: message-rst-calendar-attendee-multi
.. container:: message-rst-calendar-attendee-documentation
.. py:class:: rst.calendar.Attendee
A description of an Attendee of a calendar component.
This message represents an ATTENDEE property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: calendar_adress
:type: :py:class:`ASCII-STRING`
Specifies the attendees calendar user address as URI, which can for
example be a MAILTO.
This field corresponds to the cal-address of an attendee in RFC 2445
.. py:attribute:: calendar_user_type
:type: :py:class:`rst.calendar.Attendee.UserType`
Specifies what type of calendar user this attendee is.
An attendee can be a person, group, room or resource.
This field corresponds to the cutypeparam of an attendee in RFC 2445
.. py:attribute:: member
:type: array of :py:class:`ASCII-STRING`
Specifies the groups the attendee belongs to via a list of URIs.
This field corresponds to the memberparam of an attendee in RFC 2445.
The original memberparam is a single string holding the uris as a comma
separated list of double quoted uris.
.. py:attribute:: participation_role
:type: :py:class:`rst.calendar.Attendee.Role`
Specifies the participation role of the attendee.
This field corresponds to the roleparam of an attendee in RFC 2445
.. py:attribute:: participation_status
:type: :py:class:`rst.calendar.Attendee.ParticipationStatus`
Specifies the participation status of the attendee.
This field corresponds to the partstatparam of an attendee in RFC 2445
.. py:attribute:: reply_requested
:type: :py:class:`BOOL`
Specifies whether the favor of a reply is requested.
This field corresponds to the rsvpparam of an attendee in RFC 2445
.. py:attribute:: delegated_to
:type: :py:class:`ASCII-STRING`
An URI specifying a user to whom this participation was delegated.
This field corresponds to the deltoparam of an attendee in RFC 2445
.. py:attribute:: delegated_from
:type: :py:class:`ASCII-STRING`
An URI specifying a user from which this participation was delegated.
This field corresponds to the delfromparam of an attendee in RFC 2445
.. py:attribute:: sent_by
:type: :py:class:`ASCII-STRING`
Specifies another user that is acting on behalf of the attendee
This field corresponds to the sentbyparam of an attendee in RFC 2445
.. py:attribute:: common_name
:type: :py:class:`ASCII-STRING`
Specifies the common or display name of the attendee.
This field corresponds to the cnparam of an attendee in RFC 2445
.. py:attribute:: directory
:type: :py:class:`ASCII-STRING`
Specifies a reference (uri) to the directory entry associated with the
calendar user acting as attendee.
This field corresponds to the dirparam of an attendee in RFC 2445
.. py:attribute:: language
:type: :py:class:`ASCII-STRING`
Specifies the language as defined in http://www.ietf.org/rfc/rfc1766.txt.
If specified the language applies to the common_name field.
This field corresponds to the languageparam of an attendee in RFC 2445
.. container:: message-rst-calendar-attendee-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Attendee.proto
:lines: 17-191
:language: protobuf
:emphasize-lines: 91-91,99-99,108-108,115-115,122-122,129-129,136-136,143-143,150-150,157-157,165-165,173-173
.. _message-rst-calendar-attendee-usertype:
Message UserType
----------------
.. container:: message-rst-calendar-attendee-usertype-multi
.. container:: message-rst-calendar-attendee-usertype-documentation
.. py:class:: rst.calendar.Attendee.UserType
Used to identify the type of a calendar user specified by an
attendee definition. An attendee at a calender event does
not inevitably have to be a person. It also can be a group
room or different noteworthy physical resource.
This enum represents the possible values of a CUTYPE in RFC 2445
.. py:attribute:: INDIVIDUAL
= 1
The attendee is an individual.
.. py:attribute:: GROUP
= 2
The attendee is a group of individuals.
.. py:attribute:: RESOURCE
= 3
The attendee is a physical resource.
.. py:attribute:: ROOM
= 4
The attendee is a room.
.. container:: message-rst-calendar-attendee-usertype-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Attendee.proto
:lines: 27-48
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16,21-21
.. _message-rst-calendar-attendee-role:
Message Role
------------
.. container:: message-rst-calendar-attendee-role-multi
.. container:: message-rst-calendar-attendee-role-documentation
.. py:class:: rst.calendar.Attendee.Role
Used to specify the participation role of an attendee.
This enum represents the possible values of a ROLE in RFC 2445
.. py:attribute:: CHAIR
= 1
Chair of the calendar entity.
.. py:attribute:: REQUIRED_PARTICIPANT
= 2
Someone whose participation is required.
.. py:attribute:: OPTIONAL_PARTICIPANT
= 3
Someone whose participation is optional.
.. py:attribute:: NON_PARTICIPANT
= 4
Someone whose participation is for information purposes only.
.. container:: message-rst-calendar-attendee-role-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Attendee.proto
:lines: 55-76
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16,21-21
.. _message-rst-calendar-attendee-participationstatus:
Message ParticipationStatus
---------------------------
.. container:: message-rst-calendar-attendee-participationstatus-multi
.. container:: message-rst-calendar-attendee-participationstatus-documentation
.. py:class:: rst.calendar.Attendee.ParticipationStatus
Used to specify the participation status of an attendee.
This enum represents the possible values of a PARTSTAT in RFC 2445
.. py:attribute:: NEEDS_ACTION
= 1
The attendee has yet to react.
.. py:attribute:: ACCEPTED
= 2
The attendee has accepted the participation.
.. py:attribute:: DECLINED
= 3
The attendee has declined the participation.
.. container:: message-rst-calendar-attendee-participationstatus-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Attendee.proto
:lines: 83-99
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16
.. _message-rst-calendar-recurrenceid:
Message RecurrenceId
--------------------
.. container:: message-rst-calendar-recurrenceid-multi
.. container:: message-rst-calendar-recurrenceid-documentation
.. py:class:: rst.calendar.RecurrenceId
The recurrence id can be used to reference a single component out of a
recurring component set.
While the UID of a component references its whole recurrence set the
combination of the UID with a RecurrenceId can be used to point to a
specific instance within this set.
This message represents a RECURRENCE-ID property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: type
:type: :py:class:`rst.calendar.RecurrenceId.Type`
Specifies whether the id should be interpreted as a date with time
or as a date, ignoring time.
This field corresponds to the VALUE part of a ridparam property RFC 2445.
.. py:attribute:: range
:type: :py:class:`rst.calendar.RecurrenceId.Range`
Specifies whether a single instance or set is referenced.
This field corresponds to the rangeparam part of a ridparam
property RFC 2445.
.. py:attribute:: rid
:type: :py:class:`rst.calendar.DateTime`
Specifies ReferenceId value as a DateTime this should match the date value
of an instance in the recurrence set.
This field corresponds to the ridval part of a RECURRENCE-ID
property RFC 2445.
.. container:: message-rst-calendar-recurrenceid-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/RecurrenceId.proto
:lines: 24-92
:language: protobuf
:emphasize-lines: 50-50,58-58,67-67
.. _message-rst-calendar-recurrenceid-type:
Message Type
------------
.. container:: message-rst-calendar-recurrenceid-type-multi
.. container:: message-rst-calendar-recurrenceid-type-documentation
.. py:class:: rst.calendar.RecurrenceId.Type
Specifies whether this RecurrenceId uses a date or a date-time.
.. py:attribute:: DATE_TIME
= 1
Specifies a date and time.
.. py:attribute:: DATE
= 2
Specifies a date (whole day).
.. container:: message-rst-calendar-recurrenceid-type-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/RecurrenceId.proto
:lines: 29-40
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-calendar-recurrenceid-range:
Message Range
-------------
.. container:: message-rst-calendar-recurrenceid-range-multi
.. container:: message-rst-calendar-recurrenceid-range-documentation
.. py:class:: rst.calendar.RecurrenceId.Range
Specifies whether this RecurrenceId references a single instance or
the same with all prior or future instances.
This enum corresponds to the RANGE parameter in RFC 2445.
.. py:attribute:: SINGLE
= 1
Specifies a single instance.
.. py:attribute:: THIS_AND_FUTURE
= 2
Specifies an instance and all instances following it.
.. py:attribute:: THIS_AND_PRIOR
= 3
Specifies a instance and all instances prior to it.
.. container:: message-rst-calendar-recurrenceid-range-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/RecurrenceId.proto
:lines: 49-65
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16
.. _message-rst-calendar-timezone:
Message TimeZone
----------------
.. container:: message-rst-calendar-timezone-multi
.. container:: message-rst-calendar-timezone-documentation
.. py:class:: rst.calendar.TimeZone
**Constraint**: ``len(.standards) + len(.daylights) > 0``
A description of a TimeZone following the icalendar definitions.
The TimeZone must at least hold it timezone_id and one standards or daylights
Observance.
This message represents a VTIMEZONE component in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: timezone_id
:type: :py:class:`ASCII-STRING`
The id of the time zone. This should be unique.
This field corresponds to the tzid parameter of VTIMEZONE in RFC 2445.
.. py:attribute:: last_modified_utc
:type: :py:class:`rst.calendar.DateTime`
**Constraint**: ``value.type == DateTime.Type.UTC``
Specifies when the time zone was modified the last time in utc time.
More precisely: Tells when this time zone data was last modified
in the calendar store.
This field corresponds to the last-mod parameter of VTIMEZONE in RFC 2445.
.. py:attribute:: timezone_url
:type: :py:class:`ASCII-STRING`
Specifies a network location where an up to date version of this time zone
can be retrieved.
This field corresponds to the tzurl parameter of VTIMEZONE in RFC 2445.
.. py:attribute:: x_location
:type: :py:class:`ASCII-STRING`
The location to which this time zone applies. This can define where the
TimeZone is applied.
Example: "Europe/Berlin" for the TimeZone that is used in Berlin,
in Germany
This is a field corresponding to X-LIC-LOCATION, which is not in RFC 2445.
.. py:attribute:: standards
:type: array of :py:class:`rst.calendar.Observance`
A collection of standard-observances for this TimeZone. Defines all its
'winter' times.
This field corresponds to the standardc parameter of VTIMEZONE in
RFC 2445.
.. py:attribute:: daylights
:type: array of :py:class:`rst.calendar.Observance`
A collection of daylight-observances for this TimeZone. Defines all its
'summer' times.
This field corresponds to the daylightc parameter of VTIMEZONE in
RFC 2445.
.. container:: message-rst-calendar-timezone-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/TimeZone.proto
:lines: 23-80
:language: protobuf
:emphasize-lines: 8-8,19-19,27-27,38-38,47-47,56-56
.. _message-rst-calendar-observance:
Message Observance
------------------
.. container:: message-rst-calendar-observance-multi
.. container:: message-rst-calendar-observance-documentation
.. py:class:: rst.calendar.Observance
A description of a shift in a time zone following the iCalendar definitions.
Observances are used to describe standard-daylight changes for a time zone.
This message represents a tzprop property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: type
:type: :py:class:`rst.calendar.Observance.Type`
This field tells of which type this observance is STANDARD (winter) or
DAYLIGHT (summer).
.. py:attribute:: start_utc
:type: :py:class:`rst.calendar.DateTime`
Specifies when the Observance begins (since when it is in use) in
utc-time.
This field corresponds to dtstart of a tzprop in RFC 2445.
.. py:attribute:: name
:type: :py:class:`ASCII-STRING`
Specifies the name of the observance.
This field corresponds to tzname of a tzprop in RFC 2445.
.. py:attribute:: recurrence
:type: :py:class:`rst.calendar.Recurrence`
Specifies a set of dates when the observance gets active.
This field corresponds to rdate and rrule of a tzprop in RFC 2445.
The exclude_dates and exclude_rules of this recurrence should be ignored.
.. py:attribute:: offset_from
:type: :py:class:`INT64`
Specifies the time offset in use before the observance is active in
milliseconds.
This field corresponds to tzoffsetfrom of a tzprop in RFC 2445.
.. py:attribute:: offset_to
:type: :py:class:`INT64`
Specifies the time offset in use while observance is active in
milliseconds
This field corresponds to tzoffsetto of a tzprop in RFC 2445.
.. container:: message-rst-calendar-observance-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Observance.proto
:lines: 21-86
:language: protobuf
:emphasize-lines: 24-24,32-32,39-39,48-48,56-56,64-64
.. _message-rst-calendar-observance-type:
Message Type
------------
.. container:: message-rst-calendar-observance-type-multi
.. container:: message-rst-calendar-observance-type-documentation
.. py:class:: rst.calendar.Observance.Type
This enum tells whether the observance describes a daylight (summer)
or standard (winter) time.
.. py:attribute:: STANDARD
= 1
An observance setting the time zone to standard (winter) time.
.. py:attribute:: DAYLIGHT
= 2
An observance setting the time zone to daylight (summer) time.
.. container:: message-rst-calendar-observance-type-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Observance.proto
:lines: 27-38
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-calendar-recurrence:
Message Recurrence
------------------
.. container:: message-rst-calendar-recurrence-multi
.. container:: message-rst-calendar-recurrence-documentation
.. py:class:: rst.calendar.Recurrence
A description of a recurrence following the iCalendar definitions.
can be used to generate a set of dates.
The final set of dates is created by combining all dates from
recurrence_dates and recurrence_rules and removing all dates generated
by exclude_dates and exclude_rules.
This message combines a representation of repeating RDATE, RRULE, EXDATE and
EXRULE properties in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: recurrence_dates
:type: array of :py:class:`rst.calendar.DateTime`
Specifies a set of specific dates to include.
This field represents a set of RDATE in RFC 2445.
.. py:attribute:: recurrence_rules
:type: array of :py:class:`rst.calendar.RecurrenceRule`
Specifies a set of rules that generate dates to include.
This field represents a set of RRULE in RFC 2445.
.. py:attribute:: exclude_dates
:type: array of :py:class:`rst.calendar.DateTime`
Specifies a set of dates to exclude.
This field represents a set of EXDATE in RFC 2445.
.. py:attribute:: exclude_rules
:type: array of :py:class:`rst.calendar.RecurrenceRule`
Specifies a set of rules that generate dates to exclude.
This field represents a set of EXRULE in RFC 2445.
.. container:: message-rst-calendar-recurrence-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Recurrence.proto
:lines: 26-56
:language: protobuf
:emphasize-lines: 8-8,15-15,22-22,29-29
.. _message-rst-calendar-recurrencerule:
Message RecurrenceRule
----------------------
.. container:: message-rst-calendar-recurrencerule-multi
.. container:: message-rst-calendar-recurrencerule-documentation
.. py:class:: rst.calendar.RecurrenceRule
Specifies a rule or repeating pattern for recurring components.
This message represents a RECUR property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: until_date_utc
:type: :py:class:`rst.calendar.DateTime`
Specifies the end date of the recurrence in utc. Either this or count may
be specified but not both at the same time.
This field corresponds to the UNTIL part of a recur value in RFC 2445.
.. py:attribute:: count
:type: :py:class:`UINT32`
Specifies the recurrence count. Either this or until_date_utc may
be specified but not both at the same time.
This field corresponds to the COUNT part of a recur value in RFC 2445.
.. py:attribute:: frequency
:type: :py:class:`rst.calendar.RecurrenceRule.Frequency`
Specifies the frequency of the recurrence.
This field corresponds to the freq part of a recur value in RFC 2445.
.. py:attribute:: interval
:type: :py:class:`UINT32`
Tells how often the rule repeats.
Example: interval = n and frequency = weekly means every n'th week
This field corresponds to the INTERVAL part of a recur value in RFC 2445.
.. py:attribute:: by_second
:type: array of :py:class:`UINT32`
**Constraint**: ``0 <= value < 60``
A list of occurrence seconds.
This field corresponds to the BYSECOND part of a recur value in RFC 2445.
.. py:attribute:: by_minute
:type: array of :py:class:`UINT32`
**Constraint**: ``0 <= value < 60``
A list of occurrence minutes.
This field corresponds to the BYMINUTE part of a recur value in RFC 2445.
.. py:attribute:: by_hour
:type: array of :py:class:`UINT32`
**Constraint**: ``0 <= value < 24``
A list of occurrence hours.
This field corresponds to the BYHOUR part of a recur value in RFC 2445.
.. py:attribute:: by_week_day
:type: array of :py:class:`rst.calendar.RecurrenceRule.Weekday`
A list of occurrence weekdays.
This field corresponds to the BYDAY part of a recur value in RFC 2445.
.. py:attribute:: by_day_number
:type: array of :py:class:`INT32`
A list of occurrence days.
Example: frequency = MONTHLY, by_week_day = MO and by_day_n = -1
means the last Monday of the month.
This field corresponds to the BYDAY part of a recur value in RFC 2445.
.. py:attribute:: by_month_day
:type: array of :py:class:`INT32`
**Constraint**: ``-31 <= value <= 31``
A list of occurrence days of the month. If by_moth_day is negative, it is
counted from the end of the month.
This field corresponds to the BYMONTHDAY part of a recur value in RFC 2445.
.. py:attribute:: by_year_day
:type: array of :py:class:`INT32`
**Constraint**: ``-366 <= value <= 366``
A list of occurrence days of the year. If by_year_day is negative, it is
counted from the end of the year.
This field corresponds to the BYYEARDAY part of a recur value in RFC 2445.
.. py:attribute:: by_week_number
:type: array of :py:class:`INT32`
**Constraint**: ``-53 <= value <= 53``
A list of occurrence weeks of the year. If by_week_number is negative,
it is counted from the end of the year.
This field corresponds to the BYWEEKNO part of a recur value in RFC 2445.
.. py:attribute:: by_month
:type: array of :py:class:`UINT32`
**Constraint**: ``1 <= value <= 31``
A list of occurrence months. If by_month is negative, it is counted
from the end of the year.
This field corresponds to the BYMONTH part of a recur value in RFC 2445.
.. py:attribute:: by_set_pos
:type: array of :py:class:`INT32`
Further filters the set by specifying which exact occurrences to use.
Example: frequency = MONTHLY, by_week_day=FRIDAY and
by_set_pos = -1 specifies the last Friday of the month.
This field corresponds to the BYSETPOS part of a recur value in RFC 2445.
.. py:attribute:: week_start
:type: :py:class:`rst.calendar.RecurrenceRule.Weekday`
Specifies which day is the first day of the week.
This field corresponds to the WKST part of a recur value in RFC 2445.
.. container:: message-rst-calendar-recurrencerule-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/RecurrenceRule.proto
:lines: 19-230
:language: protobuf
:emphasize-lines: 92-92,100-100,107-107,116-116,124-124,132-132,140-140,147-147,157-157,166-166,175-175,184-184,193-193,203-203,210-210
.. _message-rst-calendar-recurrencerule-frequency:
Message Frequency
-----------------
.. container:: message-rst-calendar-recurrencerule-frequency-multi
.. container:: message-rst-calendar-recurrencerule-frequency-documentation
.. py:class:: rst.calendar.RecurrenceRule.Frequency
This enum defines a frequency of the recurrence (How often does it recur).
.. py:attribute:: SECONDLY
= 1
Every second.
.. py:attribute:: MINUTELY
= 2
Every minute.
.. py:attribute:: HOURLY
= 3
Every hour.
.. py:attribute:: DAILY
= 4
Every day.
.. py:attribute:: WEEKLY
= 5
Every week.
.. py:attribute:: MONTHLY
= 6
Every month.
.. py:attribute:: YEARLY
= 7
Every year.
.. container:: message-rst-calendar-recurrencerule-frequency-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/RecurrenceRule.proto
:lines: 24-61
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16,21-21,26-26,31-31,36-36
.. _message-rst-calendar-recurrencerule-weekday:
Message Weekday
---------------
.. container:: message-rst-calendar-recurrencerule-weekday-multi
.. container:: message-rst-calendar-recurrencerule-weekday-documentation
.. py:class:: rst.calendar.RecurrenceRule.Weekday
This enum defines a day in within the week.
.. py:attribute:: SUNDAY
= 1
Sunday
.. py:attribute:: MONDAY
= 2
Monday
.. py:attribute:: TUESDAY
= 3
Tuesday
.. py:attribute:: WEDNESDAY
= 4
Wednesday
.. py:attribute:: THURSDAY
= 5
Thursday
.. py:attribute:: FRIDAY
= 6
Friday
.. py:attribute:: SATURDAY
= 7
Saturday
.. container:: message-rst-calendar-recurrencerule-weekday-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/RecurrenceRule.proto
:lines: 66-102
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16,21-21,26-26,31-31,36-36
.. _message-rst-calendar-datetime:
Message DateTime
----------------
.. container:: message-rst-calendar-datetime-multi
.. container:: message-rst-calendar-datetime-documentation
.. py:class:: rst.calendar.DateTime
A description of date and time of day.
This message represents a DATE-TIME property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: date_time_type
:type: :py:class:`rst.calendar.DateTime.Type`
Specifies whether this time is floating, utc or local.
.. py:attribute:: timezone_id
:type: :py:class:`ASCII-STRING`
Specifies the time zone to which this time is bound.
The value of timezone_id must match the timezone_id of a known or
attached TimeZone definition.
This field MUST be specified when DateTimeType is LOCAL.
In all other cases it has no meaning.
.. py:attribute:: milliseconds_since_epoch
:type: :py:class:`UINT64`
The time since epoch (01.01.1970 at 00:00) in milliseconds.
.. container:: message-rst-calendar-datetime-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/DateTime.proto
:lines: 17-68
:language: protobuf
:emphasize-lines: 34-34,45-45,50-50
.. _message-rst-calendar-datetime-type:
Message Type
------------
.. container:: message-rst-calendar-datetime-type-multi
.. container:: message-rst-calendar-datetime-type-documentation
.. py:class:: rst.calendar.DateTime.Type
A DateTime can have one of the three following forms.
.. py:attribute:: UTC
= 1
UTC that this time is meant to be in absolute Coordinated Universal
Time.
.. py:attribute:: FLOATING
= 2
FLOATING is used to specify time which is not bound to any time zone.
Example: Dinner may always be at 6pm regardless of the current time
zone.
.. py:attribute:: LOCAL
= 3
LOCAL specifies that this time is bound to a specific time zone.
This additionally requires the timezone_id field to be set.
.. container:: message-rst-calendar-datetime-type-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/DateTime.proto
:lines: 22-45
:language: protobuf
:emphasize-lines: 7-7,15-15,22-22
.. _message-rst-calendar-relationship:
Message Relationship
--------------------
.. container:: message-rst-calendar-relationship-multi
.. container:: message-rst-calendar-relationship-documentation
.. py:class:: rst.calendar.Relationship
This is used to specify relationships between calendar components.
This message represents a RELATED-TO property in RFC 2445.
For a documentation of the RFC 2445 iCalendar specification visit
http://www.ietf.org/rfc/rfc2445.txt
.. codeauthor:: Viktor Richter
.. py:attribute:: relationship_type
:type: :py:class:`rst.calendar.Relationship.Type`
The type of relationship to the referenced component.
This field corresponds to the reltypeparam parameter in RFC 2445.
.. py:attribute:: uid
:type: :py:class:`ASCII-STRING`
The unique identifier of the related component. This should
typically be its uid.
This field corresponds to the text part of related property in RFC 2445.
.. container:: message-rst-calendar-relationship-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Relationship.proto
:lines: 17-58
:language: protobuf
:emphasize-lines: 32-32,40-40
.. _message-rst-calendar-relationship-type:
Message Type
------------
.. container:: message-rst-calendar-relationship-type-multi
.. container:: message-rst-calendar-relationship-type-documentation
.. py:class:: rst.calendar.Relationship.Type
Specifies the type of the relationship.
This enum represents the possible values of a reltypeparam in RFC 2445.
.. py:attribute:: PARENT
= 1
The component is a subordinate of the referenced component.
.. py:attribute:: CHILD
= 2
The component is a superior of the referenced component.
.. py:attribute:: SIBLING
= 3
The component is a peer of the referenced component.
.. container:: message-rst-calendar-relationship-type-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-trunk/upstream/RST-0.19.0-Linux/share/rst0.19/proto/stable/rst/calendar/Relationship.proto
:lines: 24-40
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16