diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index 459e972..8a94620 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -2,7 +2,7 @@ name: generate on: push: - branches: [ main ] + branches: [main] pull_request: workflow_dispatch: @@ -12,34 +12,10 @@ permissions: id-token: write concurrency: - group: "pages" + group: pages cancel-in-progress: true jobs: - build: - runs-on: ubuntu-latest - container: - image: metanorma/metanorma:latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Cache Metanorma assets - uses: actions-mn/cache@v1 - - - name: Metanorma generate site - uses: actions-mn/build-and-publish@v2 - with: - agree-to-terms: true - destination: gh-pages - deploy: - if: ${{ github.ref == 'refs/heads/main' }} - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - needs: build - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 \ No newline at end of file + site: + uses: actions-mn/.github/.github/workflows/metanorma-generate.yml@v1 + secrets: inherit diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..a604cf4 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,29 @@ +name: Release + +on: + push: + branches: [main] + paths: ['sources/**', 'metanorma.yml', 'metanorma.release.yml'] + workflow_dispatch: + inputs: + include-pattern: + description: 'Glob pattern to filter documents for release' + required: false + default: '*' + force: + description: 'Force release even if content is unchanged' + required: false + type: boolean + default: false + +permissions: + contents: write + +jobs: + release: + uses: actions-mn/.github/.github/workflows/metanorma-release.yml@v1 + with: + default-visibility: private + include-pattern: ${{ github.event.inputs.include-pattern || '*' }} + force: ${{ github.event.inputs.force || 'false' }} + secrets: inherit diff --git a/.tmp.xml b/.tmp.xml new file mode 100644 index 0000000..b8c71ac --- /dev/null +++ b/.tmp.xml @@ -0,0 +1,5256 @@ + + + + Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component + CC/CD 51005:2018 + 51005 + + 2018-11-19 + + + + + CalConnect + + + + + + + Eric York + + + + + + + + Cyrus Daboo + + + + + + + + Michael Douglass + + + + + + + CalConnect + + + en + + committee-draft + + 2018 + + + CalConnect + + + + + FREEBUSY + + + 1 + 2018-11-19 + +Foreword +

The Calendaring and Scheduling Consortium ("CalConnect") is global +non-profit organization with the aim to facilitate interoperability of +collaborative technologies and tools through open standards.

+

CalConnect works closely with international and regional partners, +of which the full list is available on our website +().

+

The procedures used to develop this document and those intended for its +further maintenance are described in the CalConnect Directives.

+

In particular the different approval criteria needed for the different +types of CalConnect documents should be noted. This document was drafted in +accordance with the editorial rules of the CalConnect Directives.

+

Attention is drawn to the possibility that some of the elements of this +document may be the subject of patent rights. CalConnect shall not be +held responsible for identifying any or all such patent rights. Details +of any patent rights identified during the development of the document +will be provided in the Introduction.

+

Any trade name used in this document is information given for the +convenience of users and does not constitute an endorsement.

+

This document was prepared by Technical Committee +FREEBUSY.

Introduction

The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+ + + Scope +

This document provides a mechanism in iCalendar for consensus scheduling.

+
+ +Terms and definitions + consensus scheduling +

process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task

+
+ + active Vpoll +

VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+voter

participant who votes on the alternatives

+ +

A voter need not be an attendee of any of the alternatives presented.

+
+Simple Consensus Scheduling

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

The usual property.

+
+
ORGANIZER
+
+

The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
SUMMARY
+
+

The usual property. This optional but +recommended property provides the a short title to the poll.

+
+
DESCRIPTION
+
+

The usual property. This optional property +provides more details.

+
+
DTEND
+
+

The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
POLL-MODE
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives.

+
+
POLL-COMPLETION
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice.

+
+
POLL-PROPERTIES
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
VVOTER
+
+

A new component. There is one of these for each voter and +it contains a VOTER property to identify the voter and one VOTE +component for each item being voted on.

+
+
VOTE
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
VOTER
+
+

A new property. There is one of these for each voter and it +is similar to the ATTENDEE property. It identifies the +VVOTER component to show who is taking part in the voting and +their results.

+
+
VEVENT
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD:REQUEST +BEGIN:VPOLL +POLL-MODE:BASIC +POLL-COMPLETION:SERVER-SUBMIT +POLL-PROPERTIES:DTSTART,LOCATION +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T000000Z +SUMMARY:What to do this week +DTEND:20120101T000000Z +BEGIN: VVOTER +VOTER:mailto:cyrus@example.com +END VVOTER +BEGIN: VVOTER +VOTER:mailto:eric@example.com +END VVOTER +BEGIN: VVOTER +VOTER:mailto:mike@example.com +END VVOTER +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+The VPOLL Subcomponents: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL.

+
+
POLL-ITEM-ID
+
+

This provides a unique reference to the sub-component +within the VPOLL. It’s value SHOULD be a small integer.

+
+
+VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

Same as the request.

+
+
ORGANIZER
+
+

Same as the request.

+
+
SUMMARY
+
+

Same as the request.

+
+
VVOTER
+
+

One only.

+
+
VOTER
+
+

One only inside the VVOTER component - the voter replying.

+
+
VOTE
+
+

One per item being voted on. There does not need to be one +for each choice.

+
+
POLL-ITEM-ID
+
+

One inside each VOTE component to identify the choice.

+
+
RESPONSE
+
+

One inside each VOTE component to specify the vote.

+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+

REPLY VPOLL from Cyrus:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SUMMARY:What to do this week +BEGIN:VVOTER +VOTER:mailto:cyrus@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:VVOTER +END:VPOLL +END:VCALENDAR
+VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more VVOTER components each populated with a +VOTER property and zero or more VOTE components.

+ + BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: POLLSTATUS +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T020000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:VVOTER +VOTER:mailto:cyrus@example.com +BEGIN: VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:VVOTER +BEGIN:VVOTER +VOTER:mailto:eric@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:VVOTER +END:VPOLL +END:VCALENDAR +
+VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED".

+

VPOLL confirmation:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REQUEST +BEGIN:VPOLL +ORGANIZER:mailto:douglm@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T030000Z +COMPLETED:20120101T030000Z +POLL-COMPLETION:SERVER-SUBMIT +SEQUENCE:0 +SUMMARY:What to do this week +STATUS:CONFIRMED +POLL-WINNER:3 +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR
+Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+iCalendar ExtensionsUpdated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+reltypeparam /= "RELTYPE" "=" "POLL" +; Property value is a VPOLL uid +
+
Description
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+Updated Status Value

Status property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+statvalue /= statvalue-poll + ; Status values for "VPOLL". +statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" +
+
Description
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
+New Property ParametersRequired
+
Parameter name
+
+

REQUIRED

+
+
Purpose
+
+

To specify whether the associated property is required in +the current context.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE +
+
Description
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+Stay-Informed
+
Parameter name
+
+

STAY-INFORMED

+
+
Purpose
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE +
+
Description
+
+

This parameter MAY be specified on VOTER and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+New PropertiesAccept-Response
+
Property name
+
+

ACCEPT-RESPONSE

+
+
Purpose
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + +acceptresponseparams = *(";" other-param)
+Poll-Completion
+
Property name
+
+

POLL-COMPLETION

+
+
Purpose
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
Description
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

+

in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+
+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
Format Definition
+
+

This property is defined by the following notation:

+
+
+poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + +pcparam = *(";" other-param) + +pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + +

The following is an example of this property:

+
+

+

+POLL-COMPLETION: SERVER-SUBMIT
+Poll-Item-Id
+
Property name
+
+

POLL-ITEM-ID

+
+
Purpose
+
+

This property is used in VPOLL child components as an +identifier.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
Description
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + +pollitemidparams = *( + (";" other-param) + )
+Poll-Mode
+
Property name
+
+

POLL-MODE

+
+
Purpose
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
Description
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + +pollmodeparams = *(";" other-param)
+Poll-properties
+
Property name
+
+

POLL-PROPERTIES

+
+
Purpose
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + +pollpropparams = *(";" other-param)
+Poll-Winner
+
Property name
+
+

POLL-WINNER

+
+
Purpose
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + +pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed
+Reply-URL
+
Property name
+
+

REPLY-URL

+
+
Purpose
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
Property Parameters
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + +reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + )
+Response
+
Property name
+
+

RESPONSE

+
+
Purpose
+
+

To specify a response vote.

+
+
Value type
+
+

INTEGER

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + +responseparams = *(";" other-param) +
+
Description
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 - 39 A "NO vote"

    +
  • +
  • +

    40 - 79 A "MAYBE" vote

    +
  • +
  • +

    80 - 89 A "YES - but not preferred vote"

    +
  • +
  • +

    90-100 A "YES" vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+
+Voter
+
Property name
+
+

VOTER

+
+
Purpose
+
+

This property is used in VVOTER components to indicate +recipients of the poll and to identify that component as +containing the voters responses.

+
+
Value type
+
+

The value type for this property is cal-address.

+
+
Property Parameters
+
+

Non-standard, cutype, member, role, rsvp, +delto, delfrom, sentby, cn, dir, lang or stayinformed parameters +can be specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
Description
+
+

This property appears in the VVOTER component only and +indicates a recipient of the poll and their responses.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+voter = "VOTER" voterparams ":" cal-address CRLF + +voterparam = *( + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + (";" cutypeparam) / (";" memberparam) / + (";" roleparam) / + (";" rsvpparam) / (";" deltoparam) / + (";" delfromparam) / (";" sentbyparam) / + (";" cnparam) / (";" dirparam) / + (";" languageparam) / + (";" stayinformedparam) / + + ; + ; The following are OPTIONAL, but MUST NOT occur + ; more than once. They are defined in RFC6638 + ; + (";" scheduleagentparam) / + (";" scheduleforcesendparam) / + (";" schedulestatusparam) / + + ; + ; The following is OPTIONAL, + ; and MAY occur more than once. + ; + (";" other-param) + ; + ) + +

RSVP=TRUE MAY be used by the organizer to force the voter to + reset their state and re-vote.

+
+ +

scheduleagentparam, scheduleforcesendparam and + schedulestatusparam are all related to CalDAV scheduling and are + defined in . Their semantics are exactly as defined in + that specification.

+
+New ComponentsVPOLL Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *voterc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + +pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) +
+
Description
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The VVOTER components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the VOTER property and their votes through the VOTE components.

+

If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+

TODO: Need some text to describe what relative alarms are relative to.

+VVOTER Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component contains identification of the recipient and +voter and their responses.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+voterc = "BEGIN" ":" "VVOTER" CRLF + voterprop + *votec *iana-comp *x-comp + "END" ":" "VVOTER" CRLF + +voterprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / voter / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + created / description / last-mod / seq / + status / summary / url / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ) +
+
Description
+
+

This component contains a VOTER property identifying a +recipient and voter and zero or more VOTE components containing +their responses.

+

The VOTER property in VVOTER objects refers to a recipient who +will be voting - RSVP=TRUE is used by the organizer to force the +voter to reset their state and re-vote

+
+
+VOTE Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + +voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) +
+
Description
+

This component identifies voters and contains their +responses.

The required and optional properties and their meanings depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.

+
+Poll Modes

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC.

+POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+Property restrictions

This poll mode has the following property requirements:

+
+
POLL-ITEM-ID
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
POLL-WINNER
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+iTIP Extensions

This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one VOTER only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+ +

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and VOTER.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+ + + + + + + + + + + + + + + + + +
OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+ + Delegation +

TBD

+
+ + Acting on Behalf of Other Calendar Users +

TBD

+
+ + Component Revisions +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter - no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component - bump sequence

    +
  • +
+
+ + Message Sequencing +

TBD

+
+Application Protocol ElementsMethods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the "VPOLL" +calendar component.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and VOTER.

+
+Method: PUBLISH

The "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ + Constraints for a METHOD:PUBLISH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0 or 1

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VOTER

+
+

0

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component. If voting has already taken place, these components MUST include the VOTER property to indicate each voters current response.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component. If voting has already taken place, these components MUST include the VOTER property to indicate each voters current response.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component. If voting has already taken place, these components MUST include the VOTER property to indicate each voters current response.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+Method: REQUEST

The "REQUEST" method in a "VPOLL" component provides the following +scheduling functions:

+
    +
  • +

    Invite "Voters" to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a "REFRESH" request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of "Voters".

    +
  • +
  • +

    Forward a "VPOLL" to another uninvited CU.

    +
  • +
  • +

    For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU.

    +
  • +
  • +

    For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU.

    +
  • +
+

The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer".

+

The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient’s calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient’s calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component.

+

For the "REQUEST" method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ + Constraints for a METHOD:REQUEST of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+
+

VOTER

+
+

1+

+
+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0+

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component. If voting has already taken place, these components MUST include the VOTER property to indicate each voters current response.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component. If voting has already taken place, these components MUST include the VOTER property to indicate each voters current response.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component. If voting has already taken place, these components MUST include the VOTER property to indicate each voters current response.

+
+ + Rescheduling a poll +

The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll.

+
+Updating or Reconfirmation of a Poll

The "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll.

+

The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.

+ + Confirmation of a Poll +

The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+ + Closing a Poll +

The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+Delegating a Poll to Another CU

Some calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU.

+

The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator’s" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above.

+

In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY"

+

method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator’s" calendar address.

+

The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".

+ + Changing the Organizer +

The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer".

+
+ + Sending on Behalf of the Organizer +

There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer".

+
+Forwarding to an Uninvited CU

A "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU.

+

The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll.

+

If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added.

+

When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.

+ + Updating Voter Status +

The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "VOTER;RSVP=TRUE" property parameter. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST".

+
+Method: REPLY

The "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator’s" "Voter" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate’s" "Voter" property.

+

The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed.

+

The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter".

+

A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value.

+

The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter.

+

The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ + Constraints for a METHOD:REPLY of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+ + +

UID.

+
+

VOTER

+
+

1

+
+

MUST be the address of the Voter

+
+ + +

replying.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+ + +

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+
+

VTODO

+
+

0

+
+
+Method: CANCEL

The "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll.

+

The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each.

+

When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in .

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ + Constraints for a METHOD:CANCEL of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

VOTER

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

1

+
+
+

ATTACH

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: REFRESH

The "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ + Constraints for a METHOD:REFRESH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+
+

VOTER

+
+

1

+
+

MUST be the address of requester.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0

+
+
+

DESCRIPTION

+
+

0

+
+
+

DTEND

+
+

0

+
+
+

DTSTART

+
+

0

+
+
+

DURATION

+
+

0

+
+
+

GEO

+
+

0

+
+
+

LAST-MODIFIED

+
+

0

+
+
+

LOCATION

+
+

0

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0

+
+
+

RELATED-TO

+
+

0

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0

+
+
+

SEQUENCE

+
+

0

+
+
+

STATUS

+
+

0

+
+
+

SUMMARY

+
+

0

+
+
+

URL

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: POLLSTATUS

The "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. "Voters" MUST NOT be present. The selected component(s) +according to the poll mode MUST also be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ + Constraints for a METHOD:POLLSTATUS of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

VOTER

+
+

1+

+
+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

All candidate components MUST be present but in a reduced form sufficient to provide the voting status.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

All candidate components MUST be present but in a reduced form sufficient to provide the voting status.

+
+

VTODO

+
+

0+

+
+

All candidate components MUST be present but in a reduced form sufficient to provide the voting status.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+CalDAV Extensions

This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends as it a VPOLL component is a +schedulable entity.

+Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+CALDAV:supported-vpoll-component-sets
+
Name
+
+

supported-vpoll-component-sets

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
Definition
+
+
+<!ELEMENT supported-vpoll-component-sets + (supported-vpoll-component-set*) > + +<!ELEMENT supported-vpoll-component-set (comp+)> +<C:supported-vpoll-component-sets + xmlns:C="urn:ietf:params:xml:ns:caldav"> + + <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT or VFREEBUSY --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> +</C:supported-vpoll-component-sets>
+CALDAV:vpoll-max-items
+
Name
+
+

vpoll-max-items

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-items (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) +<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-items>
+CALDAV:vpoll-max-active
+
Name
+
+

vpoll-max-active

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-active (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) +<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-active>
+CALDAV:vpoll-max-voters
+
Name
+
+

+ vpoll-max-voters +

+
+
Namespace
+
+

+ urn:ietf:params:xml:ns:caldav +

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of VOTER +properties for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more VOTER properties per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-voters (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) +<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-voters>
+ + CalDAV:even-more-properties +

TODO: vpoll-supported-mode poll options - e.g "vpoll-basic"

+
+Extensions to CalDAV scheduling

This specification extends .

+

Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +VOTER property. That is, for scheduling purposes the VOTER property +is handled in exactly the same manner as the ATTENDEE property.

+Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+
+
(CALDAV:supported-vpoll-component-sets)
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
(CALDAV:vpoll-max-items)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored;

+
+
(CALDAV:vpoll-max-active)
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored;

+
+
(CALDAV:vpoll-max-voters)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of VOTER properties less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored;

+
+
+CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+>> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<C:calendar-query xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:prop> + <D:getetag/> + <C:calendar-data> + <C:comp name="VCALENDAR"> + <C:prop name="VERSION"/> + <C:comp name="VPOLL"> + <C:prop name="SUMMARY"/> + <C:prop name="UID"/> + <C:prop name="DTSTART"/> + <C:prop name="DTEND"/> + <C:prop name="DURATION"/> + </C:comp> + + </C:comp> + </C:calendar-data> + </D:prop> + <C:filter> + <C:comp-filter name="VCALENDAR"> + <C:comp-filter name="VPOLL"> + <C:time-range start="20121204T000000Z" + end="20121205T000000Z"/> + </C:comp-filter> + </C:comp-filter> + </C:filter> +</C:calendar-query> + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<D:multistatus xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd2"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd3"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> +</D:multistatus>
+CalDAV time ranges

"CALDAV:time-range XML Element" in 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

++-------------------------------------------------------------------+ +| VPOLL has the DTSTART property? | +| +---------------------------------------------------------------+ +| | VPOLL has the DURATION property? | +| | +-----------------------------------------------------------+ +| | | VPOLL has the DTEND property? | +| | | +-------------------------------------------------------+ +| | | | VPOLL has the COMPLETED property? | +| | | | +---------------------------------------------------+ +| | | | | VPOLL has the CREATED property? | +| | | | | +-----------------------------------------------+ +| | | | | | Condition to evaluate | ++---+---+---+---+---+-----------------------------------------------+ +| Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | +| | | | | | ((end > DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+
+ + Security Considerations +

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs.

+
+IANA ConsiderationsParameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in 8.2.4:

+ + + + + + + + + + + + + + + + + + + + +
Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+ +

+
+

STAY-INFORMED

+
+

Current

+
+

+ +

+
+Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in 8.2.3:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+ +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+ +

+
+

POLL-MODE

+
+

Current

+
+

+ +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+ +

+
+

POLL-WINNER

+
+

Current

+
+

+ +

+
+

RESPONSE

+
+

Current

+
+

+ +

+
+

VOTER

+
+

Current

+
+

+ +

+
+POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+
+
Poll mode name
+
+

The name of the poll mode.

+
+
Purpose
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
Reference
+
+

A reference to the RFC in which the poll mode is defined

+
+
+POLL-MODE Registrations

This document defines the following registered poll modes.

+ + + + + + + + + + + + + + + +
Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+ + +
Open issues

Notifications: Need to do a section on what Notifications to + support. + A. VPOLL is about to end and you haven’t voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - VOTER + has indicated now unable to attend - want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a VOTER vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user’s isn’t the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can’t create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event.

+

Need to write down what isn’t valid in a VPOLL + a. Can’t change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:douglm@mysite.edu +VOTER:mailto:eric@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:VFREEBUSY +....... +END:VFREEBUSY +END:VPOLL +END:VCALENDAR
Change log

V03: 2014-10-28 MD

+ +

V03: 2014-05-12 MD

+ +

V02: 2014-05-12 MD

+ +

V01: 2013-08-07 MD

+ +

Initial version: 2012-11-02 MD

Normative References + + 2018-12-10 + HTTP Extensions for Distributed Authoring — WEBDAV + https://www.rfc-editor.org/info/rfc2518 + RFC 2518 + 10.17487/RFC2518 + + 1999 + + + + + + Y. Goland + + + + IETF + IETF + + + + + + + + + E. Whitehead + + + + IETF + IETF + + + + + + + + + A. Faizi + + + + IETF + IETF + + + + + + + + + S. Carter + + + + IETF + IETF + + + + + + + + + D. Jensen + + + + IETF + IETF + + + + + en + + RFC + 2518 + + + + + 2018-12-10 + Uniform Resource Identifier (URI): Generic Syntax + https://www.rfc-editor.org/info/rfc3986 + RFC 3986 + 10.17487/RFC3986 + + 2005 + + + + + + T. Berners-Lee + + + + IETF + IETF + + + + + + + + + R. Fielding + + + + IETF + IETF + + + + + + + + + L. Masinter + + + + IETF + IETF + + + + + en + + STD + 66 + + + RFC + 3986 + + + + + 2018-12-10 + Calendaring Extensions to WebDAV (CalDAV) + https://www.rfc-editor.org/info/rfc4791 + RFC 4791 + 10.17487/RFC4791 + + 2007 + + + + + + C. Daboo + + + + IETF + IETF + + + + + + + + + B. Desruisseaux + + + + IETF + IETF + + + + + + + + + L. Dusseault + + + + IETF + IETF + + + + + en + + RFC + 4791 + + + + + 2018-12-10 + Internet Calendaring and Scheduling Core Object Specification (iCalendar) + https://www.rfc-editor.org/info/rfc5545 + RFC 5545 + 10.17487/RFC5545 + + 2009 + + + + + + B. Desruisseaux + + + + IETF + IETF + + + + + en + + RFC + 5545 + + + + + 2018-12-10 + iCalendar Transport-Independent Interoperability Protocol (iTIP) + https://www.rfc-editor.org/info/rfc5546 + RFC 5546 + 10.17487/RFC5546 + + 2009 + + + + + + C. Daboo + + + + IETF + IETF + + + + + en + + RFC + 5546 + + + + + 2018-12-10 + iCalendar Message-Based Interoperability Protocol (iMIP) + https://www.rfc-editor.org/info/rfc6047 + RFC 6047 + 10.17487/RFC6047 + + 2010 + + + + + + A. Melnikov + + + + IETF + IETF + + + + + en + + RFC + 6047 + + + + + 2018-12-10 + Scheduling Extensions to CalDAV + https://www.rfc-editor.org/info/rfc6638 + RFC 6638 + 10.17487/RFC6638 + + 2012 + + + + + + C. Daboo + + + + IETF + IETF + + + + + + + + + B. Desruisseaux + + + + IETF + IETF + + + + + en + + RFC + 6638 + + + Bibliography + +
diff --git a/deploy_key.pub b/deploy_key.pub new file mode 100644 index 0000000..a944093 --- /dev/null +++ b/deploy_key.pub @@ -0,0 +1 @@ +ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC2HA3U4Bxd5FNTgI6cxmPCqtlAlbL62ibInqtm6j6/lyem8PAuCA3zsC2jXZCqs0eNrY2bpNK4WMFneDcJEvJuKpiODmKvh+mIDCvQ87hDQxzCXO7HiQTVKFgi9acvVL5o10he51PFh49ab69hXH4hikhlG/T2j5I8IQqFAPpM8Hh2LCupbQDHl3VWQB/oe7/stBkq3/zKj8Klyy/82cNjpk3h27X/JzB3BrwIoIjO+do5muWEKvkHkjlESXS57jYaG4U7xUf5yVUtU6V2J1RxGVkq36uCQsqnG7cpg1XouvzfkA4d+pQypXxtwQJ/FpeoYYTMdo2dCYb3OAqkKAYH ci@metanorma.org diff --git a/documents.html b/documents.html new file mode 100644 index 0000000..4938fce --- /dev/null +++ b/documents.html @@ -0,0 +1,1268 @@ + + + + Calendaring and scheduling -- Consensus scheduling -- iCalendar VPOLL component + + + + + + + + + +
+
+
CalConnect
+
+
+
+
+
+
Calendaring and scheduling -- Consensus scheduling -- iCalendar VPOLL component
+
+
+
+
+
+
+
+
+

+ + CC/CD 51006:2018 + +

+
+ +
+
+ standard +
+
+
+ + + +
+
+ + + committee-draft + +
+
+ +
+ + 2018-11-19 +
+
+
+ +
+ +
+ +
+ + +
+ HTML +
+ + +
+ PDF +
+ + +
+ Word +
+ + +
+ XML +
+ +
+
+ + +
+
+ standard +
+
+
+ + + +
+
+ + + standard + +
+
+ +
+ + 2019-11-05 +
+
+
+ +
+ +
+ +
+ +
+ URI +
+ + +
+ HTML +
+ + + + +
+ XML +
+ +
+
+
+

+ + draft-york-vpoll-05 + +

+
+ +
+
+ standard +
+
+
+ + + +
+
+ + + standard + +
+
+ +
+ + 2019-05-15 +
+
+
+ +
+ +
+ +
+ +
+ URI +
+ + +
+ HTML +
+ + + + +
+ XML +
+ +
+
+
+ + + + diff --git a/documents.rxl b/documents.rxl new file mode 100644 index 0000000..3557010 --- /dev/null +++ b/documents.rxl @@ -0,0 +1,215 @@ +Calendaring and scheduling -- Consensus scheduling -- iCalendar VPOLL componentCalConnect + Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component + documents/cc-51006.xml + documents/cc-51006.pdf + documents/cc-51006.doc + documents/cc-51006.html + documents/cc-51006.rxl + CC/CD 51006:2018 + 51006 + + 2018-11-19 + + + + + CalConnect + + + + + + + Eric York + + + + + + + + Cyrus Daboo + + + + + + + + Michael Douglass + + + + + + + CalConnect + + + 1 + + 2018-11-19 + + en + + + committee-draft + + + 2018 + + + CalConnect + + + + + standard + + FREEBUSY + + + + + VPOLL: Consensus Scheduling Component for iCalendar + VPOLL + www.linkedin.com/in/eryork + documents/draft-ietf-calext-vpoll.xml + documents/draft-ietf-calext-vpoll.html + documents/draft-ietf-calext-vpoll.rxl + documents/draft-ietf-calext-vpoll.txt + draft-ietf-calext-vpoll-00 + draft-ietf-calext-vpoll-00 + + + + + Eric York + + eric.york@gmail.com + + + + + + + Cyrus Daboo + + cyrus@daboo.name + + + + + + + Michael Douglass + + mikeadouglass@gmail.com + + + + + + Internet Engineering Task Force + IETF + + + + 2019-11-05 + + en + + + standard + + + 2020 + + + Internet Engineering Task Force + IETF + + + + + IETF + + + standard + + + internet-draft + + + + VPOLL: Consensus Scheduling Component for iCalendar + VPOLL + https://www.apple.com + documents/draft-york-vpoll.xml + documents/draft-york-vpoll.html + documents/draft-york-vpoll.rxl + documents/draft-york-vpoll.txt + draft-york-vpoll-05 + draft-york-vpoll-05 + + + + + Eric York + + eyork@apple.com + + + + + + + Cyrus Daboo + + cyrus@daboo.name + + + + + + + Michael Douglass + + mikeadouglass@gmail.com + + + + + + Internet Engineering Task Force + IETF + + + + 2019-05-15 + + en + + + standard + + + 2020 + + + Internet Engineering Task Force + IETF + + + + + IETF + + + standard + + + internet-draft + + + diff --git a/documents/cc-51006.doc b/documents/cc-51006.doc new file mode 100644 index 0000000..8a385c3 --- /dev/null +++ b/documents/cc-51006.doc @@ -0,0 +1,5720 @@ +MIME-Version: 1.0 +Content-Type: multipart/related; boundary="----=_NextPart_81178210.676e.4040" + +------=_NextPart_81178210.676e.4040 +Content-Location: file:///C:/Doc/cc-51006.htm +Content-Type: text/html; charset="utf-8" + + + + + + + + + + + + +

+ + CC/CD 51006:2018 + + + +

+ + +

+ +

+ CalConnect  + + FREEBUSY + +

+ +

+ Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component + +
+ +

+ + + + + + +

+ +Eric York,Cyrus Daboo,Michael Douglass: Author + +

+ + +

+ +

 

+ +

+ +
+ +

Committee Draft Standard

+ + +
+ +

+ +

 

+ +

+ + +
+ +
+

Warning for Drafts

+ +

This document is not a CalConnect Standard. It is distributed for review and + comment, and is subject to change without notice and may not be referred to as + a Standard. Recipients of this draft are invited to submit, with their + comments, notification of any relevant patent rights of which they are aware + and to provide supporting documentation. +

+
+
+ +
+ + +
+ +
+ + + + + +

 

+
+

+
+

+
+ +

+ Contents +

+ +

 TOC + \o "1-2" \h \z \u + +Warning for Drafts +. + + + PAGEREF _Toc152491099 \h + 1 +

+ +

+ + +Foreword +. + + + PAGEREF _Toc462273049 \h + 1 + + +

+ +

+ + +Introduction +. + + + PAGEREF _Toc446024011 \h + 1 + + +

+ +

+ + +1. Scope +. + + + PAGEREF _Toc966012744 \h + 1 + + +

+ +

+ + +2. Normative references +. + + + PAGEREF _Toc557134655 \h + 1 + + +

+ +

+ + +3. Terms and definitions +. + + + PAGEREF _Toc589175531 \h + 1 + + +

+ +

+ + +4. Simple Consensus Scheduling +. + + + PAGEREF _Toc407218810 \h + 1 + + +

+ +

+ + +4.1. The VPOLL Component: An Overview +. + + + PAGEREF _Toc096181560 \h + 1 + + +

+ +

+ + +4.2. The VPOLL Alternative Choices: An Overview +. + + + PAGEREF _Toc882873898 \h + 1 + + +

+ +

+ + +4.3. VPOLL responses +. + + + PAGEREF _Toc347627947 \h + 1 + + +

+ +

+ + +4.4. VPOLL updates +. + + + PAGEREF _Toc851488776 \h + 1 + + +

+ +

+ + +4.5. VPOLL Completion +. + + + PAGEREF _Toc613248817 \h + 1 + + +

+ +

+ + +4.6. Other Responses +. + + + PAGEREF _Toc689712291 \h + 1 + + +

+ +

+ + +5. iCalendar Extensions +. + + + PAGEREF _Toc603627010 \h + 1 + + +

+ +

+ + +5.1. Updated Participant Type Value +. + + + PAGEREF _Toc003831251 \h + 1 + + +

+ +

+ + +5.2. Updated Relation Type Value +. + + + PAGEREF _Toc765199081 \h + 1 + + +

+ +

+ + +5.3. Updated Status Value +. + + + PAGEREF _Toc230787947 \h + 1 + + +

+ +

+ + +5.4. New Property Parameters +. + + + PAGEREF _Toc032504140 \h + 1 + + +

+ +

+ + +5.5. New Properties +. + + + PAGEREF _Toc002502442 \h + 1 + + +

+ +

+ + +5.6. New Components +. + + + PAGEREF _Toc365823424 \h + 1 + + +

+ +

+ + +6. Poll Modes +. + + + PAGEREF _Toc231716705 \h + 1 + + +

+ +

+ + +6.1. POLL-MODE:BASIC +. + + + PAGEREF _Toc111004680 \h + 1 + + +

+ +

+ + +7. iTIP Extensions +. + + + PAGEREF _Toc454076725 \h + 1 + + +

+ +

+ + +7.1. Methods +. + + + PAGEREF _Toc383225496 \h + 1 + + +

+ +

+ + +7.2. Interoperability Models +. + + + PAGEREF _Toc106318282 \h + 1 + + +

+ +

+ + +7.3. Application Protocol Elements +. + + + PAGEREF _Toc383432178 \h + 1 + + +

+ +

+ + +8. CalDAV Extensions +. + + + PAGEREF _Toc213667439 \h + 1 + + +

+ +

+ + +8.1. Calendar Collection Properties +. + + + PAGEREF _Toc137150676 \h + 1 + + +

+ +

+ + +8.2. Additional Preconditions for PUT, COPY, and MOVE +. + + + PAGEREF _Toc714041037 \h + 1 + + +

+ +

+ + +8.3. CalDAV:calendar-query Report +. + + + PAGEREF _Toc491246963 \h + 1 + + +

+ +

+ + +8.4. CalDAV time ranges +. + + + PAGEREF _Toc260366626 \h + 1 + + +

+ +

+ + +9. Security Considerations +. + + + PAGEREF _Toc908835294 \h + 1 + + +

+ +

+ + +10. IANA Considerations +. + + + PAGEREF _Toc778860954 \h + 1 + + +

+ +

+ + +10.1. Parameter Registrations +. + + + PAGEREF _Toc457802717 \h + 1 + + +

+ +

+ + +10.2. Property Registrations +. + + + PAGEREF _Toc293240268 \h + 1 + + +

+ +

+ + +10.3. POLL-MODE Registration Template +. + + + PAGEREF _Toc567158213 \h + 1 + + +

+ +

+ + +10.4. POLL-MODE Registrations +. + + + PAGEREF _Toc138095927 \h + 1 + + +

+ +

+ + +Appendix A (informative) Open issues +. + + + PAGEREF _Toc651661189 \h + 1 + + +

+ +

+ + +Appendix B (informative) Change log +. + + + PAGEREF _Toc743832500 \h + 1 + + +

+ +

+ + +Bibliography +. + + + PAGEREF _Toc094736531 \h + 1 + + +

+ +

+ + + + +

 

+ +

+ + +
+ + + + + + + + + +
+

+
+

+
+

Foreword

+

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+

The Calendaring and Scheduling Consortium (“CalConnect”) is a global +non-profit organization with the aim to facilitate interoperability of +collaborative technologies and tools through open standards.

+

CalConnect works closely with international and regional partners, +of which the full list is available on our website +(https://www.calconnect.org/about/liaisons-and-relationships).

+

The procedures used to develop this document and those intended for its +further maintenance are described in the CalConnect Directives.

+

In particular the different approval criteria needed for the different +types of CalConnect documents should be noted. This document was drafted in +accordance with the editorial rules of the CalConnect Directives.

+

Attention is drawn to the possibility that some of the elements of this +document may be the subject of patent rights. CalConnect shall not be +held responsible for identifying any or all such patent rights. Details +of any patent rights identified during the development of the document +will be provided in the Introduction.

+

Any trade name used in this document is information given for the +convenience of users and does not constitute an endorsement.

+

This document was prepared by Technical Committee +FREEBUSY.

+
+

+
+

+
+

Introduction

+

The currently existing approach to agreeing on meeting times using +iTip RFC 5546 and/or iMip RFC 6047 has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement — up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+
+

 

+
+

+
+

+
+

Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component

+
+

1.  Scope

+

This document provides a mechanism in iCalendar for consensus scheduling.

+
+

2.  Normative references

The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

IETF RFC 2518, HTTP Extensions for Distributed Authoring — WEBDAV

IETF RFC 3986, Uniform Resource Identifier (URI): Generic Syntax

IETF RFC 4791, Calendaring Extensions to WebDAV (CalDAV)

IETF RFC 5545, Internet Calendaring and Scheduling Core Object Specification (iCalendar)

IETF RFC 5546, iCalendar Transport-Independent Interoperability Protocol (iTIP)

IETF RFC 6047, iCalendar Message-Based Interoperability Protocol (iMIP)

IETF RFC 6638, Scheduling Extensions to CalDAV

IETF I-D.ietf-calext-eventpub-extensions, Event Publishing Extensions to iCalendar

+

3.  Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

3.1. 

consensus scheduling

+ +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+

3.2. 

active Vpoll

+ +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+

3.3. 

voter

+ +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+
+

4.  Simple Consensus Scheduling

+

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+

4.1.  The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+

DTSTAMP

+

The usual RFC 5545 property.

+

SEQUENCE

+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+

UID

+

The usual RFC 5545 property.

+

ORGANIZER

+

The usual RFC 5545 property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+

SUMMARY

+

The usual RFC 5545 property. This optional but +recommended property provides the a short title to the poll.

+

DESCRIPTION

+

The usual RFC 5545 property. This optional property +provides more details.

+

DTEND

+

The usual RFC 5545 property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+

POLL-MODE

+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value “BASIC” +meaning one event will be chosen from the alternatives.

+

POLL-COMPLETION

+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is “SERVER-SUBMIT” which means the client chooses the winner +but the server will submit the winning choice.

+

POLL-PROPERTIES

+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value “DTSTART, LOCATION” meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+

PARTICIPANT

+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to “VOTER”. The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+

VOTE

+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+

VEVENT

+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+

EXAMPLE

VPOLL with 3 voters and 3 alternative meetings:

+

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD:REQUEST
BEGIN:VPOLL
POLL-MODE:BASIC
POLL-COMPLETION:SERVER-SUBMIT
POLL-PROPERTIES:DTSTART,LOCATION
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T000000Z
SUMMARY:What to do this week
DTEND:20120101T000000Z
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
END PARTICIPANT
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
END PARTICIPANT
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:mike@example.com
END PARTICIPANT
BEGIN:VEVENT.......(with a poll-item-id=1)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=2)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=3)
END:VEVENT
END:VPOLL
END:VCALENDAR

+
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+

4.2.  The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard RFC 5545 components. For our +simple use case they are all VEVENT components. In addition to the +usual RFC 5545 properties some extra properties are used for a +VPOLL.

+

POLL-ITEM-ID

+

This provides a unique reference to the sub-component +within the VPOLL. It’s value SHOULD be a small integer.

+
+

4.3.  VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+

DTSTAMP

+

The usual RFC 5545 property.

+

SEQUENCE

+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+

UID

+

Same as the request.

+

ORGANIZER

+

Same as the request.

+

SUMMARY

+

Same as the request.

+

PARTICIPANT

+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+

VOTE

+

One per item being voted on.

+

POLL-ITEM-ID

+

One inside each VOTE component to identify the choice.

+

RESPONSE

+

One inside each VOTE component to specify the vote.

+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+

NOTE

+

This is poll-mode specific behavior?

+
+

EXAMPLE

REPLY VPOLL from Cyrus:

+

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: REPLY
BEGIN:VPOLL
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T010000Z
SUMMARY:What to do this week
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
BEGIN:VOTE
POLL-ITEM-ID:1
RESPONSE:50
COMMENT:Work on iTIP
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
COMMENT:Work on WebDAV
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
END:VPOLL
END:VCALENDAR

+
+

4.4.  VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+

EXAMPLE

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: POLLSTATUS
BEGIN:VPOLL
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T020000Z
SEQUENCE:0
SUMMARY:What to do this week
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
BEGIN: VOTE
POLL-ITEM-ID:1
RESPONSE:50
COMMENT:Work on iTIP
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
COMMENT:Work on WebDAV
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
BEGIN:VOTE
POLL-ITEM-ID:1
RESPONSE:100
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
END:VPOLL
END:VCALENDAR

+
+

4.5.  VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +“SUBMITTED”.

+

EXAMPLE

VPOLL confirmation:

+

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: REQUEST
BEGIN:VPOLL
ORGANIZER:mailto:douglm@example.com
UID:sched01-1234567890
DTSTAMP:20120101T030000Z
COMPLETED:20120101T030000Z
POLL-COMPLETION:SERVER-SUBMIT
SEQUENCE:0
SUMMARY:What to do this week
STATUS:CONFIRMED
POLL-WINNER:3
BEGIN:VEVENT.......(with a poll-item-id=1)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=2)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=3)
END:VEVENT
END:VPOLL
END:VCALENDAR

+
+

4.6.  Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+
+
+

5.  iCalendar Extensions

+

5.1.  Updated Participant Type Value

Participant type property values are defined in section 11.2.1. of +I-D.ietf-calext-eventpub-extensions. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+

partvalue       /= "VOTER"

Figure 1

+ +

Description

+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+

5.2.  Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +RFC 5545. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+

reltypeparam       /= "RELTYPE" "=" "POLL"
; Property value is a VPOLL uid

Figure 2

+ +

Description

+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+

5.3.  Updated Status Value

Status property values are defined in section 3.8.1.11. of RFC 5545. +This specification updates that type to define valid VPOLL status +values.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+

statvalue /= statvalue-poll
   ; Status values for "VPOLL".
statvalue-poll = "IN-PROCESS"
          / "COMPLETED"  ; Poll has closed,
                         ; nothing has been chosen yet
          / "CONFIRMED"  ; Poll has closed and
                         ; winning items confirmed
          / "SUBMITTED"  ; The winning item has been
                         ; submitted
          / "CANCELLED"

Figure 3

+ +

Description

+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+

Figure 4

+
+

5.4.  New Property Parameters

5.4.1.  Required

Parameter name

+

REQUIRED

+

Purpose

+

To specify whether the associated property is required in +the current context.

+

Format Definition

+

This parameter is defined by the following notation:

+
+

requirededparam = "REQUIRED"  "=" ("TRUE" / "FALSE")
  ; Default is FALSE

Figure 5

+ +

Description

+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+

5.4.2.  Stay-Informed

Parameter name

+

STAY-INFORMED

+

Purpose

+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+

Format Definition

+

This parameter is defined by the following notation:

+
+

stayinformedparam = "STAY-INFORMED"  "=" ("TRUE" / "FALSE")
                  ; Default is FALSE

Figure 6

+ +

Description

+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+

5.5.  New Properties

5.5.1.  Accept-Response

Property name

+

ACCEPT-RESPONSE

+

Purpose

+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+

Format Definition

+

This property is defined by the following notation:

+
+

acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":"
                    iana-token ("," iana-token) CRLF

acceptresponseparams = *(";" other-param)

Figure 7

+
+

5.5.2.  Poll-Completion

Property name

+

POLL-COMPLETION

+

Purpose

+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+

Description

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

Format Definition

+

This property is defined by the following notation:

+
+

poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF

pcparam = *(";" other-param)

pcvalue = "SERVER"  ; The server is responsible for both choosing and
                   ; submitting the winner(s)
        / "SERVER-SUBMIT" ; The server is responsible for
                   ; submitting the winner(s). The client chooses.
        / "SERVER-CHOICE"  ; The server is responsible for
                   ; choosing the winner(s). The client will submit.
        / "CLIENT" ; The client is responsible for both choosing and
                   ; submitting the winner(s)
        / iana-token
        / x-name
        ;Default is CLIENT

Figure 8

+ +

Example

+

The following is an example of this property:

+
+

POLL-COMPLETION: SERVER-SUBMIT

Figure 9

+
+

5.5.3.  Poll-Item-Id

Property name

+

POLL-ITEM-ID

+

Purpose

+

This property is used in VPOLL child components as an +identifier.

+

Value type

+

INTEGER

+

Property Parameters

+

Non-standard parameters can be specified on +this property.

+

Conformance

+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+

Description

+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+

Format Definition

+

This property is defined by the following notation:

+
+

pollitemid = "POLL-ITEM-ID" pollitemdparams ":"
                  integer CRLF

pollitemidparams = *(
                   (";" other-param)
            )

Figure 10

+
+

5.5.4.  Poll-Mode

Property name

+

POLL-MODE

+

Purpose

+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component or +its sub-components.

+

Description

+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+

Format Definition

+

This property is defined by the following notation:

+
+

pollmode = "POLL-MODE" pollmodeparams ":"
             ("BASIC" / iana-token / other-token) CRLF

pollmodeparams = *(";" other-param)

Figure 11

+
+

5.5.5.  Poll-properties

Property name

+

POLL-PROPERTIES

+

Purpose

+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+

Format Definition

+

This property is defined by the following notation:

+
+

pollproperties = "POLL-PROPERTIES" pollpropparams ":"
             text *("," text) CRLF

pollpropparams = *(";" other-param)

Figure 12

+
+

5.5.6.  Poll-Winner

Property name

+

POLL-WINNER

+

Purpose

+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+

Value type

+

INTEGER

+

Property Parameters

+

Non-standard parameters can be specified on +this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+

Format Definition

+

This property is defined by the following notation:

+
+

pollwinner = "POLL-WINNER" pollwinnerparams ":"
                 integer CRLF

pollwinnerparams = *(";" other-param)

       ; Used with a STATUS:CONFIRMED VPOLL to indicate which
       ; components have been confirmed

Figure 13

+
+

5.5.7.  Reply-URL

Property name

+

REPLY-URL

+

Purpose

+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+

Property Parameters

+

Non-standard, required or iana parameters can +be specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+

Format Definition

+

This property is defined by the following notation:

+
+

reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF

reply-urlparams = *(
                  (";" requiredparam) /
                  (";" other-param)
                  )

Figure 14

+
+

5.5.8.  Response

Property name

+

RESPONSE

+

Purpose

+

To specify a response vote.

+

Value type

+

INTEGER

+

Format Definition

+

This property is defined by the following notation:

+
+

response = "RESPONSE" response-params ":" integer CRLF
                 ; integer value 0..100

responseparams = *(";" other-param)

Figure 15

+ +

Description

+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+ +

+0 — 39 A “NO vote” +

+

+40 — 79 A “MAYBE” vote +

+

+80 — 89 A “YES — but not preferred vote” +

+

+90-100 A “YES” vote. +

Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

+

+ +
+

5.6.  New Components

5.6.1.  VPOLL Component

Component name

+

VPOLL

+

Purpose

+

This component provides a mechanism by which voters can +vote on provided choices.

+

Format Definition

+

This property is defined by the following notation:

+
+

pollc    = "BEGIN" ":" "VPOLL" CRLF
            pollprop
            *participantc *eventc *todoc *journalc *freebusyc
            *availabilityc *alarmc *iana-comp *x-comp
            "END" ":" "VPOLL" CRLF

pollprop = *(
          ;
          ; The following are REQUIRED,
          ; but MUST NOT occur more than once.
          ;
          dtstamp / uid / organizer /
          ;
          ; The following are OPTIONAL,
          ; but MUST NOT occur more than once.
          ;
          acceptresponse / class / created / completed /
          description / dtstart / last-mod / pollmode /
          pollproperties / priority / seq / status /
          summary / url /
          ;
          ; Either 'dtend' or 'duration' MAY appear in
          ; a 'pollprop', but 'dtend' and 'duration'
          ; MUST NOT occur in the same 'pollprop'.
          ; 'duration' MUST only occur when 'dtstart'
          ; is present
          ;
          dtend / duration /
          ;
          ; The following are OPTIONAL,
          ; and MAY occur more than once.
          ;
          attach / categories / comment /
          contact / rstatus / related /
          resources / x-prop / iana-prop
          ;
          ; The following is OPTIONAL, it SHOULD appear
          ; once for the confirmation of a BASIC mode
          ; VPOLL. Other modes may define differing
          ; requirements.
          ;
          pollwinner /
          ;
          )

Figure 16

+ +

Description

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting — both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the “DTSTART” property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If “DTSTART” is present “DURATION” MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

“DTEND” MAY be specified with or without “DTSTART” and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+

5.6.2.  VOTE Component

Component name

+

VOTE

+

Purpose

+

This component provides a mechanism by which voters can +vote on provided choices.

+

Conformance

+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+

Format Definition

+

This property is defined by the following notation:

+
+

votec     = "BEGIN" ":" "VOTE" CRLF
            voteprop
            *eventc *todoc *journalc *freebusyc
            *availabilityc *alarmc *iana-comp *x-comp
            "END" ":" "VOTE" CRLF

voteprop = *(
           ;
           ; The following are REQUIRED,
           ; but MUST NOT occur more than once.
           ;
           pollitemid / response /
           ;
           ; The following are OPTIONAL,
           ; and MAY occur more than once.
           ;
           comment / x-prop / iana-prop
           ;
           )

Figure 17

+ +

Description

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER — such as the respondees +availability.

+
+
+

6.  Poll Modes

+

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see Clause 10.3) in a published RFC.

+

6.1.  POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+

6.1.1.  Property restrictions

This poll mode has the following property requirements:

+

POLL-ITEM-ID

+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+

POLL-WINNER

+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+

6.1.2.  Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+
+
+

7.  iTIP Extensions

+

This specification introduces a number of extensions to RFC 5546. +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+

7.1.  Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+

Table 1

MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+

Table 2

OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+

7.2.  Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+

7.2.1.  Delegation

+ +

TBD

+
+

7.2.2.  Acting on Behalf of Other Calendar Users

+ +

TBD

+
+

7.2.3.  Component Revisions

+ + +

+Need to talk about what a change in SEQUENCE means +

+

+Sequence change forces a revote. +

+

+New voter — no sequence change +

+

+Add another poll set or change poll item ids or any change to a child +

+

+component — bump sequence +

+ +
+

7.2.4.  Message Sequencing

+ +

TBD

+
+

7.3.  Application Protocol Elements

7.3.1.  Methods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the “VPOLL” calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+

Table 3

Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the “VPOLL” +calendar component.

+

Table 4

MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+

7.3.2.  Method: PUBLISH

The “PUBLISH” method in a “VPOLL” calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The “Organizer” MUST be present in a +published iCalendar component. “Voters” MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The “Organizer” may subsequently update (with another +“PUBLISH” method) or cancel (with a “CANCEL” method) a previously +published “VPOLL” calendar component.

+

Note

+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 5 — Constraints for a METHOD:PUBLISH of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0 or 1

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0 or 1

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to “VOTER” — that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0+

+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

7.3.3.  Method: REQUEST

The “REQUEST” method in a “VPOLL” component provides the following +scheduling functions:

+ +

+Invite “Voters” to respond to the poll. +

+

+Change the items being voted upon. +

+

+Complete or confirm the poll. +

+

+Response to a “REFRESH” request. +

+

+Update the details of an existing vpoll. +

+

+Update the status of “Voters”. +

+

+Forward a “VPOLL” to another uninvited CU. +

+

+For an existing “VPOLL” calendar component, delegate the role of +“Voter” to another CU. +

+

+For an existing “VPOLL” calendar component, change the role of +“Organizer” to another CU. +

+ +

The “Organizer” originates the “REQUEST”. The recipients of the +“REQUEST” method are the CUs voting in the poll, the “Voters”. +“Voters” use the “REPLY” method to convey votes to the “Organizer”.

+

The “UID” and “SEQUENCE” properties are used to distinguish the +various uses of the “REQUEST” method. If the “UID” property value in +the “REQUEST” is not found on the recipient’s calendar, then the +“REQUEST” is for a new “VPOLL” calendar component. If the “UID” +property value is found on the recipient’s calendar, then the +“REQUEST” is for an update, or a reconfirmation of the “VPOLL” +calendar component.

+

For the “REQUEST” method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 6 — Constraints for a METHOD:REQUEST of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0 or 1

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

VALARM

+
+

0+

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

7.3.3.1.  Rescheduling a poll

+ +

The “REQUEST” method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a “REQUEST” method finds that the “UID” +property value already exists on the calendar but that the “SEQUENCE” +(or “DTSTAMP”) property value in the “REQUEST” method is greater than +the value for the existing poll, then the “REQUEST” method describes +a rescheduling of the poll.

+
+

7.3.3.2.  Updating or Reconfirmation of a Poll

The “REQUEST” method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a “REQUEST” method +finds that the “UID” property value already exists on the calendar +and that the “SEQUENCE” property value in the “REQUEST” is the same +as the value for the existing poll, then the “REQUEST” method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update “REQUEST” method is the appropriate response to a +“REFRESH” method sent from a “Voter” to the “Organizer” of a poll.

+

The “Organizer” of a poll may also send unsolicited “REQUEST” +methods. The unsolicited “REQUEST” methods may be used to update the +details of the poll without rescheduling it, to update the “RESPONSE” +parameter of “Voters”, or to reconfirm the poll.

+

7.3.3.3.  Confirmation of a Poll

+ +

The “REQUEST” method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+

7.3.3.4.  Closing a Poll

+ +

The “REQUEST” method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+

7.3.3.5.  Delegating a Poll to Another CU

Some calendar and scheduling systems allow “Voters” to delegate the +vote to another “Calendar User”. iTIP supports this concept using the +following workflow. Any “Voter” may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original “Voter”, NOT in addition to the +“Voter”. The delegator MUST notify the “Organizer” of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a “REQUEST” +to another CU.

+

The “Delegator” of a poll forwards the existing “REQUEST” to the +“Delegate”. The “REQUEST” method MUST include a “Voter” property +with the calendar address of the “Delegate”. The “Delegator” MUST +also send a “REPLY” method to the “Organizer” with the “Delegator’s” +“Voter” property “DELEGATED-TO” parameter set to the calendar address +of the “Delegate”. Also, a new “Voter” property for the “Delegate” +MUST be included and must specify the calendar user address set in +the “DELEGATED-TO” parameter, as above.

+

In response to the request, the “Delegate” MUST send a “REPLY” method +to the “Organizer”, and optionally to the “Delegator”. The “REPLY”

+

method SHOULD include the “Voter” property with the “DELEGATED-FROM” +parameter value of the “Delegator’s” calendar address.

+

The “Delegator” may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +“Delegator” setting their “role” attribute to “NON-PARTICIPANT” in +the “REPLY” to the “Organizer”.

+

7.3.3.6.  Changing the Organizer

+ +

The situation may arise where the “Organizer” of a “VPOLL” is no +longer able to perform the “Organizer” role and abdicates without +passing on the “Organizer” role to someone else. When this occurs, +the “Voters” of the “VPOLL” may use out-of-band mechanisms to +communicate the situation and agree upon a new “Organizer”. The new +“Organizer” should then send out a new “REQUEST” with a modified +version of the “VPOLL” in which the “SEQUENCE” number has been +incremented and the “ORGANIZER” property has been changed to the new +“Organizer”.

+
+

7.3.3.7.  Sending on Behalf of the Organizer

+ +

There are a number of scenarios that support the need for a “Calendar +User” to act on behalf of the “Organizer” without explicit role +changing. This might be the case if the CU designated as “Organizer” +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the “SENT-BY” parameter, a “Calendar User” could +send an updated “VPOLL” “REQUEST”. In the case where one CU sends on +behalf of another CU, the “Voter” responses are still directed back +towards the CU designated as “Organizer”.

+
+

7.3.3.8.  Forwarding to an Uninvited CU

A “Voter” invited to a “VPOLL” calendar component may send the +“VPOLL” calendar component to another new CU not previously +associated with the “VPOLL” calendar component. The current “Voter” +participating in the “VPOLL” calendar component does this by +forwarding the original “REQUEST” method to the new CU. The new CU +can send a “REPLY” to the “Organizer” of the “VPOLL” calendar +component. The reply contains a “Voter” property for the new CU.

+

The “Organizer” ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a “REPLY” +from a new (uninvited) CU. If the “Organizer” does not want the new +CU to be part of the poll, the new “Voter” property is not added to +the “VPOLL” calendar component. The “Organizer” MAY send the CU a +“CANCEL” message to indicate that they will not be added to the poll.

+

If the “Organizer” decides to add the new CU, the new “Voter” +property is added to the “VPOLL” calendar component. Furthermore, +the “Organizer” is free to change any “Voter” property parameter from +the values supplied by the new CU to something the “Organizer” +considers appropriate. The “Organizer” SHOULD send the new CU a +“REQUEST” message to inform them that they have been added.

+

When forwarding a “REQUEST” to another CU, the forwarding “Voter” +MUST NOT make changes to the original message.

+

7.3.3.9.  Updating Voter Status

+ +

The “Organizer” of an poll may also request updated status from one +or more “Voters”. The “Organizer” sends a “REQUEST” method to the +“Voter” and sets the “RSVP=TRUE” property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +“SEQUENCE” property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +“REQUEST” is that their “RSVP” property parameter indicates a request +for updated status. The recipient SHOULD respond with a “REPLY” +method indicating their current vote with respect to the “REQUEST”.

+
+

7.3.4.  Method: REPLY

The “REPLY” method in a “VPOLL” calendar component is used to respond +(e.g., accept or decline) to a “REQUEST” or to reply to a delegation +“REQUEST”. When used to provide a delegation response, the +“Delegator” SHOULD include the calendar address of the “Delegate” on +the “DELEGATED-TO” property parameter of the “Delegator’s” “CALENDAR-ADDRESS” +property. The “Delegate” SHOULD include the calendar address of the +“Delegator” on the “DELEGATED-FROM” property parameter of the +“Delegate’s” “CALENDAR-ADDRESS” property.

+

The “REPLY” method is also used when processing of a “REQUEST” fails. +Depending on the value of the “REQUEST-STATUS” property, no action +may have been performed.

+

The “Organizer” of a poll may receive the “REPLY” method from a CU +not in the original “REQUEST”. For example, a “REPLY” may be +received from a “Delegate” to a poll. In addition, the “REPLY” +method may be received from an unknown CU (a “Party Crasher”). This +uninvited “Voter” may be accepted, or the “Organizer” may cancel the +poll for the uninvited “Voter” by sending a “CANCEL” method to the +uninvited “Voter”.

+

A “Voter” MAY include a message to the “Organizer” using the +“COMMENT” property. For example, if the user indicates a low +interest and wants to let the “Organizer” know why, the reason can be +expressed in the “COMMENT” property value.

+

The “Organizer” may also receive a “REPLY” from one CU on behalf of +another. Like the scenario enumerated above for the “Organizer”, +“Voters” may have another CU respond on their behalf. This is done +using the “SENT-BY” parameter.

+

The optional properties listed in the table below (those listed as +“0+” or “0 or 1”) MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 7 — Constraints for a METHOD:REPLY of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

REQUEST-STATUS

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

SUMMARY

+
+

0 or 1

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+

VTODO

+
+

0

+
+

7.3.5.  Method: CANCEL

The “CANCEL” method in a “VPOLL” calendar component is used to send a +cancellation notice of an existing poll request to the affected +“Voters”. The message is sent by the “Organizer” of the poll.

+

The “Organizer” MUST send a “CANCEL” message to each “Voter” affected +by the cancellation. This can be done using a single “CANCEL” +message for all “Voters” or by using multiple messages with different +subsets of the affected “Voters” in each.

+

When a “VPOLL” is cancelled, the “SEQUENCE” property value MUST be +incremented as described in Clause 7.2.3.

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 8 — Constraints for a METHOD:CANCEL of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

SEQUENCE

+
+

1

+
+

ATTACH

+
+

0+

+
+

ACCEPT-RESPONSE

+
+

0

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VTODO

+
+

0

+
+

VJOURNAL

+
+

0

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0

+
+

7.3.6.  Method: REFRESH

The “REFRESH” method in a “VPOLL” calendar component is used by +“Voters” of an existing event to request an updated description from +the poll “Organizer”. The “REFRESH” method must specify the “UID” +property of the poll to update. The “Organizer” responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 9 — Constraints for a METHOD:REFRESH of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

ACCEPT-RESPONSE

+
+

0

+
+

ATTACH

+
+

0

+
+

CATEGORIES

+
+

0

+
+

CLASS

+
+

0

+
+

CONTACT

+
+

0

+
+

CREATED

+
+

0

+
+

DESCRIPTION

+
+

0

+
+

DTEND

+
+

0

+
+

DTSTART

+
+

0

+
+

DURATION

+
+

0

+
+

GEO

+
+

0

+
+

LAST-MODIFIED

+
+

0

+
+

LOCATION

+
+

0

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0

+
+

RELATED-TO

+
+

0

+
+

REQUEST-STATUS

+
+

0

+
+

RESOURCES

+
+

0

+
+

SEQUENCE

+
+

0

+
+

STATUS

+
+

0

+
+

SUMMARY

+
+

0

+
+

URL

+
+

0

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0+

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VTODO

+
+

0

+
+

VJOURNAL

+
+

0

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0

+
+

7.3.7.  Method: POLLSTATUS

The “POLLSTATUS” method in a “VPOLL” calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The “Organizer” MUST be present in the confirmed poll +component. All “Voters” MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 10 — Constraints for a METHOD:POLLSTATUS of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

ORGANIZER

+
+

1

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+

ATTACH

+
+

0

+
+

CATEGORIES

+
+

0

+
+

CLASS

+
+

0

+
+

COMMENT

+
+

0+

+
+

CONTACT

+
+

0

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0+

+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+
+
+

8.  CalDAV Extensions

+

This specification extends RFC 4791 in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends RFC 6638 as it a VPOLL component is a +schedulable entity.

+

8.1.  Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+

8.1.1.  CALDAV:supported-vpoll-component-sets

Name

+

supported-vpoll-component-sets

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition Clause 8.2 being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

Definition

+

<!ELEMENT supported-vpoll-component-sets
     (supported-vpoll-component-set*) >

<!ELEMENT supported-vpoll-component-set (comp+)>

Figure 18

+ +

<C:supported-vpoll-component-sets
     xmlns:C="urn:ietf:params:xml:ns:caldav">

  <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
    <C:comp name="VFREEBUSY" />
    <C:comp name="VTODO" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VEVENT or VFREEBUSY -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
    <C:comp name="VFREEBUSY" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VEVENT -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VTODO -->
  <C:supported-vpoll-component-set>
    <C:comp name="VTODO" />
  </C:supported-vpoll-component-set>
</C:supported-vpoll-component-sets>

Figure 19

+
+

8.1.2.  CALDAV:vpoll-max-items

Name

+

vpoll-max-items

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+

Definition

+

<!ELEMENT vpoll-max-items (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 20

+ +

<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-items>

Figure 21

+
+

8.1.3.  CALDAV:vpoll-max-active

Name

+

vpoll-max-active

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+

Definition

+

<!ELEMENT vpoll-max-active (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 22

+ +

<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-active>

Figure 23

+
+

8.1.4.  CALDAV:vpoll-max-voters

Name

+

+vpoll-max-voters +

+

Namespace

+

+urn:ietf:params:xml:ns:caldav +

+

Purpose

+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition Clause 8.2 +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+

Definition

+

<!ELEMENT vpoll-max-voters (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 24

+ +

<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-voters>

Figure 25

+
+

8.1.5.  CalDAV:even-more-properties

+ +
+

8.1.6.  Extensions to CalDAV scheduling

This specification extends RFC 6638.

+

Each section of Appendix A “Scheduling Privileges Summary” is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+

8.2.  Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+

(CALDAV:supported-vpoll-component-sets)

+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+

(CALDAV:vpoll-max-items)

+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value Clause 8.1.2 +on the calendar collection where the resource will be stored;

+

(CALDAV:vpoll-max-active)

+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value +Clause 8.1.3 on the calendar collection where the resource will +be stored;

+

(CALDAV:vpoll-max-voters)

+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value Clause 8.1.4 on the +calendar collection where the resource will be stored;

+
+

8.3.  CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+

8.3.1.  Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+

>> Request <<

REPORT /cyrus/work/ HTTP/1.1
Host: cal.example.com
Depth: 1
Content-Type: application/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<C:calendar-query xmlns:D="DAV:"
              xmlns:C="urn:ietf:params:xml:ns:caldav">
  <D:prop>
    <D:getetag/>
    <C:calendar-data>
      <C:comp name="VCALENDAR">
        <C:prop name="VERSION"/>
        <C:comp name="VPOLL">
          <C:prop name="SUMMARY"/>
          <C:prop name="UID"/>
          <C:prop name="DTSTART"/>
          <C:prop name="DTEND"/>
          <C:prop name="DURATION"/>
        </C:comp>

      </C:comp>
    </C:calendar-data>
  </D:prop>
  <C:filter>
    <C:comp-filter name="VCALENDAR">
      <C:comp-filter name="VPOLL">
        <C:time-range start="20121204T000000Z"
                      end="20121205T000000Z"/>
      </C:comp-filter>
    </C:comp-filter>
  </C:filter>
</C:calendar-query>

>> Response <<

HTTP/1.1 207 Multi-Status
Date: Sat, 11 Nov 2012 09:32:12 GMT
Content-Type: application/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:"
           xmlns:C="urn:ietf:params:xml:ns:caldav">
  <D:response>
    <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href>
    <D:propstat>
      <D:prop>
        <D:getetag>"fffff-abcd2"</D:getetag>
        <C:calendar-data>BEGIN:VCALENDAR
VERSION:2.0
BEGIN:VPOLL
DTSTART;TZID=US/Eastern:20121202T120000
DURATION:PT4D
SUMMARY:Poll #2
UID:00959BC664CA650E933C892C@example.com
END:VPOLL
END:VCALENDAR
</C:calendar-data>
      </D:prop>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
  <D:response>
    <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href>
    <D:propstat>
      <D:prop>
        <D:getetag>"fffff-abcd3"</D:getetag>
        <C:calendar-data>BEGIN:VCALENDAR

VERSION:2.0
PRODID:-//Example Corp.//CalDAV Client//EN
BEGIN:VPOLL
DTSTART;TZID=US/Eastern:20121204T100000
DURATION:PT4D
SUMMARY:Poll #3
UID:DC6C50A017428C5216A2F1CD@example.com
END:VPOLL
END:VCALENDAR
</C:calendar-data>
      </D:prop>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
</D:multistatus>

Figure 26

+
+

8.4.  CalDAV time ranges

“CALDAV:time-range XML Element” in RFC 4791, Section 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends RFC 4791 to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

+

+-------------------------------------------------------------------+
| VPOLL has the DTSTART property?                                   |
|   +---------------------------------------------------------------+
|   |   VPOLL has the DURATION property?                            |
|   |   +-----------------------------------------------------------+
|   |   | VPOLL has the DTEND property?                             |
|   |   |   +-------------------------------------------------------+
|   |   |   | VPOLL has the COMPLETED property?                     |
|   |   |   |   +---------------------------------------------------+
|   |   |   |   | VPOLL has the CREATED property?                   |
|   |   |   |   |   +-----------------------------------------------+
|   |   |   |   |   | Condition to evaluate                         |
+---+---+---+---+---+-----------------------------------------------+
| Y | Y | N | * | * | (start  <= DTSTART+DURATION)  AND             |
|   |   |   |   |   | ((end   >  DTSTART)  OR                       |
|   |   |   |   |   |  (end   >= DTSTART+DURATION))                 |
+---+---+---+---+---+-----------------------------------------------+
| Y | N | Y | * | * | ((start <  DTEND)    OR  (start <= DTSTART))  |
|   |   |   |   |   | AND                                           |
|   |   |   |   |   | ((end   >  DTSTART)  OR  (end   >= DTEND))    |
+---+---+---+---+---+-----------------------------------------------+
| Y | N | N | * | * | (start  <= DTSTART)  AND (end >  DTSTART)     |
+---+---+---+---+---+-----------------------------------------------+
| N | N | Y | * | * | (start  <  DTEND)    AND (end >= DTEND)       |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | Y | Y | ((start <= CREATED)  OR  (start <= COMPLETED))|
|   |   |   |   |   | AND                                           |
|   |   |   |   |   | ((end   >= CREATED)  OR  (end   >= COMPLETED))|
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | Y | N | (start  <= COMPLETED) AND (end  >= COMPLETED) |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | N | Y | (end    >  CREATED)                           |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | N | N | TRUE                                          |
+---+---+---+---+---+-----------------------------------------------+

Figure 27

+
+
+
+

9.  Security Considerations

+

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See RFC 3986 for a +discussion of the security considerations relating to URIs.

+
+
+

10.  IANA Considerations

+

10.1.  Parameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in RFC 5545, Section 8.2.4:

+

Table 11

Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+Clause 5.4.1 +

+
+

STAY-INFORMED

+
+

Current

+
+

+Clause 5.4.2 +

+
+

10.2.  Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in RFC 5545, Section 8.2.3:

+

Table 12

PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+Clause 5.5.7 +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+Clause 5.5.3 +

+
+

POLL-MODE

+
+

Current

+
+

+Clause 5.5.4 +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+Clause 5.5.5 +

+
+

POLL-WINNER

+
+

Current

+
+

+Clause 5.5.6 +

+
+

RESPONSE

+
+

Current

+
+

+Clause 5.5.8 +

+
+

10.3.  POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+

Poll mode name

+

The name of the poll mode.

+

Purpose

+

The purpose of the poll mode. Give a short but clear +description.

+

Reference

+

A reference to the RFC in which the poll mode is defined

+
+

10.4.  POLL-MODE Registrations

This document defines the following registered poll modes.

+

Table 13

Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+
+

+
+

+
+

Appendix A
(informative)
Open issues

+

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven’t voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No — voter + has indicated now unable to attend — want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user’s isn’t the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can’t create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event — winning properties ONLY are merged in to the real event.

+

Need to write down what isn’t valid in a VPOLL
+ a. Can’t change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? — some iTip notes On confirm — send itip if appropriate (PUBLISH) +  — all non-participating — shared — feeds + Organizer can specify where result is? + Confirm can specify that itip is sent — ITIP / NONE — parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest
METHOD: REPLY
BEGIN:VPOLL
ORGANIZER:mailto:douglm@mysite.edu
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
UID:sched01-1234567890
DTSTAMP:20120101T010000Z
SEQUENCE:0
SUMMARY:What to do this week
BEGIN:VFREEBUSY
.......
END:VFREEBUSY
END:PARTICIPANT
END:VPOLL
END:VCALENDAR

+

Figure A.1

+
+

+
+

+
+

Appendix B
(informative)
Change log

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Calext V01: 2019-10-17 MD

+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+

Calext V00: 2019-05-17 MD

+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+

V03: 2014-10-28 MD

+
+ +

+Add VVOTER and VOTE components. +

+

+Add RESPONSE property. +

+

+Remove RESPONSE parameter from VOTER. +

+ +
+

V03: 2014-05-12 MD

+
+ +

+Add reply-url property and required parameter. +

+

+Fix ACCEPT-RESPONSE definition. +

+ +
+

V02: 2014-05-12 MD

+
+ +

+Typos fixed, clarifications made. +

+

+Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT +

+

+Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values. +

+

+iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent +

+

+iTip: fix broken table cells +

+

+Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table +

+

+Added Caldav scheduling section +

+ +
+

V01: 2013-08-07 MD

+
+ +

+Removed method CONFIRM +

+

+Removed pollitemid from VPOLL abnf. Added text for pollwinner +

+

+Added POLL-WINNER and verbiage +

+

+Added STATUS values +

+

+Added RELTYPE=POLL +

+

+Added supported-vpoll-component-sets +

+

+Added CalDAV related parameters to VOTER +

+

+Removed bad CalDAV query example. State that queries cannot +target the sub-components. +

+ +
+

Initial version: 2012-11-02 MD

+
+
+

+
+

+

Bibliography

+ +
+
+
+ + + +------=_NextPart_81178210.676e.4040 +Content-Location: file:///C:/Doc/cc-51006_files/filelist.xml +Content-Transfer-Encoding: base64 +Content-Type: application/xml + +PHhtbCB4bWxuczpvPSJ1cm46c2NoZW1hcy1taWNyb3NvZnQtY29tOm9mZmljZTpvZmZpY2UiPgog +ICAgICAgIDxvOk1haW5GaWxlIEhSZWY9Ii4uL2RvY3VtZW50cy9jYy01MTAwNi5odG0iLz4gIDxv +OkZpbGUgSFJlZj0iZmlsZWxpc3QueG1sIi8+CiAgPG86RmlsZSBIUmVmPSJoZWFkZXIuaHRtbCIv +Pgo8L3htbD4K + +------=_NextPart_81178210.676e.4040 +Content-Location: file:///C:/Doc/cc-51006_files/header.html +Content-Transfer-Encoding: base64 +Content-Type: text/html charset="utf-8" + +PGh0bWwgeG1sbnM6dj0idXJuOnNjaGVtYXMtbWljcm9zb2Z0LWNvbTp2bWwiDQp4bWxuczpvPSJ1 +cm46c2NoZW1hcy1taWNyb3NvZnQtY29tOm9mZmljZTpvZmZpY2UiDQp4bWxuczp3PSJ1cm46c2No +ZW1hcy1taWNyb3NvZnQtY29tOm9mZmljZTp3b3JkIg0KeG1sbnM6bT0iaHR0cDovL3NjaGVtYXMu +bWljcm9zb2Z0LmNvbS9vZmZpY2UvMjAwNC8xMi9vbW1sIg0KeG1sbnM6bXY9Imh0dHA6Ly9tYWNW +bWxTY2hlbWFVcmkiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy9UUi9SRUMtaHRtbDQwIj4NCg0K +PGhlYWQ+DQo8bWV0YSBuYW1lPVRpdGxlIGNvbnRlbnQ9IiI+DQo8bWV0YSBuYW1lPUtleXdvcmRz +IGNvbnRlbnQ9IiI+DQo8bWV0YSBodHRwLWVxdWl2PUNvbnRlbnQtVHlwZSBjb250ZW50PSJ0ZXh0 +L2h0bWw7IGNoYXJzZXQ9dXRmLTgiPg0KPG1ldGEgbmFtZT1Qcm9nSWQgY29udGVudD1Xb3JkLkRv +Y3VtZW50Pg0KPG1ldGEgbmFtZT1HZW5lcmF0b3IgY29udGVudD0iTWljcm9zb2Z0IFdvcmQgMTUi +Pg0KPG1ldGEgbmFtZT1PcmlnaW5hdG9yIGNvbnRlbnQ9Ik1pY3Jvc29mdCBXb3JkIDE1Ij4NCjxs +aW5rIGlkPU1haW4tRmlsZSByZWw9TWFpbi1GaWxlIGhyZWY9Ii4uL2RvY3VtZW50cy9jYy01MTAw +Ni5odG1sIj4NCjwhLS1baWYgZ3RlIG1zbyA5XT48eG1sPg0KIDxvOnNoYXBlZGVmYXVsdHMgdjpl +eHQ9ImVkaXQiIHNwaWRtYXg9IjIwNDkiLz4NCjwveG1sPjwhW2VuZGlmXS0tPg0KPC9oZWFkPg0K +DQo8Ym9keSBsYW5nPUVOIGxpbms9Ymx1ZSB2bGluaz0iIzk1NEY3MiI+DQoNCjxkaXYgc3R5bGU9 +J21zby1lbGVtZW50OmZvb3Rub3RlLXNlcGFyYXRvcicgaWQ9ZnM+DQoNCjxwIGNsYXNzPU1zb05v +cm1hbCBzdHlsZT0nbWFyZ2luLWJvdHRvbTowY207bWFyZ2luLWJvdHRvbTouMDAwMXB0O2xpbmUt +aGVpZ2h0Og0Kbm9ybWFsJz48c3BhbiBsYW5nPUVOLUdCPjxzcGFuIHN0eWxlPSdtc28tc3BlY2lh +bC1jaGFyYWN0ZXI6Zm9vdG5vdGUtc2VwYXJhdG9yJz48IVtpZiAhc3VwcG9ydEZvb3Rub3Rlc10+ +DQoNCjxociBhbGlnbj1sZWZ0IHNpemU9MSB3aWR0aD0iMzMlIj4NCg0KPCFbZW5kaWZdPjwvc3Bh +bj48L3NwYW4+PC9wPg0KDQo8L2Rpdj4NCg0KPGRpdiBzdHlsZT0nbXNvLWVsZW1lbnQ6Zm9vdG5v +dGUtY29udGludWF0aW9uLXNlcGFyYXRvcicgaWQ9ZmNzPg0KDQo8cCBjbGFzcz1Nc29Ob3JtYWwg +c3R5bGU9J21hcmdpbi1ib3R0b206MGNtO21hcmdpbi1ib3R0b206LjAwMDFwdDtsaW5lLWhlaWdo +dDoNCm5vcm1hbCc+PHNwYW4gbGFuZz1FTi1HQj48c3BhbiBzdHlsZT0nbXNvLXNwZWNpYWwtY2hh +cmFjdGVyOmZvb3Rub3RlLWNvbnRpbnVhdGlvbi1zZXBhcmF0b3InPjwhW2lmICFzdXBwb3J0Rm9v +dG5vdGVzXT4NCg0KPGhyIGFsaWduPWxlZnQgc2l6ZT0xPg0KDQo8IVtlbmRpZl0+PC9zcGFuPjwv +c3Bhbj48L3A+DQoNCjwvZGl2Pg0KDQo8ZGl2IHN0eWxlPSdtc28tZWxlbWVudDplbmRub3RlLXNl +cGFyYXRvcicgaWQ9ZXM+DQoNCjxwIGNsYXNzPU1zb05vcm1hbCBzdHlsZT0nbWFyZ2luLWJvdHRv +bTowY207bWFyZ2luLWJvdHRvbTouMDAwMXB0O2xpbmUtaGVpZ2h0Og0Kbm9ybWFsJz48c3BhbiBs +YW5nPUVOLUdCPjxzcGFuIHN0eWxlPSdtc28tc3BlY2lhbC1jaGFyYWN0ZXI6Zm9vdG5vdGUtc2Vw +YXJhdG9yJz48IVtpZiAhc3VwcG9ydEZvb3Rub3Rlc10+DQoNCjxociBhbGlnbj1sZWZ0IHNpemU9 +MSB3aWR0aD0iMzMlIj4NCg0KPCFbZW5kaWZdPjwvc3Bhbj48L3NwYW4+PC9wPg0KDQo8L2Rpdj4N +Cg0KPGRpdiBzdHlsZT0nbXNvLWVsZW1lbnQ6ZW5kbm90ZS1jb250aW51YXRpb24tc2VwYXJhdG9y +JyBpZD1lY3M+DQoNCjxwIGNsYXNzPU1zb05vcm1hbCBzdHlsZT0nbWFyZ2luLWJvdHRvbTowY207 +bWFyZ2luLWJvdHRvbTouMDAwMXB0O2xpbmUtaGVpZ2h0Og0Kbm9ybWFsJz48c3BhbiBsYW5nPUVO +LUdCPjxzcGFuIHN0eWxlPSdtc28tc3BlY2lhbC1jaGFyYWN0ZXI6Zm9vdG5vdGUtY29udGludWF0 +aW9uLXNlcGFyYXRvcic+PCFbaWYgIXN1cHBvcnRGb290bm90ZXNdPg0KDQo8aHIgYWxpZ249bGVm +dCBzaXplPTE+DQoNCjwhW2VuZGlmXT48L3NwYW4+PC9zcGFuPjwvcD4NCg0KPC9kaXY+DQoNCjxk +aXYgc3R5bGU9J21zby1lbGVtZW50OmhlYWRlcicgaWQ9ZWgxPg0KPHAgY2xhc3M9TXNvSGVhZGVy +IGFsaWduPWxlZnQgc3R5bGU9J3RleHQtYWxpZ246bGVmdDtsaW5lLWhlaWdodDoxMi4wcHQ7DQpt +c28tbGluZS1oZWlnaHQtcnVsZTpleGFjdGx5Jz48c3BhbiBsYW5nPUVOLUdCPkNDJm5ic3A7Q0Mv +Q0QgNTEwMDY6MjAxODoyMDE4PC9zcGFuPjwvcD4NCjwvZGl2Pg0KDQo8ZGl2IHN0eWxlPSdtc28t +ZWxlbWVudDpoZWFkZXInIGlkPWgxPg0KDQo8cCBjbGFzcz1Nc29IZWFkZXIgc3R5bGU9J21hcmdp +bi1ib3R0b206MTguMHB0Jz48c3BhbiBsYW5nPUVOLUdCDQpzdHlsZT0nZm9udC1zaXplOjEwLjBw +dDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0O2ZvbnQtd2VpZ2h0Om5vcm1hbCc+wqkNClRoZSBD +YWxlbmRhcmluZyBhbmQgU2NoZWR1bGluZyBDb25zb3J0aXVtLCBJbmMuJm5ic3A7MjAxOCZuYnNw +O+KAkyBBbGwgcmlnaHRzIHJlc2VydmVkPC9zcGFuPjxzcGFuIGxhbmc9RU4tR0INCnN0eWxlPSdm +b250LXdlaWdodDpub3JtYWwnPjxvOnA+PC9vOnA+PC9zcGFuPjwvcD4NCg0KPC9kaXY+DQoNCjxk +aXYgc3R5bGU9J21zby1lbGVtZW50OmZvb3RlcicgaWQ9ZWYxPg0KDQo8cCBjbGFzcz1Nc29Gb290 +ZXIgc3R5bGU9J21hcmdpbi10b3A6MTIuMHB0O2xpbmUtaGVpZ2h0OjEyLjBwdDttc28tbGluZS1o +ZWlnaHQtcnVsZToNCmV4YWN0bHknPjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PGIgc3R5bGU9J21z +by1iaWRpLWZvbnQtd2VpZ2h0Om5vcm1hbCc+PHNwYW4NCmxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQt +c2l6ZToxMC4wcHQ7bXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+PHNwYW4NCnN0eWxlPSdtc28t +ZWxlbWVudDpmaWVsZC1iZWdpbic+PC9zcGFuPjxzcGFuDQpzdHlsZT0nbXNvLXNwYWNlcnVuOnll +cyc+wqA8L3NwYW4+UEFHRTxzcGFuIHN0eWxlPSdtc28tc3BhY2VydW46eWVzJz7CoMKgDQo8L3Nw +YW4+XCogTUVSR0VGT1JNQVQgPHNwYW4gc3R5bGU9J21zby1lbGVtZW50OmZpZWxkLXNlcGFyYXRv +cic+PC9zcGFuPjwvc3Bhbj48L2I+PCFbZW5kaWZdLS0+PGINCnN0eWxlPSdtc28tYmlkaS1mb250 +LXdlaWdodDpub3JtYWwnPjxzcGFuIGxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7 +DQptc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3BhbiBzdHlsZT0nbXNvLW5vLXByb29mOnll +cyc+Mjwvc3Bhbj48L3NwYW4+PC9iPjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PGINCnN0eWxlPSdt +c28tYmlkaS1mb250LXdlaWdodDpub3JtYWwnPjxzcGFuIGxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQt +c2l6ZToxMC4wcHQ7DQptc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3BhbiBzdHlsZT0nbXNv +LWVsZW1lbnQ6ZmllbGQtZW5kJz48L3NwYW4+PC9zcGFuPjwvYj48IVtlbmRpZl0tLT48c3Bhbg0K +bGFuZz1FTi1HQiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250LXNpemU6MTEu +MHB0Jz48c3Bhbg0Kc3R5bGU9J21zby10YWItY291bnQ6MSc+wqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoCA8L3NwYW4+wqkNClRoZSBDYWxlbmRh +cmluZyBhbmQgU2NoZWR1bGluZyBDb25zb3J0aXVtLCBJbmMuJm5ic3A7MjAxOCZuYnNwO+KAkyBB +bGwgcmlnaHRzIHJlc2VydmVkPG86cD48L286cD48L3NwYW4+PC9wPg0KDQo8L2Rpdj4NCg0KPGRp +diBzdHlsZT0nbXNvLWVsZW1lbnQ6aGVhZGVyJyBpZD1laDI+DQo8cCBjbGFzcz1Nc29IZWFkZXIg +YWxpZ249bGVmdCBzdHlsZT0ndGV4dC1hbGlnbjpsZWZ0O2xpbmUtaGVpZ2h0OjEyLjBwdDsNCm1z +by1saW5lLWhlaWdodC1ydWxlOmV4YWN0bHknPjxzcGFuIGxhbmc9RU4tR0I+VGhlIENhbGVuZGFy +aW5nIGFuZCBTY2hlZHVsaW5nIENvbnNvcnRpdW0sIEluYy4mbmJzcDtDQy9DRCA1MTAwNjoyMDE4 +OjIwMTg8L3NwYW4+PC9wPg0KPC9kaXY+DQoNCjxkaXYgc3R5bGU9J21zby1lbGVtZW50OmhlYWRl +cicgaWQ9ZWgybD4NCjxwIGNsYXNzPU1zb0hlYWRlckxhbmRzY2FwZSBhbGlnbj1sZWZ0IHN0eWxl +PSd0ZXh0LWFsaWduOmxlZnQ7bGluZS1oZWlnaHQ6MTIuMHB0Ow0KbXNvLWxpbmUtaGVpZ2h0LXJ1 +bGU6ZXhhY3RseSc+PHNwYW4gbGFuZz1FTi1HQj5UaGUgQ2FsZW5kYXJpbmcgYW5kIFNjaGVkdWxp +bmcgQ29uc29ydGl1bSwgSW5jLiZuYnNwO0NDL0NEIDUxMDA2OjIwMTg6MjAxODwvc3Bhbj48L3A+ +DQo8L2Rpdj4NCg0KPGRpdiBzdHlsZT0nbXNvLWVsZW1lbnQ6aGVhZGVyJyBpZD1oMj4NCjxwIGNs +YXNzPU1zb0hlYWRlciBhbGlnbj1yaWdodCBzdHlsZT0ndGV4dC1hbGlnbjpyaWdodDtsaW5lLWhl +aWdodDoxMi4wcHQ7DQptc28tbGluZS1oZWlnaHQtcnVsZTpleGFjdGx5Jz48c3BhbiBsYW5nPUVO +LUdCPlRoZSBDYWxlbmRhcmluZyBhbmQgU2NoZWR1bGluZyBDb25zb3J0aXVtLCBJbmMuJm5ic3A7 +Q0MvQ0QgNTEwMDY6MjAxODoyMDE4PC9zcGFuPjwvcD4NCjwvZGl2Pg0KDQo8ZGl2IHN0eWxlPSdt +c28tZWxlbWVudDpoZWFkZXInIGlkPWgybD4NCjxwIGNsYXNzPU1zb0hlYWRlckxhbmRzY2FwZSBh +bGlnbj1yaWdodCBzdHlsZT0ndGV4dC1hbGlnbjpyaWdodDtsaW5lLWhlaWdodDoxMi4wcHQ7DQpt +c28tbGluZS1oZWlnaHQtcnVsZTpleGFjdGx5Jz48c3BhbiBsYW5nPUVOLUdCPlRoZSBDYWxlbmRh +cmluZyBhbmQgU2NoZWR1bGluZyBDb25zb3J0aXVtLCBJbmMuJm5ic3A7Q0MvQ0QgNTEwMDY6MjAx +ODoyMDE4PC9zcGFuPjwvcD4NCjwvZGl2Pg0KDQo8ZGl2IHN0eWxlPSdtc28tZWxlbWVudDpmb290 +ZXInIGlkPWVmMj4NCjxwIGNsYXNzPU1zb0Zvb3RlciBzdHlsZT0nbGluZS1oZWlnaHQ6MTIuMHB0 +O21zby1saW5lLWhlaWdodC1ydWxlOmV4YWN0bHknPjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PHNw +YW4NCmxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7bXNvLWJpZGktZm9udC1zaXpl +OjExLjBwdCc+PHNwYW4NCnN0eWxlPSdtc28tZWxlbWVudDpmaWVsZC1iZWdpbic+PC9zcGFuPjxz +cGFuDQpzdHlsZT0nbXNvLXNwYWNlcnVuOnllcyc+wqA8L3NwYW4+UEFHRTxzcGFuIHN0eWxlPSdt +c28tc3BhY2VydW46eWVzJz7CoMKgDQo8L3NwYW4+XCogTUVSR0VGT1JNQVQgPHNwYW4gc3R5bGU9 +J21zby1lbGVtZW50OmZpZWxkLXNlcGFyYXRvcic+PC9zcGFuPjwvc3Bhbj48IVtlbmRpZl0tLT48 +c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250LXNp +emU6MTEuMHB0Jz48c3Bhbg0Kc3R5bGU9J21zby1uby1wcm9vZjp5ZXMnPmlpPC9zcGFuPjwvc3Bh +bj48IS0tW2lmIHN1cHBvcnRGaWVsZHNdPjxzcGFuDQpsYW5nPUVOLUdCIHN0eWxlPSdmb250LXNp +emU6MTAuMHB0O21zby1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxzcGFuDQpzdHlsZT0nbXNvLWVs +ZW1lbnQ6ZmllbGQtZW5kJz48L3NwYW4+PC9zcGFuPjwhW2VuZGlmXS0tPjxzcGFuIGxhbmc9RU4t +R0INCnN0eWxlPSdmb250LXNpemU6MTAuMHB0O21zby1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxz +cGFuIHN0eWxlPSdtc28tdGFiLWNvdW50Og0KMSc+wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoCA8L3NwYW4+wqkNClRoZSBDYWxlbmRhcmluZyBh +bmQgU2NoZWR1bGluZyBDb25zb3J0aXVtLCBJbmMuJm5ic3A7MjAxOCZuYnNwO+KAkyBBbGwgcmln +aHRzIHJlc2VydmVkPG86cD48L286cD48L3NwYW4+PC9wPg0KPC9kaXY+DQoNCjxkaXYgc3R5bGU9 +J21zby1lbGVtZW50OmZvb3RlcicgaWQ9ZWYybD4NCjxwIGNsYXNzPU1zb0Zvb3RlckxhbmRzY2Fw +ZSBzdHlsZT0nbGluZS1oZWlnaHQ6MTIuMHB0O21zby1saW5lLWhlaWdodC1ydWxlOmV4YWN0bHkn +PjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PHNwYW4NCmxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQtc2l6 +ZToxMC4wcHQ7bXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+PHNwYW4NCnN0eWxlPSdtc28tZWxl +bWVudDpmaWVsZC1iZWdpbic+PC9zcGFuPjxzcGFuDQpzdHlsZT0nbXNvLXNwYWNlcnVuOnllcyc+ +wqA8L3NwYW4+UEFHRTxzcGFuIHN0eWxlPSdtc28tc3BhY2VydW46eWVzJz7CoMKgDQo8L3NwYW4+ +XCogTUVSR0VGT1JNQVQgPHNwYW4gc3R5bGU9J21zby1lbGVtZW50OmZpZWxkLXNlcGFyYXRvcic+ +PC9zcGFuPjwvc3Bhbj48IVtlbmRpZl0tLT48c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0nZm9udC1z +aXplOjEwLjBwdDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3Bhbg0Kc3R5bGU9J21zby1u +by1wcm9vZjp5ZXMnPmlpPC9zcGFuPjwvc3Bhbj48IS0tW2lmIHN1cHBvcnRGaWVsZHNdPjxzcGFu +DQpsYW5nPUVOLUdCIHN0eWxlPSdmb250LXNpemU6MTAuMHB0O21zby1iaWRpLWZvbnQtc2l6ZTox +MS4wcHQnPjxzcGFuDQpzdHlsZT0nbXNvLWVsZW1lbnQ6ZmllbGQtZW5kJz48L3NwYW4+PC9zcGFu +PjwhW2VuZGlmXS0tPjxzcGFuIGxhbmc9RU4tR0INCnN0eWxlPSdmb250LXNpemU6MTAuMHB0O21z +by1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxzcGFuIHN0eWxlPSdtc28tdGFiLWNvdW50Og0KMSc+ +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoCA8 +L3NwYW4+wqkNClRoZSBDYWxlbmRhcmluZyBhbmQgU2NoZWR1bGluZyBDb25zb3J0aXVtLCBJbmMu +Jm5ic3A7MjAxOCZuYnNwO+KAkyBBbGwgcmlnaHRzIHJlc2VydmVkPG86cD48L286cD48L3NwYW4+ +PC9wPg0KPC9kaXY+DQoNCjxkaXYgc3R5bGU9J21zby1lbGVtZW50OmZvb3RlcicgaWQ9ZjI+DQo8 +cCBjbGFzcz1Nc29Gb290ZXIgc3R5bGU9J2xpbmUtaGVpZ2h0OjEyLjBwdCc+PHNwYW4gbGFuZz1F +Ti1HQg0Kc3R5bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7bXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+ +wqkgVGhlIENhbGVuZGFyaW5nIGFuZCBTY2hlZHVsaW5nIENvbnNvcnRpdW0sIEluYy4mbmJzcDsy +MDE4Jm5ic3A74oCTIEFsbA0KcmlnaHRzIHJlc2VydmVkPHNwYW4gc3R5bGU9J21zby10YWItY291 +bnQ6MSc+wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqAgPC9zcGFuPjwvc3Bhbj48IS0tW2lmIHN1cHBvcnRGaWVsZHNdPjxzcGFuDQpsYW5nPUVOLUdC +IHN0eWxlPSdmb250LXNpemU6MTAuMHB0O21zby1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxzcGFu +DQpzdHlsZT0nbXNvLWVsZW1lbnQ6ZmllbGQtYmVnaW4nPjwvc3Bhbj4gUEFHRTxzcGFuIHN0eWxl +PSdtc28tc3BhY2VydW46eWVzJz7CoMKgDQo8L3NwYW4+XCogTUVSR0VGT1JNQVQgPHNwYW4gc3R5 +bGU9J21zby1lbGVtZW50OmZpZWxkLXNlcGFyYXRvcic+PC9zcGFuPjwvc3Bhbj48IVtlbmRpZl0t +LT48c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250 +LXNpemU6MTEuMHB0Jz48c3Bhbg0Kc3R5bGU9J21zby1uby1wcm9vZjp5ZXMnPmlpaTwvc3Bhbj48 +L3NwYW4+PCEtLVtpZiBzdXBwb3J0RmllbGRzXT48c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0nZm9u +dC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3Bhbg0Kc3R5bGU9J21z +by1lbGVtZW50OmZpZWxkLWVuZCc+PC9zcGFuPjwvc3Bhbj48IVtlbmRpZl0tLT48c3BhbiBsYW5n +PUVOLUdCDQpzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0 +Jz48bzpwPjwvbzpwPjwvc3Bhbj48L3A+DQo8L2Rpdj4NCg0KPGRpdiBzdHlsZT0nbXNvLWVsZW1l +bnQ6Zm9vdGVyJyBpZD1mMmw+DQo8cCBjbGFzcz1Nc29Gb290ZXJMYW5kc2NhcGUgc3R5bGU9J2xp +bmUtaGVpZ2h0OjEyLjBwdCc+PHNwYW4gbGFuZz1FTi1HQg0Kc3R5bGU9J2ZvbnQtc2l6ZToxMC4w +cHQ7bXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+wqkgVGhlIENhbGVuZGFyaW5nIGFuZCBTY2hl +ZHVsaW5nIENvbnNvcnRpdW0sIEluYy4mbmJzcDsyMDE4Jm5ic3A74oCTIEFsbA0KcmlnaHRzIHJl +c2VydmVkPHNwYW4gc3R5bGU9J21zby10YWItY291bnQ6MSc+wqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqAgPC9zcGFuPjwvc3Bhbj48IS0tW2lmIHN1 +cHBvcnRGaWVsZHNdPjxzcGFuDQpsYW5nPUVOLUdCIHN0eWxlPSdmb250LXNpemU6MTAuMHB0O21z +by1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxzcGFuDQpzdHlsZT0nbXNvLWVsZW1lbnQ6ZmllbGQt +YmVnaW4nPjwvc3Bhbj4gUEFHRTxzcGFuIHN0eWxlPSdtc28tc3BhY2VydW46eWVzJz7CoMKgDQo8 +L3NwYW4+XCogTUVSR0VGT1JNQVQgPHNwYW4gc3R5bGU9J21zby1lbGVtZW50OmZpZWxkLXNlcGFy +YXRvcic+PC9zcGFuPjwvc3Bhbj48IVtlbmRpZl0tLT48c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0n +Zm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3Bhbg0Kc3R5bGU9 +J21zby1uby1wcm9vZjp5ZXMnPmlpaTwvc3Bhbj48L3NwYW4+PCEtLVtpZiBzdXBwb3J0RmllbGRz +XT48c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250 +LXNpemU6MTEuMHB0Jz48c3Bhbg0Kc3R5bGU9J21zby1lbGVtZW50OmZpZWxkLWVuZCc+PC9zcGFu +Pjwvc3Bhbj48IVtlbmRpZl0tLT48c3BhbiBsYW5nPUVOLUdCDQpzdHlsZT0nZm9udC1zaXplOjEw +LjBwdDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48bzpwPjwvbzpwPjwvc3Bhbj48L3A+DQo8 +L2Rpdj4NCg0KPGRpdiBzdHlsZT0nbXNvLWVsZW1lbnQ6Zm9vdGVyJyBpZD1lZjM+DQo8cCBjbGFz +cz1Nc29Gb290ZXIgc3R5bGU9J21hcmdpbi10b3A6MTIuMHB0O2xpbmUtaGVpZ2h0OjEyLjBwdDtt +c28tbGluZS1oZWlnaHQtcnVsZToNCmV4YWN0bHknPjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PGIg +c3R5bGU9J21zby1iaWRpLWZvbnQtd2VpZ2h0Om5vcm1hbCc+PHNwYW4NCmxhbmc9RU4tR0Igc3R5 +bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7bXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+PHNwYW4NCnN0 +eWxlPSdtc28tZWxlbWVudDpmaWVsZC1iZWdpbic+PC9zcGFuPjxzcGFuDQpzdHlsZT0nbXNvLXNw +YWNlcnVuOnllcyc+wqA8L3NwYW4+UEFHRTxzcGFuIHN0eWxlPSdtc28tc3BhY2VydW46eWVzJz7C +oMKgDQo8L3NwYW4+XCogTUVSR0VGT1JNQVQgPHNwYW4gc3R5bGU9J21zby1lbGVtZW50OmZpZWxk +LXNlcGFyYXRvcic+PC9zcGFuPjwvc3Bhbj48L2I+PCFbZW5kaWZdLS0+PGINCnN0eWxlPSdtc28t +YmlkaS1mb250LXdlaWdodDpub3JtYWwnPjxzcGFuIGxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQtc2l6 +ZToxMC4wcHQ7DQptc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3BhbiBzdHlsZT0nbXNvLW5v +LXByb29mOnllcyc+Mjwvc3Bhbj48L3NwYW4+PC9iPjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PGIN +CnN0eWxlPSdtc28tYmlkaS1mb250LXdlaWdodDpub3JtYWwnPjxzcGFuIGxhbmc9RU4tR0Igc3R5 +bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7DQptc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3BhbiBz +dHlsZT0nbXNvLWVsZW1lbnQ6ZmllbGQtZW5kJz48L3NwYW4+PC9zcGFuPjwvYj48IVtlbmRpZl0t +LT48c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250 +LXNpemU6MTEuMHB0Jz48c3Bhbg0Kc3R5bGU9J21zby10YWItY291bnQ6MSc+wqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoCA8L3NwYW4+wqkNClRo +ZSBDYWxlbmRhcmluZyBhbmQgU2NoZWR1bGluZyBDb25zb3J0aXVtLCBJbmMuJm5ic3A7MjAxOCZu +YnNwO+KAkyBBbGwgcmlnaHRzIHJlc2VydmVkPG86cD48L286cD48L3NwYW4+PC9wPg0KPC9kaXY+ +DQoNCjxkaXYgc3R5bGU9J21zby1lbGVtZW50OmZvb3RlcicgaWQ9ZWYzbD4NCjxwIGNsYXNzPU1z +b0Zvb3RlckxhbmRzY2FwZSBzdHlsZT0nbWFyZ2luLXRvcDoxMi4wcHQ7bGluZS1oZWlnaHQ6MTIu +MHB0O21zby1saW5lLWhlaWdodC1ydWxlOg0KZXhhY3RseSc+PCEtLVtpZiBzdXBwb3J0RmllbGRz +XT48YiBzdHlsZT0nbXNvLWJpZGktZm9udC13ZWlnaHQ6bm9ybWFsJz48c3Bhbg0KbGFuZz1FTi1H +QiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3Bh +bg0Kc3R5bGU9J21zby1lbGVtZW50OmZpZWxkLWJlZ2luJz48L3NwYW4+PHNwYW4NCnN0eWxlPSdt +c28tc3BhY2VydW46eWVzJz7CoDwvc3Bhbj5QQUdFPHNwYW4gc3R5bGU9J21zby1zcGFjZXJ1bjp5 +ZXMnPsKgwqANCjwvc3Bhbj5cKiBNRVJHRUZPUk1BVCA8c3BhbiBzdHlsZT0nbXNvLWVsZW1lbnQ6 +ZmllbGQtc2VwYXJhdG9yJz48L3NwYW4+PC9zcGFuPjwvYj48IVtlbmRpZl0tLT48Yg0Kc3R5bGU9 +J21zby1iaWRpLWZvbnQtd2VpZ2h0Om5vcm1hbCc+PHNwYW4gbGFuZz1FTi1HQiBzdHlsZT0nZm9u +dC1zaXplOjEwLjBwdDsNCm1zby1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxzcGFuIHN0eWxlPSdt +c28tbm8tcHJvb2Y6eWVzJz4yPC9zcGFuPjwvc3Bhbj48L2I+PCEtLVtpZiBzdXBwb3J0RmllbGRz +XT48Yg0Kc3R5bGU9J21zby1iaWRpLWZvbnQtd2VpZ2h0Om5vcm1hbCc+PHNwYW4gbGFuZz1FTi1H +QiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDsNCm1zby1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxz +cGFuIHN0eWxlPSdtc28tZWxlbWVudDpmaWVsZC1lbmQnPjwvc3Bhbj48L3NwYW4+PC9iPjwhW2Vu +ZGlmXS0tPjxzcGFuDQpsYW5nPUVOLUdCIHN0eWxlPSdmb250LXNpemU6MTAuMHB0O21zby1iaWRp +LWZvbnQtc2l6ZToxMS4wcHQnPjxzcGFuDQpzdHlsZT0nbXNvLXRhYi1jb3VudDoxJz7CoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgIDwvc3Bhbj7C +qQ0KVGhlIENhbGVuZGFyaW5nIGFuZCBTY2hlZHVsaW5nIENvbnNvcnRpdW0sIEluYy4mbmJzcDsy +MDE4Jm5ic3A74oCTIEFsbCByaWdodHMgcmVzZXJ2ZWQ8bzpwPjwvbzpwPjwvc3Bhbj48L3A+DQo8 +L2Rpdj4NCg0KPGRpdiBzdHlsZT0nbXNvLWVsZW1lbnQ6Zm9vdGVyJyBpZD1mMz4NCjxwIGNsYXNz +PU1zb0Zvb3RlciBzdHlsZT0nbGluZS1oZWlnaHQ6MTIuMHB0Jz48c3BhbiBsYW5nPUVOLUdCDQpz +dHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz7CqSBUaGUg +Q2FsZW5kYXJpbmcgYW5kIFNjaGVkdWxpbmcgQ29uc29ydGl1bSwgSW5jLiZuYnNwOzIwMTgmbmJz +cDvigJMgQWxsDQpyaWdodHMgcmVzZXJ2ZWQ8c3BhbiBzdHlsZT0nbXNvLXRhYi1jb3VudDoxJz7C +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgIDwv +c3Bhbj48L3NwYW4+PCEtLVtpZiBzdXBwb3J0RmllbGRzXT48Yg0Kc3R5bGU9J21zby1iaWRpLWZv +bnQtd2VpZ2h0Om5vcm1hbCc+PHNwYW4gbGFuZz1FTi1HQiBzdHlsZT0nZm9udC1zaXplOjEwLjBw +dDsNCm1zby1iaWRpLWZvbnQtc2l6ZToxMS4wcHQnPjxzcGFuIHN0eWxlPSdtc28tZWxlbWVudDpm +aWVsZC1iZWdpbic+PC9zcGFuPg0KUEFHRTxzcGFuIHN0eWxlPSdtc28tc3BhY2VydW46eWVzJz7C +oMKgIDwvc3Bhbj5cKiBNRVJHRUZPUk1BVCA8c3Bhbg0Kc3R5bGU9J21zby1lbGVtZW50OmZpZWxk +LXNlcGFyYXRvcic+PC9zcGFuPjwvc3Bhbj48L2I+PCFbZW5kaWZdLS0+PGINCnN0eWxlPSdtc28t +YmlkaS1mb250LXdlaWdodDpub3JtYWwnPjxzcGFuIGxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQtc2l6 +ZToxMC4wcHQ7DQptc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3BhbiBzdHlsZT0nbXNvLW5v +LXByb29mOnllcyc+Mzwvc3Bhbj48L3NwYW4+PC9iPjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PGIN +CnN0eWxlPSdtc28tYmlkaS1mb250LXdlaWdodDpub3JtYWwnPjxzcGFuIGxhbmc9RU4tR0Igc3R5 +bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7DQptc28tYmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3BhbiBz +dHlsZT0nbXNvLWVsZW1lbnQ6ZmllbGQtZW5kJz48L3NwYW4+PC9zcGFuPjwvYj48IVtlbmRpZl0t +LT48c3Bhbg0KbGFuZz1FTi1HQiBzdHlsZT0nZm9udC1zaXplOjEwLjBwdDttc28tYmlkaS1mb250 +LXNpemU6MTEuMHB0Jz48bzpwPjwvbzpwPjwvc3Bhbj48L3A+DQo8L2Rpdj4NCg0KPGRpdiBzdHls +ZT0nbXNvLWVsZW1lbnQ6Zm9vdGVyJyBpZD1mM2w+DQo8cCBjbGFzcz1Nc29Gb290ZXJMYW5kc2Nh +cGUgc3R5bGU9J2xpbmUtaGVpZ2h0OjEyLjBwdCc+PHNwYW4gbGFuZz1FTi1HQg0Kc3R5bGU9J2Zv +bnQtc2l6ZToxMC4wcHQ7bXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+wqkgVGhlIENhbGVuZGFy +aW5nIGFuZCBTY2hlZHVsaW5nIENvbnNvcnRpdW0sIEluYy4mbmJzcDsyMDE4Jm5ic3A74oCTIEFs +bA0KcmlnaHRzIHJlc2VydmVkPHNwYW4gc3R5bGU9J21zby10YWItY291bnQ6MSc+wqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDC +oMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKg +wqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoMKgwqDCoCA8L3NwYW4+PC9z +cGFuPjwhLS1baWYgc3VwcG9ydEZpZWxkc10+PGINCnN0eWxlPSdtc28tYmlkaS1mb250LXdlaWdo +dDpub3JtYWwnPjxzcGFuIGxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7DQptc28t +YmlkaS1mb250LXNpemU6MTEuMHB0Jz48c3BhbiBzdHlsZT0nbXNvLWVsZW1lbnQ6ZmllbGQtYmVn +aW4nPjwvc3Bhbj4NClBBR0U8c3BhbiBzdHlsZT0nbXNvLXNwYWNlcnVuOnllcyc+wqDCoCA8L3Nw +YW4+XCogTUVSR0VGT1JNQVQgPHNwYW4NCnN0eWxlPSdtc28tZWxlbWVudDpmaWVsZC1zZXBhcmF0 +b3InPjwvc3Bhbj48L3NwYW4+PC9iPjwhW2VuZGlmXS0tPjxiDQpzdHlsZT0nbXNvLWJpZGktZm9u +dC13ZWlnaHQ6bm9ybWFsJz48c3BhbiBsYW5nPUVOLUdCIHN0eWxlPSdmb250LXNpemU6MTAuMHB0 +Ow0KbXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+PHNwYW4gc3R5bGU9J21zby1uby1wcm9vZjp5 +ZXMnPjM8L3NwYW4+PC9zcGFuPjwvYj48IS0tW2lmIHN1cHBvcnRGaWVsZHNdPjxiDQpzdHlsZT0n +bXNvLWJpZGktZm9udC13ZWlnaHQ6bm9ybWFsJz48c3BhbiBsYW5nPUVOLUdCIHN0eWxlPSdmb250 +LXNpemU6MTAuMHB0Ow0KbXNvLWJpZGktZm9udC1zaXplOjExLjBwdCc+PHNwYW4gc3R5bGU9J21z +by1lbGVtZW50OmZpZWxkLWVuZCc+PC9zcGFuPjwvc3Bhbj48L2I+PCFbZW5kaWZdLS0+PHNwYW4N +Cmxhbmc9RU4tR0Igc3R5bGU9J2ZvbnQtc2l6ZToxMC4wcHQ7bXNvLWJpZGktZm9udC1zaXplOjEx +LjBwdCc+PG86cD48L286cD48L3NwYW4+PC9wPg0KPC9kaXY+DQoNCjwvYm9keT4NCg0KPC9odG1s +Pg0K + +------=_NextPart_81178210.676e.4040-- \ No newline at end of file diff --git a/documents/cc-51006.html b/documents/cc-51006.html new file mode 100644 index 0000000..2abdf42 --- /dev/null +++ b/documents/cc-51006.html @@ -0,0 +1,3868 @@ + + + + Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component + + + + + + + + + + + + + + + + +
+

Committee Draft

+
+ +
+

CalConnect Standard

+
+ +
+ +
+ + +
+
+ +
+
+ CC/CD 51006:2018 + +
+ +
+ Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component + +
+
+ + + +
+ TC FREEBUSY +
+ + + + + +
+ +
+ + + Eric YorkAuthor + + Cyrus DabooAuthor + + Michael DouglassAuthor + +
+ +
+ + +
+
+ +
+
+ CalConnect Standard +
+ +
+ Committee Draft +
+ + +
+
+

Warning for Drafts

+ +

This document is not a CalConnect Standard. It is distributed for review and + comment, and is subject to change without notice and may not be referred to as + a Standard. Recipients of this draft are invited to submit, with their + comments, notification of any relevant patent rights of which they are aware + and to provide supporting documentation. +

+
+
+
+ + + + +
+
+
+
+ +

 

+
+
+
+ + +
+ +

 

+
+
+
+
+ + + + + + + + + +
+
+
+

Foreword

+

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+

The Calendaring and Scheduling Consortium (“CalConnect”) is a global +non-profit organization with the aim to facilitate interoperability of +collaborative technologies and tools through open standards.

+

CalConnect works closely with international and regional partners, +of which the full list is available on our website +(https://www.calconnect.org/about/liaisons-and-relationships).

+

The procedures used to develop this document and those intended for its +further maintenance are described in the CalConnect Directives.

+

In particular the different approval criteria needed for the different +types of CalConnect documents should be noted. This document was drafted in +accordance with the editorial rules of the CalConnect Directives.

+

Attention is drawn to the possibility that some of the elements of this +document may be the subject of patent rights. CalConnect shall not be +held responsible for identifying any or all such patent rights. Details +of any patent rights identified during the development of the document +will be provided in the Introduction.

+

Any trade name used in this document is information given for the +convenience of users and does not constitute an endorsement.

+

This document was prepared by Technical Committee +FREEBUSY.

+
+
+
+

Introduction

+

The currently existing approach to agreeing on meeting times using +iTip RFC 5546 and/or iMip RFC 6047 has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement — up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+
+

Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component

+
+

1.  Scope

+

This document provides a mechanism in iCalendar for consensus scheduling.

+
+

2.  Normative references

The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

IETF RFC 2518, HTTP Extensions for Distributed Authoring — WEBDAV

IETF RFC 3986, Uniform Resource Identifier (URI): Generic Syntax

IETF RFC 4791, Calendaring Extensions to WebDAV (CalDAV)

IETF RFC 5545, Internet Calendaring and Scheduling Core Object Specification (iCalendar)

IETF RFC 5546, iCalendar Transport-Independent Interoperability Protocol (iTIP)

IETF RFC 6047, iCalendar Message-Based Interoperability Protocol (iMIP)

IETF RFC 6638, Scheduling Extensions to CalDAV

IETF I-D.ietf-calext-eventpub-extensions, Event Publishing Extensions to iCalendar

+

3.  Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

3.1. 

consensus scheduling

+ +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+

3.2. 

active Vpoll

+ +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+

3.3. 

voter

+ +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+
+

4.  Simple Consensus Scheduling

+

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+

4.1.  The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+

DTSTAMP

+

The usual RFC 5545 property.

+

SEQUENCE

+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+

UID

+

The usual RFC 5545 property.

+

ORGANIZER

+

The usual RFC 5545 property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+

SUMMARY

+

The usual RFC 5545 property. This optional but +recommended property provides the a short title to the poll.

+

DESCRIPTION

+

The usual RFC 5545 property. This optional property +provides more details.

+

DTEND

+

The usual RFC 5545 property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+

POLL-MODE

+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value “BASIC” +meaning one event will be chosen from the alternatives.

+

POLL-COMPLETION

+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is “SERVER-SUBMIT” which means the client chooses the winner +but the server will submit the winning choice.

+

POLL-PROPERTIES

+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value “DTSTART, LOCATION” meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+

PARTICIPANT

+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to “VOTER”. The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+

VOTE

+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+

VEVENT

+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+

EXAMPLE

VPOLL with 3 voters and 3 alternative meetings:

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD:REQUEST
BEGIN:VPOLL
POLL-MODE:BASIC
POLL-COMPLETION:SERVER-SUBMIT
POLL-PROPERTIES:DTSTART,LOCATION
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T000000Z
SUMMARY:What to do this week
DTEND:20120101T000000Z
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
END PARTICIPANT
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
END PARTICIPANT
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:mike@example.com
END PARTICIPANT
BEGIN:VEVENT.......(with a poll-item-id=1)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=2)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=3)
END:VEVENT
END:VPOLL
END:VCALENDAR
+
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+

4.2.  The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard RFC 5545 components. For our +simple use case they are all VEVENT components. In addition to the +usual RFC 5545 properties some extra properties are used for a +VPOLL.

+

POLL-ITEM-ID

+

This provides a unique reference to the sub-component +within the VPOLL. It’s value SHOULD be a small integer.

+
+

4.3.  VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+

DTSTAMP

+

The usual RFC 5545 property.

+

SEQUENCE

+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+

UID

+

Same as the request.

+

ORGANIZER

+

Same as the request.

+

SUMMARY

+

Same as the request.

+

PARTICIPANT

+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+

VOTE

+

One per item being voted on.

+

POLL-ITEM-ID

+

One inside each VOTE component to identify the choice.

+

RESPONSE

+

One inside each VOTE component to specify the vote.

+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+

NOTE

+

This is poll-mode specific behavior?

+
+

EXAMPLE

REPLY VPOLL from Cyrus:

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: REPLY
BEGIN:VPOLL
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T010000Z
SUMMARY:What to do this week
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
BEGIN:VOTE
POLL-ITEM-ID:1
RESPONSE:50
COMMENT:Work on iTIP
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
COMMENT:Work on WebDAV
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
END:VPOLL
END:VCALENDAR
+
+

4.4.  VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+

EXAMPLE

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: POLLSTATUS
BEGIN:VPOLL
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T020000Z
SEQUENCE:0
SUMMARY:What to do this week
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
BEGIN: VOTE
POLL-ITEM-ID:1
RESPONSE:50
COMMENT:Work on iTIP
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
COMMENT:Work on WebDAV
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
BEGIN:VOTE
POLL-ITEM-ID:1
RESPONSE:100
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
END:VPOLL
END:VCALENDAR
+
+

4.5.  VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +“SUBMITTED”.

+

EXAMPLE

VPOLL confirmation:

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: REQUEST
BEGIN:VPOLL
ORGANIZER:mailto:douglm@example.com
UID:sched01-1234567890
DTSTAMP:20120101T030000Z
COMPLETED:20120101T030000Z
POLL-COMPLETION:SERVER-SUBMIT
SEQUENCE:0
SUMMARY:What to do this week
STATUS:CONFIRMED
POLL-WINNER:3
BEGIN:VEVENT.......(with a poll-item-id=1)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=2)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=3)
END:VEVENT
END:VPOLL
END:VCALENDAR
+
+

4.6.  Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+
+
+

5.  iCalendar Extensions

+

5.1.  Updated Participant Type Value

Participant type property values are defined in section 11.2.1. of +I-D.ietf-calext-eventpub-extensions. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+
partvalue       /= "VOTER"

Figure 1

+ +

Description

+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+

5.2.  Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +RFC 5545. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+
reltypeparam       /= "RELTYPE" "=" "POLL"
; Property value is a VPOLL uid

Figure 2

+ +

Description

+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+

5.3.  Updated Status Value

Status property values are defined in section 3.8.1.11. of RFC 5545. +This specification updates that type to define valid VPOLL status +values.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+
statvalue /= statvalue-poll
   ; Status values for "VPOLL".
statvalue-poll = "IN-PROCESS"
          / "COMPLETED"  ; Poll has closed,
                         ; nothing has been chosen yet
          / "CONFIRMED"  ; Poll has closed and
                         ; winning items confirmed
          / "SUBMITTED"  ; The winning item has been
                         ; submitted
          / "CANCELLED"

Figure 3

+ +

Description

+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+

Figure 4

+
+

5.4.  New Property Parameters

5.4.1.  Required

Parameter name

+

REQUIRED

+

Purpose

+

To specify whether the associated property is required in +the current context.

+

Format Definition

+

This parameter is defined by the following notation:

+
+
requirededparam = "REQUIRED"  "=" ("TRUE" / "FALSE")
  ; Default is FALSE

Figure 5

+ +

Description

+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+

5.4.2.  Stay-Informed

Parameter name

+

STAY-INFORMED

+

Purpose

+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+

Format Definition

+

This parameter is defined by the following notation:

+
+
stayinformedparam = "STAY-INFORMED"  "=" ("TRUE" / "FALSE")
                  ; Default is FALSE

Figure 6

+ +

Description

+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+

5.5.  New Properties

5.5.1.  Accept-Response

Property name

+

ACCEPT-RESPONSE

+

Purpose

+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+

Format Definition

+

This property is defined by the following notation:

+
+
acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":"
                    iana-token ("," iana-token) CRLF

acceptresponseparams = *(";" other-param)

Figure 7

+
+

5.5.2.  Poll-Completion

Property name

+

POLL-COMPLETION

+

Purpose

+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+

Description

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

Format Definition

+

This property is defined by the following notation:

+
+
poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF

pcparam = *(";" other-param)

pcvalue = "SERVER"  ; The server is responsible for both choosing and
                   ; submitting the winner(s)
        / "SERVER-SUBMIT" ; The server is responsible for
                   ; submitting the winner(s). The client chooses.
        / "SERVER-CHOICE"  ; The server is responsible for
                   ; choosing the winner(s). The client will submit.
        / "CLIENT" ; The client is responsible for both choosing and
                   ; submitting the winner(s)
        / iana-token
        / x-name
        ;Default is CLIENT

Figure 8

+ +

Example

+

The following is an example of this property:

+
+
POLL-COMPLETION: SERVER-SUBMIT

Figure 9

+
+

5.5.3.  Poll-Item-Id

Property name

+

POLL-ITEM-ID

+

Purpose

+

This property is used in VPOLL child components as an +identifier.

+

Value type

+

INTEGER

+

Property Parameters

+

Non-standard parameters can be specified on +this property.

+

Conformance

+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+

Description

+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollitemid = "POLL-ITEM-ID" pollitemdparams ":"
                  integer CRLF

pollitemidparams = *(
                   (";" other-param)
            )

Figure 10

+
+

5.5.4.  Poll-Mode

Property name

+

POLL-MODE

+

Purpose

+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component or +its sub-components.

+

Description

+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollmode = "POLL-MODE" pollmodeparams ":"
             ("BASIC" / iana-token / other-token) CRLF

pollmodeparams = *(";" other-param)

Figure 11

+
+

5.5.5.  Poll-properties

Property name

+

POLL-PROPERTIES

+

Purpose

+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollproperties = "POLL-PROPERTIES" pollpropparams ":"
             text *("," text) CRLF

pollpropparams = *(";" other-param)

Figure 12

+
+

5.5.6.  Poll-Winner

Property name

+

POLL-WINNER

+

Purpose

+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+

Value type

+

INTEGER

+

Property Parameters

+

Non-standard parameters can be specified on +this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollwinner = "POLL-WINNER" pollwinnerparams ":"
                 integer CRLF

pollwinnerparams = *(";" other-param)

       ; Used with a STATUS:CONFIRMED VPOLL to indicate which
       ; components have been confirmed

Figure 13

+
+

5.5.7.  Reply-URL

Property name

+

REPLY-URL

+

Purpose

+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+

Property Parameters

+

Non-standard, required or iana parameters can +be specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+

Format Definition

+

This property is defined by the following notation:

+
+
reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF

reply-urlparams = *(
                  (";" requiredparam) /
                  (";" other-param)
                  )

Figure 14

+
+

5.5.8.  Response

Property name

+

RESPONSE

+

Purpose

+

To specify a response vote.

+

Value type

+

INTEGER

+

Format Definition

+

This property is defined by the following notation:

+
+
response = "RESPONSE" response-params ":" integer CRLF
                 ; integer value 0..100

responseparams = *(";" other-param)

Figure 15

+ +

Description

+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 — 39 A “NO vote”

    +
  • +
  • +

    40 — 79 A “MAYBE” vote

    +
  • +
  • +

    80 — 89 A “YES — but not preferred vote”

    +
  • +
  • +

    90-100 A “YES” vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+

5.6.  New Components

5.6.1.  VPOLL Component

Component name

+

VPOLL

+

Purpose

+

This component provides a mechanism by which voters can +vote on provided choices.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollc    = "BEGIN" ":" "VPOLL" CRLF
            pollprop
            *participantc *eventc *todoc *journalc *freebusyc
            *availabilityc *alarmc *iana-comp *x-comp
            "END" ":" "VPOLL" CRLF

pollprop = *(
          ;
          ; The following are REQUIRED,
          ; but MUST NOT occur more than once.
          ;
          dtstamp / uid / organizer /
          ;
          ; The following are OPTIONAL,
          ; but MUST NOT occur more than once.
          ;
          acceptresponse / class / created / completed /
          description / dtstart / last-mod / pollmode /
          pollproperties / priority / seq / status /
          summary / url /
          ;
          ; Either 'dtend' or 'duration' MAY appear in
          ; a 'pollprop', but 'dtend' and 'duration'
          ; MUST NOT occur in the same 'pollprop'.
          ; 'duration' MUST only occur when 'dtstart'
          ; is present
          ;
          dtend / duration /
          ;
          ; The following are OPTIONAL,
          ; and MAY occur more than once.
          ;
          attach / categories / comment /
          contact / rstatus / related /
          resources / x-prop / iana-prop
          ;
          ; The following is OPTIONAL, it SHOULD appear
          ; once for the confirmation of a BASIC mode
          ; VPOLL. Other modes may define differing
          ; requirements.
          ;
          pollwinner /
          ;
          )

Figure 16

+ +

Description

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting — both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the “DTSTART” property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If “DTSTART” is present “DURATION” MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

“DTEND” MAY be specified with or without “DTSTART” and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+

5.6.2.  VOTE Component

Component name

+

VOTE

+

Purpose

+

This component provides a mechanism by which voters can +vote on provided choices.

+

Conformance

+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+

Format Definition

+

This property is defined by the following notation:

+
+
votec     = "BEGIN" ":" "VOTE" CRLF
            voteprop
            *eventc *todoc *journalc *freebusyc
            *availabilityc *alarmc *iana-comp *x-comp
            "END" ":" "VOTE" CRLF

voteprop = *(
           ;
           ; The following are REQUIRED,
           ; but MUST NOT occur more than once.
           ;
           pollitemid / response /
           ;
           ; The following are OPTIONAL,
           ; and MAY occur more than once.
           ;
           comment / x-prop / iana-prop
           ;
           )

Figure 17

+ +

Description

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER — such as the respondees +availability.

+
+
+

6.  Poll Modes

+

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see Clause 10.3) in a published RFC.

+

6.1.  POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+

6.1.1.  Property restrictions

This poll mode has the following property requirements:

+

POLL-ITEM-ID

+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+

POLL-WINNER

+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+

6.1.2.  Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+
+
+

7.  iTIP Extensions

+

This specification introduces a number of extensions to RFC 5546. +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+

7.1.  Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+

Table 1

MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+

Table 2

OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+

7.2.  Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+

7.2.1.  Delegation

+ +

TBD

+
+

7.2.2.  Acting on Behalf of Other Calendar Users

+ +

TBD

+
+

7.2.3.  Component Revisions

+ +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter — no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component — bump sequence

    +
  • +
+
+

7.2.4.  Message Sequencing

+ +

TBD

+
+

7.3.  Application Protocol Elements

7.3.1.  Methods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the “VPOLL” calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+

Table 3

Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the “VPOLL” +calendar component.

+

Table 4

MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+

7.3.2.  Method: PUBLISH

The “PUBLISH” method in a “VPOLL” calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The “Organizer” MUST be present in a +published iCalendar component. “Voters” MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The “Organizer” may subsequently update (with another +“PUBLISH” method) or cancel (with a “CANCEL” method) a previously +published “VPOLL” calendar component.

+

Note

+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 5 — Constraints for a METHOD:PUBLISH of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0 or 1

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0 or 1

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to “VOTER” — that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0+

+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

7.3.3.  Method: REQUEST

The “REQUEST” method in a “VPOLL” component provides the following +scheduling functions:

+
    +
  • +

    Invite “Voters” to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a “REFRESH” request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of “Voters”.

    +
  • +
  • +

    Forward a “VPOLL” to another uninvited CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, delegate the role of +“Voter” to another CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, change the role of +“Organizer” to another CU.

    +
  • +
+

The “Organizer” originates the “REQUEST”. The recipients of the +“REQUEST” method are the CUs voting in the poll, the “Voters”. +“Voters” use the “REPLY” method to convey votes to the “Organizer”.

+

The “UID” and “SEQUENCE” properties are used to distinguish the +various uses of the “REQUEST” method. If the “UID” property value in +the “REQUEST” is not found on the recipient’s calendar, then the +“REQUEST” is for a new “VPOLL” calendar component. If the “UID” +property value is found on the recipient’s calendar, then the +“REQUEST” is for an update, or a reconfirmation of the “VPOLL” +calendar component.

+

For the “REQUEST” method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 6 — Constraints for a METHOD:REQUEST of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0 or 1

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

VALARM

+
+

0+

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

7.3.3.1.  Rescheduling a poll

+ +

The “REQUEST” method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a “REQUEST” method finds that the “UID” +property value already exists on the calendar but that the “SEQUENCE” +(or “DTSTAMP”) property value in the “REQUEST” method is greater than +the value for the existing poll, then the “REQUEST” method describes +a rescheduling of the poll.

+
+

7.3.3.2.  Updating or Reconfirmation of a Poll

The “REQUEST” method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a “REQUEST” method +finds that the “UID” property value already exists on the calendar +and that the “SEQUENCE” property value in the “REQUEST” is the same +as the value for the existing poll, then the “REQUEST” method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update “REQUEST” method is the appropriate response to a +“REFRESH” method sent from a “Voter” to the “Organizer” of a poll.

+

The “Organizer” of a poll may also send unsolicited “REQUEST” +methods. The unsolicited “REQUEST” methods may be used to update the +details of the poll without rescheduling it, to update the “RESPONSE” +parameter of “Voters”, or to reconfirm the poll.

+

7.3.3.3.  Confirmation of a Poll

+ +

The “REQUEST” method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+

7.3.3.4.  Closing a Poll

+ +

The “REQUEST” method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+

7.3.3.5.  Delegating a Poll to Another CU

Some calendar and scheduling systems allow “Voters” to delegate the +vote to another “Calendar User”. iTIP supports this concept using the +following workflow. Any “Voter” may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original “Voter”, NOT in addition to the +“Voter”. The delegator MUST notify the “Organizer” of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a “REQUEST” +to another CU.

+

The “Delegator” of a poll forwards the existing “REQUEST” to the +“Delegate”. The “REQUEST” method MUST include a “Voter” property +with the calendar address of the “Delegate”. The “Delegator” MUST +also send a “REPLY” method to the “Organizer” with the “Delegator’s” +“Voter” property “DELEGATED-TO” parameter set to the calendar address +of the “Delegate”. Also, a new “Voter” property for the “Delegate” +MUST be included and must specify the calendar user address set in +the “DELEGATED-TO” parameter, as above.

+

In response to the request, the “Delegate” MUST send a “REPLY” method +to the “Organizer”, and optionally to the “Delegator”. The “REPLY”

+

method SHOULD include the “Voter” property with the “DELEGATED-FROM” +parameter value of the “Delegator’s” calendar address.

+

The “Delegator” may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +“Delegator” setting their “role” attribute to “NON-PARTICIPANT” in +the “REPLY” to the “Organizer”.

+

7.3.3.6.  Changing the Organizer

+ +

The situation may arise where the “Organizer” of a “VPOLL” is no +longer able to perform the “Organizer” role and abdicates without +passing on the “Organizer” role to someone else. When this occurs, +the “Voters” of the “VPOLL” may use out-of-band mechanisms to +communicate the situation and agree upon a new “Organizer”. The new +“Organizer” should then send out a new “REQUEST” with a modified +version of the “VPOLL” in which the “SEQUENCE” number has been +incremented and the “ORGANIZER” property has been changed to the new +“Organizer”.

+
+

7.3.3.7.  Sending on Behalf of the Organizer

+ +

There are a number of scenarios that support the need for a “Calendar +User” to act on behalf of the “Organizer” without explicit role +changing. This might be the case if the CU designated as “Organizer” +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the “SENT-BY” parameter, a “Calendar User” could +send an updated “VPOLL” “REQUEST”. In the case where one CU sends on +behalf of another CU, the “Voter” responses are still directed back +towards the CU designated as “Organizer”.

+
+

7.3.3.8.  Forwarding to an Uninvited CU

A “Voter” invited to a “VPOLL” calendar component may send the +“VPOLL” calendar component to another new CU not previously +associated with the “VPOLL” calendar component. The current “Voter” +participating in the “VPOLL” calendar component does this by +forwarding the original “REQUEST” method to the new CU. The new CU +can send a “REPLY” to the “Organizer” of the “VPOLL” calendar +component. The reply contains a “Voter” property for the new CU.

+

The “Organizer” ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a “REPLY” +from a new (uninvited) CU. If the “Organizer” does not want the new +CU to be part of the poll, the new “Voter” property is not added to +the “VPOLL” calendar component. The “Organizer” MAY send the CU a +“CANCEL” message to indicate that they will not be added to the poll.

+

If the “Organizer” decides to add the new CU, the new “Voter” +property is added to the “VPOLL” calendar component. Furthermore, +the “Organizer” is free to change any “Voter” property parameter from +the values supplied by the new CU to something the “Organizer” +considers appropriate. The “Organizer” SHOULD send the new CU a +“REQUEST” message to inform them that they have been added.

+

When forwarding a “REQUEST” to another CU, the forwarding “Voter” +MUST NOT make changes to the original message.

+

7.3.3.9.  Updating Voter Status

+ +

The “Organizer” of an poll may also request updated status from one +or more “Voters”. The “Organizer” sends a “REQUEST” method to the +“Voter” and sets the “RSVP=TRUE” property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +“SEQUENCE” property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +“REQUEST” is that their “RSVP” property parameter indicates a request +for updated status. The recipient SHOULD respond with a “REPLY” +method indicating their current vote with respect to the “REQUEST”.

+
+

7.3.4.  Method: REPLY

The “REPLY” method in a “VPOLL” calendar component is used to respond +(e.g., accept or decline) to a “REQUEST” or to reply to a delegation +“REQUEST”. When used to provide a delegation response, the +“Delegator” SHOULD include the calendar address of the “Delegate” on +the “DELEGATED-TO” property parameter of the “Delegator’s” “CALENDAR-ADDRESS” +property. The “Delegate” SHOULD include the calendar address of the +“Delegator” on the “DELEGATED-FROM” property parameter of the +“Delegate’s” “CALENDAR-ADDRESS” property.

+

The “REPLY” method is also used when processing of a “REQUEST” fails. +Depending on the value of the “REQUEST-STATUS” property, no action +may have been performed.

+

The “Organizer” of a poll may receive the “REPLY” method from a CU +not in the original “REQUEST”. For example, a “REPLY” may be +received from a “Delegate” to a poll. In addition, the “REPLY” +method may be received from an unknown CU (a “Party Crasher”). This +uninvited “Voter” may be accepted, or the “Organizer” may cancel the +poll for the uninvited “Voter” by sending a “CANCEL” method to the +uninvited “Voter”.

+

A “Voter” MAY include a message to the “Organizer” using the +“COMMENT” property. For example, if the user indicates a low +interest and wants to let the “Organizer” know why, the reason can be +expressed in the “COMMENT” property value.

+

The “Organizer” may also receive a “REPLY” from one CU on behalf of +another. Like the scenario enumerated above for the “Organizer”, +“Voters” may have another CU respond on their behalf. This is done +using the “SENT-BY” parameter.

+

The optional properties listed in the table below (those listed as +“0+” or “0 or 1”) MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 7 — Constraints for a METHOD:REPLY of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

REQUEST-STATUS

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

SUMMARY

+
+

0 or 1

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+

VTODO

+
+

0

+
+

7.3.5.  Method: CANCEL

The “CANCEL” method in a “VPOLL” calendar component is used to send a +cancellation notice of an existing poll request to the affected +“Voters”. The message is sent by the “Organizer” of the poll.

+

The “Organizer” MUST send a “CANCEL” message to each “Voter” affected +by the cancellation. This can be done using a single “CANCEL” +message for all “Voters” or by using multiple messages with different +subsets of the affected “Voters” in each.

+

When a “VPOLL” is cancelled, the “SEQUENCE” property value MUST be +incremented as described in Clause 7.2.3.

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 8 — Constraints for a METHOD:CANCEL of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

SEQUENCE

+
+

1

+
+

ATTACH

+
+

0+

+
+

ACCEPT-RESPONSE

+
+

0

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VTODO

+
+

0

+
+

VJOURNAL

+
+

0

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0

+
+

7.3.6.  Method: REFRESH

The “REFRESH” method in a “VPOLL” calendar component is used by +“Voters” of an existing event to request an updated description from +the poll “Organizer”. The “REFRESH” method must specify the “UID” +property of the poll to update. The “Organizer” responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 9 — Constraints for a METHOD:REFRESH of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

ACCEPT-RESPONSE

+
+

0

+
+

ATTACH

+
+

0

+
+

CATEGORIES

+
+

0

+
+

CLASS

+
+

0

+
+

CONTACT

+
+

0

+
+

CREATED

+
+

0

+
+

DESCRIPTION

+
+

0

+
+

DTEND

+
+

0

+
+

DTSTART

+
+

0

+
+

DURATION

+
+

0

+
+

GEO

+
+

0

+
+

LAST-MODIFIED

+
+

0

+
+

LOCATION

+
+

0

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0

+
+

RELATED-TO

+
+

0

+
+

REQUEST-STATUS

+
+

0

+
+

RESOURCES

+
+

0

+
+

SEQUENCE

+
+

0

+
+

STATUS

+
+

0

+
+

SUMMARY

+
+

0

+
+

URL

+
+

0

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0+

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VTODO

+
+

0

+
+

VJOURNAL

+
+

0

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0

+
+

7.3.7.  Method: POLLSTATUS

The “POLLSTATUS” method in a “VPOLL” calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The “Organizer” MUST be present in the confirmed poll +component. All “Voters” MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 10 — Constraints for a METHOD:POLLSTATUS of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

ORGANIZER

+
+

1

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+

ATTACH

+
+

0

+
+

CATEGORIES

+
+

0

+
+

CLASS

+
+

0

+
+

COMMENT

+
+

0+

+
+

CONTACT

+
+

0

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0+

+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+
+
+

8.  CalDAV Extensions

+

This specification extends RFC 4791 in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends RFC 6638 as it a VPOLL component is a +schedulable entity.

+

8.1.  Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+

8.1.1.  CALDAV:supported-vpoll-component-sets

Name

+

supported-vpoll-component-sets

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition Clause 8.2 being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

Definition

+
<!ELEMENT supported-vpoll-component-sets
     (supported-vpoll-component-set*) >

<!ELEMENT supported-vpoll-component-set (comp+)>

Figure 18

+ +
<C:supported-vpoll-component-sets
     xmlns:C="urn:ietf:params:xml:ns:caldav">

  <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
    <C:comp name="VFREEBUSY" />
    <C:comp name="VTODO" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VEVENT or VFREEBUSY -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
    <C:comp name="VFREEBUSY" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VEVENT -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VTODO -->
  <C:supported-vpoll-component-set>
    <C:comp name="VTODO" />
  </C:supported-vpoll-component-set>
</C:supported-vpoll-component-sets>

Figure 19

+
+

8.1.2.  CALDAV:vpoll-max-items

Name

+

vpoll-max-items

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+

Definition

+
<!ELEMENT vpoll-max-items (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 20

+ +
<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-items>

Figure 21

+
+

8.1.3.  CALDAV:vpoll-max-active

Name

+

vpoll-max-active

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+

Definition

+
<!ELEMENT vpoll-max-active (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 22

+ +
<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-active>

Figure 23

+
+

8.1.4.  CALDAV:vpoll-max-voters

Name

+

+vpoll-max-voters +

+

Namespace

+

+urn:ietf:params:xml:ns:caldav +

+

Purpose

+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition Clause 8.2 +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+

Definition

+
<!ELEMENT vpoll-max-voters (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 24

+ +
<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-voters>

Figure 25

+
+

8.1.5.  CalDAV:even-more-properties

+ +
+

8.1.6.  Extensions to CalDAV scheduling

This specification extends RFC 6638.

+

Each section of Appendix A “Scheduling Privileges Summary” is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+

8.2.  Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+

(CALDAV:supported-vpoll-component-sets)

+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+

(CALDAV:vpoll-max-items)

+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value Clause 8.1.2 +on the calendar collection where the resource will be stored;

+

(CALDAV:vpoll-max-active)

+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value +Clause 8.1.3 on the calendar collection where the resource will +be stored;

+

(CALDAV:vpoll-max-voters)

+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value Clause 8.1.4 on the +calendar collection where the resource will be stored;

+
+

8.3.  CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+

8.3.1.  Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+
>> Request <<

REPORT /cyrus/work/ HTTP/1.1
Host: cal.example.com
Depth: 1
Content-Type: application/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<C:calendar-query xmlns:D="DAV:"
              xmlns:C="urn:ietf:params:xml:ns:caldav">
  <D:prop>
    <D:getetag/>
    <C:calendar-data>
      <C:comp name="VCALENDAR">
        <C:prop name="VERSION"/>
        <C:comp name="VPOLL">
          <C:prop name="SUMMARY"/>
          <C:prop name="UID"/>
          <C:prop name="DTSTART"/>
          <C:prop name="DTEND"/>
          <C:prop name="DURATION"/>
        </C:comp>

      </C:comp>
    </C:calendar-data>
  </D:prop>
  <C:filter>
    <C:comp-filter name="VCALENDAR">
      <C:comp-filter name="VPOLL">
        <C:time-range start="20121204T000000Z"
                      end="20121205T000000Z"/>
      </C:comp-filter>
    </C:comp-filter>
  </C:filter>
</C:calendar-query>

>> Response <<

HTTP/1.1 207 Multi-Status
Date: Sat, 11 Nov 2012 09:32:12 GMT
Content-Type: application/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:"
           xmlns:C="urn:ietf:params:xml:ns:caldav">
  <D:response>
    <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href>
    <D:propstat>
      <D:prop>
        <D:getetag>"fffff-abcd2"</D:getetag>
        <C:calendar-data>BEGIN:VCALENDAR
VERSION:2.0
BEGIN:VPOLL
DTSTART;TZID=US/Eastern:20121202T120000
DURATION:PT4D
SUMMARY:Poll #2
UID:00959BC664CA650E933C892C@example.com
END:VPOLL
END:VCALENDAR
</C:calendar-data>
      </D:prop>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
  <D:response>
    <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href>
    <D:propstat>
      <D:prop>
        <D:getetag>"fffff-abcd3"</D:getetag>
        <C:calendar-data>BEGIN:VCALENDAR

VERSION:2.0
PRODID:-//Example Corp.//CalDAV Client//EN
BEGIN:VPOLL
DTSTART;TZID=US/Eastern:20121204T100000
DURATION:PT4D
SUMMARY:Poll #3
UID:DC6C50A017428C5216A2F1CD@example.com
END:VPOLL
END:VCALENDAR
</C:calendar-data>
      </D:prop>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
</D:multistatus>

Figure 26

+
+

8.4.  CalDAV time ranges

“CALDAV:time-range XML Element” in RFC 4791, Section 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends RFC 4791 to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

+
+-------------------------------------------------------------------+
| VPOLL has the DTSTART property?                                   |
|   +---------------------------------------------------------------+
|   |   VPOLL has the DURATION property?                            |
|   |   +-----------------------------------------------------------+
|   |   | VPOLL has the DTEND property?                             |
|   |   |   +-------------------------------------------------------+
|   |   |   | VPOLL has the COMPLETED property?                     |
|   |   |   |   +---------------------------------------------------+
|   |   |   |   | VPOLL has the CREATED property?                   |
|   |   |   |   |   +-----------------------------------------------+
|   |   |   |   |   | Condition to evaluate                         |
+---+---+---+---+---+-----------------------------------------------+
| Y | Y | N | * | * | (start  <= DTSTART+DURATION)  AND             |
|   |   |   |   |   | ((end   >  DTSTART)  OR                       |
|   |   |   |   |   |  (end   >= DTSTART+DURATION))                 |
+---+---+---+---+---+-----------------------------------------------+
| Y | N | Y | * | * | ((start <  DTEND)    OR  (start <= DTSTART))  |
|   |   |   |   |   | AND                                           |
|   |   |   |   |   | ((end   >  DTSTART)  OR  (end   >= DTEND))    |
+---+---+---+---+---+-----------------------------------------------+
| Y | N | N | * | * | (start  <= DTSTART)  AND (end >  DTSTART)     |
+---+---+---+---+---+-----------------------------------------------+
| N | N | Y | * | * | (start  <  DTEND)    AND (end >= DTEND)       |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | Y | Y | ((start <= CREATED)  OR  (start <= COMPLETED))|
|   |   |   |   |   | AND                                           |
|   |   |   |   |   | ((end   >= CREATED)  OR  (end   >= COMPLETED))|
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | Y | N | (start  <= COMPLETED) AND (end  >= COMPLETED) |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | N | Y | (end    >  CREATED)                           |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | N | N | TRUE                                          |
+---+---+---+---+---+-----------------------------------------------+

Figure 27

+
+
+
+

9.  Security Considerations

+

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See RFC 3986 for a +discussion of the security considerations relating to URIs.

+
+
+

10.  IANA Considerations

+

10.1.  Parameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in RFC 5545, Section 8.2.4:

+

Table 11

Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+Clause 5.4.1 +

+
+

STAY-INFORMED

+
+

Current

+
+

+Clause 5.4.2 +

+
+

10.2.  Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in RFC 5545, Section 8.2.3:

+

Table 12

PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+Clause 5.5.7 +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+Clause 5.5.3 +

+
+

POLL-MODE

+
+

Current

+
+

+Clause 5.5.4 +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+Clause 5.5.5 +

+
+

POLL-WINNER

+
+

Current

+
+

+Clause 5.5.6 +

+
+

RESPONSE

+
+

Current

+
+

+Clause 5.5.8 +

+
+

10.3.  POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+

Poll mode name

+

The name of the poll mode.

+

Purpose

+

The purpose of the poll mode. Give a short but clear +description.

+

Reference

+

A reference to the RFC in which the poll mode is defined

+
+

10.4.  POLL-MODE Registrations

This document defines the following registered poll modes.

+

Table 13

Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+
+
+
+

Appendix A
(informative)
Open issues

+

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven’t voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No — voter + has indicated now unable to attend — want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user’s isn’t the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can’t create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event — winning properties ONLY are merged in to the real event.

+

Need to write down what isn’t valid in a VPOLL
+ a. Can’t change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? — some iTip notes On confirm — send itip if appropriate (PUBLISH) +  — all non-participating — shared — feeds + Organizer can specify where result is? + Confirm can specify that itip is sent — ITIP / NONE — parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest
METHOD: REPLY
BEGIN:VPOLL
ORGANIZER:mailto:douglm@mysite.edu
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
UID:sched01-1234567890
DTSTAMP:20120101T010000Z
SEQUENCE:0
SUMMARY:What to do this week
BEGIN:VFREEBUSY
.......
END:VFREEBUSY
END:PARTICIPANT
END:VPOLL
END:VCALENDAR
+

Figure A.1

+
+
+
+

Appendix B
(informative)
Change log

+
+
+

Calext V01: 2019-10-17 MD

+
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
+

Calext V00: 2019-05-17 MD

+
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
+

V03: 2014-10-28 MD

+
+
+
    +
  • +

    Add VVOTER and VOTE components.

    +
  • +
  • +

    Add RESPONSE property.

    +
  • +
  • +

    Remove RESPONSE parameter from VOTER.

    +
  • +
+
+
+

V03: 2014-05-12 MD

+
+
+
    +
  • +

    Add reply-url property and required parameter.

    +
  • +
  • +

    Fix ACCEPT-RESPONSE definition.

    +
  • +
+
+
+

V02: 2014-05-12 MD

+
+
+
    +
  • +

    Typos fixed, clarifications made.

    +
  • +
  • +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
  • +
  • +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
  • +
  • +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
  • +
  • +

    iTip: fix broken table cells

    +
  • +
  • +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
  • +
  • +

    Added Caldav scheduling section

    +
  • +
+
+
+

V01: 2013-08-07 MD

+
+
+
    +
  • +

    Removed method CONFIRM

    +
  • +
  • +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
  • +
  • +

    Added POLL-WINNER and verbiage

    +
  • +
  • +

    Added STATUS values

    +
  • +
  • +

    Added RELTYPE=POLL

    +
  • +
  • +

    Added supported-vpoll-component-sets

    +
  • +
  • +

    Added CalDAV related parameters to VOTER

    +
  • +
  • +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
  • +
+
+
+

Initial version: 2012-11-02 MD

+
+
+
+
+
+

Bibliography

+ +
+
+ + + + + + + + + + + + + diff --git a/documents/cc-51006.pdf b/documents/cc-51006.pdf new file mode 100644 index 0000000..9dd4e8f Binary files /dev/null and b/documents/cc-51006.pdf differ diff --git a/documents/cc-51006.presentation.xml b/documents/cc-51006.presentation.xml new file mode 100644 index 0000000..b62ee47 --- /dev/null +++ b/documents/cc-51006.presentation.xml @@ -0,0 +1,4916 @@ + + + +Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component +CC/CD 51006:2018 +51006 + +2018-11-19 + + + + +CalConnect + + + + + + +Eric York + + + + + + + +Cyrus Daboo + + + + + + + +Michael Douglass + + + + + + +CalConnect + + +1 + +2018-11-19 + +en + + +committee-draft + + +2018 + + +CalConnect + + + + +standard + +FREEBUSY + + + + + + +

© 2018 The Calendaring and Scheduling Consortium, Inc.

+
+
+ + + + + Warning for Drafts +

This document is not a CalConnect Standard. It is distributed for review and + comment, and is subject to change without notice and may not be referred to as + a Standard. Recipients of this draft are invited to submit, with their + comments, notification of any relevant patent rights of which they are aware + and to provide supporting documentation. +

+
+
+ + + + +

All rights reserved. Unless otherwise specified, no part of this + publication may be reproduced or utilized otherwise in any form or by any + means, electronic or mechanical, including photocopying, or posting on the + internet or an intranet, without prior written permission. Permission can + be requested from the address below.

+
+
+ + + +

The Calendaring and Scheduling Consortium, Inc.

+

4390 Chaffin Lane
+ McKinleyville
+ California 95519
+ United States of America
+
+ copyright@calconnect.org
+ www.calconnect.org +

+
+
+
+ +Foreword

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+

The Calendaring and Scheduling Consortium (“CalConnect”) is a global +non-profit organization with the aim to facilitate interoperability of +collaborative technologies and tools through open standards.

+

CalConnect works closely with international and regional partners, +of which the full list is available on our website +().

+

The procedures used to develop this document and those intended for its +further maintenance are described in the CalConnect Directives.

+

In particular the different approval criteria needed for the different +types of CalConnect documents should be noted. This document was drafted in +accordance with the editorial rules of the CalConnect Directives.

+

Attention is drawn to the possibility that some of the elements of this +document may be the subject of patent rights. CalConnect shall not be +held responsible for identifying any or all such patent rights. Details +of any patent rights identified during the development of the document +will be provided in the Introduction.

+

Any trade name used in this document is information given for the +convenience of users and does not constitute an endorsement.

+

This document was prepared by Technical Committee +FREEBUSY.

Introduction

The currently existing approach to agreeing on meeting times using +iTip RFC 5546 and/or iMip RFC 6047 has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement — up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+ + +1.<tab/>Scope +

This document provides a mechanism in iCalendar for consensus scheduling.

+
+ +3.<tab/>Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

+ + +3.1. +consensus scheduling +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+3.2. +active Vpoll +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+3.3. +voter +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+4.<tab/>Simple Consensus Scheduling

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+4.1.<tab/>The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
DTSTAMP
+
+

The usual RFC 5545 property.

+
+
SEQUENCE
+
+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+
+
UID
+
+

The usual RFC 5545 property.

+
+
ORGANIZER
+
+

The usual RFC 5545 property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
SUMMARY
+
+

The usual RFC 5545 property. This optional but +recommended property provides the a short title to the poll.

+
+
DESCRIPTION
+
+

The usual RFC 5545 property. This optional property +provides more details.

+
+
DTEND
+
+

The usual RFC 5545 property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
POLL-MODE
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value “BASIC” +meaning one event will be chosen from the alternatives.

+
+
POLL-COMPLETION
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is “SERVER-SUBMIT” which means the client chooses the winner +but the server will submit the winning choice.

+
+
POLL-PROPERTIES
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value “DTSTART, LOCATION” meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
PARTICIPANT
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to “VOTER”. The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
VOTE
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
VEVENT
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+EXAMPLE

VPOLL with 3 voters and 3 alternative meetings:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD:REQUEST +BEGIN:VPOLL +POLL-MODE:BASIC +POLL-COMPLETION:SERVER-SUBMIT +POLL-PROPERTIES:DTSTART,LOCATION +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T000000Z +SUMMARY:What to do this week +DTEND:20120101T000000Z +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:mike@example.com +END PARTICIPANT +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+4.2.<tab/>The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard RFC 5545 components. For our +simple use case they are all VEVENT components. In addition to the +usual RFC 5545 properties some extra properties are used for a +VPOLL.

+
+
POLL-ITEM-ID
+
+

This provides a unique reference to the sub-component +within the VPOLL. It’s value SHOULD be a small integer.

+
+
+4.3.<tab/>VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
DTSTAMP
+
+

The usual RFC 5545 property.

+
+
SEQUENCE
+
+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+
+
UID
+
+

Same as the request.

+
+
ORGANIZER
+
+

Same as the request.

+
+
SUMMARY
+
+

Same as the request.

+
+
PARTICIPANT
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
VOTE
+
+

One per item being voted on.

+
+
POLL-ITEM-ID
+
+

One inside each VOTE component to identify the choice.

+
+
RESPONSE
+
+

One inside each VOTE component to specify the vote.

+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
NOTE
+
+

This is poll-mode specific behavior?

+
+
+EXAMPLE

REPLY VPOLL from Cyrus:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+4.4.<tab/>VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+EXAMPLEBEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: POLLSTATUS +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T020000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN: VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+4.5.<tab/>VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +“SUBMITTED”.

+EXAMPLE

VPOLL confirmation:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REQUEST +BEGIN:VPOLL +ORGANIZER:mailto:douglm@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T030000Z +COMPLETED:20120101T030000Z +POLL-COMPLETION:SERVER-SUBMIT +SEQUENCE:0 +SUMMARY:What to do this week +STATUS:CONFIRMED +POLL-WINNER:3 +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+4.6.<tab/>Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+5.<tab/>iCalendar Extensions5.1.<tab/>Updated Participant Type Value

Participant type property values are defined in section 11.2.1. of +I-D.ietf-calext-eventpub-extensions. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+Figure 1partvalue /= "VOTER" + +
+
Description
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+5.2.<tab/>Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +RFC 5545. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+Figure 2reltypeparam /= "RELTYPE" "=" "POLL" +; Property value is a VPOLL uid + +
+
Description
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+5.3.<tab/>Updated Status Value

Status property values are defined in section 3.8.1.11. of RFC 5545. +This specification updates that type to define valid VPOLL status +values.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+Figure 3statvalue /= statvalue-poll + ; Status values for "VPOLL". +statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + +
+
Description
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
Figure 4 +
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
+5.4.<tab/>New Property Parameters5.4.1.<tab/>Required
+
Parameter name
+
+

REQUIRED

+
+
Purpose
+
+

To specify whether the associated property is required in +the current context.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+Figure 5requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+5.4.2.<tab/>Stay-Informed
+
Parameter name
+
+

STAY-INFORMED

+
+
Purpose
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+Figure 6stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+5.5.<tab/>New Properties5.5.1.<tab/>Accept-Response
+
Property name
+
+

ACCEPT-RESPONSE

+
+
Purpose
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 7acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + +acceptresponseparams = *(";" other-param) +
+5.5.2.<tab/>Poll-Completion
+
Property name
+
+

POLL-COMPLETION

+
+
Purpose
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
Description
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 8poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + +pcparam = *(";" other-param) + +pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + +
+
Example
+
+

The following is an example of this property:

+
+
+Figure 9POLL-COMPLETION: SERVER-SUBMIT +
+5.5.3.<tab/>Poll-Item-Id
+
Property name
+
+

POLL-ITEM-ID

+
+
Purpose
+
+

This property is used in VPOLL child components as an +identifier.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
Description
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 10pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + +pollitemidparams = *( + (";" other-param) + ) +
+5.5.4.<tab/>Poll-Mode
+
Property name
+
+

POLL-MODE

+
+
Purpose
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
Description
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 11pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + +pollmodeparams = *(";" other-param) +
+5.5.5.<tab/>Poll-properties
+
Property name
+
+

POLL-PROPERTIES

+
+
Purpose
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 12pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + +pollpropparams = *(";" other-param) +
+5.5.6.<tab/>Poll-Winner
+
Property name
+
+

POLL-WINNER

+
+
Purpose
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 13pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + +pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed +
+5.5.7.<tab/>Reply-URL
+
Property name
+
+

REPLY-URL

+
+
Purpose
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
Property Parameters
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 14reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + +reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) +
+5.5.8.<tab/>Response
+
Property name
+
+

RESPONSE

+
+
Purpose
+
+

To specify a response vote.

+
+
Value type
+
+

INTEGER

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 15response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + +responseparams = *(";" other-param) + +
+
Description
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 — 39 A “NO vote”

    +
  • +
  • +

    40 — 79 A “MAYBE” vote

    +
  • +
  • +

    80 — 89 A “YES — but not preferred vote”

    +
  • +
  • +

    90-100 A “YES” vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+
+5.6.<tab/>New Components5.6.1.<tab/>VPOLL Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 16pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + +pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + +
+
Description
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting — both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the “DTSTART” property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If “DTSTART” is present “DURATION” MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

“DTEND” MAY be specified with or without “DTSTART” and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+5.6.2.<tab/>VOTE Component
+
Component name
+
+

VOTE

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Conformance
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+Figure 17votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + +voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + +
+
Description
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER — such as the respondees +availability.

+
+6.<tab/>Poll Modes

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see Clause 10.3) in a published RFC.

+6.1.<tab/>POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+6.1.1.<tab/>Property restrictions

This poll mode has the following property requirements:

+
+
POLL-ITEM-ID
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
POLL-WINNER
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+6.1.2.<tab/>Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+7.<tab/>iTIP Extensions

This specification introduces a number of extensions to RFC 5546. +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+7.1.<tab/>Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+Table 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+ +

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+Table 2 + + + + + + + + + + + + + + + + +
OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+7.2.<tab/>Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+ +7.2.1.<tab/>Delegation +

TBD

+
+ +7.2.2.<tab/>Acting on Behalf of Other Calendar Users +

TBD

+
+ +7.2.3.<tab/>Component Revisions +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter — no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component — bump sequence

    +
  • +
+
+ +7.2.4.<tab/>Message Sequencing +

TBD

+
+7.3.<tab/>Application Protocol Elements7.3.1.<tab/>Methods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the “VPOLL” calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+Table 3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the “VPOLL” +calendar component.

+Table 4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+7.3.2.<tab/>Method: PUBLISH

The “PUBLISH” method in a “VPOLL” calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The “Organizer” MUST be present in a +published iCalendar component. “Voters” MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The “Organizer” may subsequently update (with another +“PUBLISH” method) or cancel (with a “CANCEL” method) a previously +published “VPOLL” calendar component.

+
+
Note
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Table 5 — Constraints for a METHOD:PUBLISH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0 or 1

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to “VOTER” — that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+7.3.3.<tab/>Method: REQUEST

The “REQUEST” method in a “VPOLL” component provides the following +scheduling functions:

+
    +
  • +

    Invite “Voters” to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a “REFRESH” request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of “Voters”.

    +
  • +
  • +

    Forward a “VPOLL” to another uninvited CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, delegate the role of +“Voter” to another CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, change the role of +“Organizer” to another CU.

    +
  • +
+

The “Organizer” originates the “REQUEST”. The recipients of the +“REQUEST” method are the CUs voting in the poll, the “Voters”. +“Voters” use the “REPLY” method to convey votes to the “Organizer”.

+

The “UID” and “SEQUENCE” properties are used to distinguish the +various uses of the “REQUEST” method. If the “UID” property value in +the “REQUEST” is not found on the recipient’s calendar, then the +“REQUEST” is for a new “VPOLL” calendar component. If the “UID” +property value is found on the recipient’s calendar, then the +“REQUEST” is for an update, or a reconfirmation of the “VPOLL” +calendar component.

+

For the “REQUEST” method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Table 6 — Constraints for a METHOD:REQUEST of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0+

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+ +7.3.3.1.<tab/>Rescheduling a poll +

The “REQUEST” method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a “REQUEST” method finds that the “UID” +property value already exists on the calendar but that the “SEQUENCE” +(or “DTSTAMP”) property value in the “REQUEST” method is greater than +the value for the existing poll, then the “REQUEST” method describes +a rescheduling of the poll.

+
+7.3.3.2.<tab/>Updating or Reconfirmation of a Poll

The “REQUEST” method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a “REQUEST” method +finds that the “UID” property value already exists on the calendar +and that the “SEQUENCE” property value in the “REQUEST” is the same +as the value for the existing poll, then the “REQUEST” method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update “REQUEST” method is the appropriate response to a +“REFRESH” method sent from a “Voter” to the “Organizer” of a poll.

+

The “Organizer” of a poll may also send unsolicited “REQUEST” +methods. The unsolicited “REQUEST” methods may be used to update the +details of the poll without rescheduling it, to update the “RESPONSE” +parameter of “Voters”, or to reconfirm the poll.

+ +7.3.3.3.<tab/>Confirmation of a Poll +

The “REQUEST” method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+ +7.3.3.4.<tab/>Closing a Poll +

The “REQUEST” method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+7.3.3.5.<tab/>Delegating a Poll to Another CU

Some calendar and scheduling systems allow “Voters” to delegate the +vote to another “Calendar User”. iTIP supports this concept using the +following workflow. Any “Voter” may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original “Voter”, NOT in addition to the +“Voter”. The delegator MUST notify the “Organizer” of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a “REQUEST” +to another CU.

+

The “Delegator” of a poll forwards the existing “REQUEST” to the +“Delegate”. The “REQUEST” method MUST include a “Voter” property +with the calendar address of the “Delegate”. The “Delegator” MUST +also send a “REPLY” method to the “Organizer” with the “Delegator’s” +“Voter” property “DELEGATED-TO” parameter set to the calendar address +of the “Delegate”. Also, a new “Voter” property for the “Delegate” +MUST be included and must specify the calendar user address set in +the “DELEGATED-TO” parameter, as above.

+

In response to the request, the “Delegate” MUST send a “REPLY” method +to the “Organizer”, and optionally to the “Delegator”. The “REPLY”

+

method SHOULD include the “Voter” property with the “DELEGATED-FROM” +parameter value of the “Delegator’s” calendar address.

+

The “Delegator” may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +“Delegator” setting their “role” attribute to “NON-PARTICIPANT” in +the “REPLY” to the “Organizer”.

+ +7.3.3.6.<tab/>Changing the Organizer +

The situation may arise where the “Organizer” of a “VPOLL” is no +longer able to perform the “Organizer” role and abdicates without +passing on the “Organizer” role to someone else. When this occurs, +the “Voters” of the “VPOLL” may use out-of-band mechanisms to +communicate the situation and agree upon a new “Organizer”. The new +“Organizer” should then send out a new “REQUEST” with a modified +version of the “VPOLL” in which the “SEQUENCE” number has been +incremented and the “ORGANIZER” property has been changed to the new +“Organizer”.

+
+ +7.3.3.7.<tab/>Sending on Behalf of the Organizer +

There are a number of scenarios that support the need for a “Calendar +User” to act on behalf of the “Organizer” without explicit role +changing. This might be the case if the CU designated as “Organizer” +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the “SENT-BY” parameter, a “Calendar User” could +send an updated “VPOLL” “REQUEST”. In the case where one CU sends on +behalf of another CU, the “Voter” responses are still directed back +towards the CU designated as “Organizer”.

+
+7.3.3.8.<tab/>Forwarding to an Uninvited CU

A “Voter” invited to a “VPOLL” calendar component may send the +“VPOLL” calendar component to another new CU not previously +associated with the “VPOLL” calendar component. The current “Voter” +participating in the “VPOLL” calendar component does this by +forwarding the original “REQUEST” method to the new CU. The new CU +can send a “REPLY” to the “Organizer” of the “VPOLL” calendar +component. The reply contains a “Voter” property for the new CU.

+

The “Organizer” ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a “REPLY” +from a new (uninvited) CU. If the “Organizer” does not want the new +CU to be part of the poll, the new “Voter” property is not added to +the “VPOLL” calendar component. The “Organizer” MAY send the CU a +“CANCEL” message to indicate that they will not be added to the poll.

+

If the “Organizer” decides to add the new CU, the new “Voter” +property is added to the “VPOLL” calendar component. Furthermore, +the “Organizer” is free to change any “Voter” property parameter from +the values supplied by the new CU to something the “Organizer” +considers appropriate. The “Organizer” SHOULD send the new CU a +“REQUEST” message to inform them that they have been added.

+

When forwarding a “REQUEST” to another CU, the forwarding “Voter” +MUST NOT make changes to the original message.

+ +7.3.3.9.<tab/>Updating Voter Status +

The “Organizer” of an poll may also request updated status from one +or more “Voters”. The “Organizer” sends a “REQUEST” method to the +“Voter” and sets the “RSVP=TRUE” property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +“SEQUENCE” property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +“REQUEST” is that their “RSVP” property parameter indicates a request +for updated status. The recipient SHOULD respond with a “REPLY” +method indicating their current vote with respect to the “REQUEST”.

+
+7.3.4.<tab/>Method: REPLY

The “REPLY” method in a “VPOLL” calendar component is used to respond +(e.g., accept or decline) to a “REQUEST” or to reply to a delegation +“REQUEST”. When used to provide a delegation response, the +“Delegator” SHOULD include the calendar address of the “Delegate” on +the “DELEGATED-TO” property parameter of the “Delegator’s” “CALENDAR-ADDRESS” +property. The “Delegate” SHOULD include the calendar address of the +“Delegator” on the “DELEGATED-FROM” property parameter of the +“Delegate’s” “CALENDAR-ADDRESS” property.

+

The “REPLY” method is also used when processing of a “REQUEST” fails. +Depending on the value of the “REQUEST-STATUS” property, no action +may have been performed.

+

The “Organizer” of a poll may receive the “REPLY” method from a CU +not in the original “REQUEST”. For example, a “REPLY” may be +received from a “Delegate” to a poll. In addition, the “REPLY” +method may be received from an unknown CU (a “Party Crasher”). This +uninvited “Voter” may be accepted, or the “Organizer” may cancel the +poll for the uninvited “Voter” by sending a “CANCEL” method to the +uninvited “Voter”.

+

A “Voter” MAY include a message to the “Organizer” using the +“COMMENT” property. For example, if the user indicates a low +interest and wants to let the “Organizer” know why, the reason can be +expressed in the “COMMENT” property value.

+

The “Organizer” may also receive a “REPLY” from one CU on behalf of +another. Like the scenario enumerated above for the “Organizer”, +“Voters” may have another CU respond on their behalf. This is done +using the “SENT-BY” parameter.

+

The optional properties listed in the table below (those listed as +“0+” or “0 or 1”) MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Table 7 — Constraints for a METHOD:REPLY of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+ + +

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+ + +

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+
+

VTODO

+
+

0

+
+
+7.3.5.<tab/>Method: CANCEL

The “CANCEL” method in a “VPOLL” calendar component is used to send a +cancellation notice of an existing poll request to the affected +“Voters”. The message is sent by the “Organizer” of the poll.

+

The “Organizer” MUST send a “CANCEL” message to each “Voter” affected +by the cancellation. This can be done using a single “CANCEL” +message for all “Voters” or by using multiple messages with different +subsets of the affected “Voters” in each.

+

When a “VPOLL” is cancelled, the “SEQUENCE” property value MUST be +incremented as described in Clause 7.2.3.

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Table 8 — Constraints for a METHOD:CANCEL of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

1

+
+
+

ATTACH

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+7.3.6.<tab/>Method: REFRESH

The “REFRESH” method in a “VPOLL” calendar component is used by +“Voters” of an existing event to request an updated description from +the poll “Organizer”. The “REFRESH” method must specify the “UID” +property of the poll to update. The “Organizer” responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Table 9 — Constraints for a METHOD:REFRESH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0

+
+
+

DESCRIPTION

+
+

0

+
+
+

DTEND

+
+

0

+
+
+

DTSTART

+
+

0

+
+
+

DURATION

+
+

0

+
+
+

GEO

+
+

0

+
+
+

LAST-MODIFIED

+
+

0

+
+
+

LOCATION

+
+

0

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0

+
+
+

RELATED-TO

+
+

0

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0

+
+
+

SEQUENCE

+
+

0

+
+
+

STATUS

+
+

0

+
+
+

SUMMARY

+
+

0

+
+
+

URL

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+7.3.7.<tab/>Method: POLLSTATUS

The “POLLSTATUS” method in a “VPOLL” calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The “Organizer” MUST be present in the confirmed poll +component. All “Voters” MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Table 10 — Constraints for a METHOD:POLLSTATUS of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+8.<tab/>CalDAV Extensions

This specification extends RFC 4791 in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends RFC 6638 as it a VPOLL component is a +schedulable entity.

+8.1.<tab/>Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+8.1.1.<tab/>CALDAV:supported-vpoll-component-sets
+
Name
+
+

supported-vpoll-component-sets

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1RFC 2518, Section 12.14.1).

+
+
Description
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition Clause 8.2 being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
Definition
+
+
+Figure 18<!ELEMENT supported-vpoll-component-sets + (supported-vpoll-component-set*) > + +<!ELEMENT supported-vpoll-component-set (comp+)> + +Figure 19<C:supported-vpoll-component-sets + xmlns:C="urn:ietf:params:xml:ns:caldav"> + + <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT or VFREEBUSY --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> +</C:supported-vpoll-component-sets> +
+8.1.2.<tab/>CALDAV:vpoll-max-items
+
Name
+
+

vpoll-max-items

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1RFC 2518, Section 12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
Definition
+
+
+Figure 20<!ELEMENT vpoll-max-items (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +Figure 21<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-items> +
+8.1.3.<tab/>CALDAV:vpoll-max-active
+
Name
+
+

vpoll-max-active

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1RFC 2518, Section 12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
Definition
+
+
+Figure 22<!ELEMENT vpoll-max-active (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +Figure 23<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-active> +
+8.1.4.<tab/>CALDAV:vpoll-max-voters
+
Name
+
+

+vpoll-max-voters +

+
+
Namespace
+
+

+urn:ietf:params:xml:ns:caldav +

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1RFC 2518, Section 12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition Clause 8.2 +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
Definition
+
+
+Figure 24<!ELEMENT vpoll-max-voters (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +Figure 25<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-voters> +
+ +8.1.5.<tab/>CalDAV:even-more-properties + +8.1.6.<tab/>Extensions to CalDAV scheduling

This specification extends RFC 6638.

+

Each section of Appendix A “Scheduling Privileges Summary” is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+8.2.<tab/>Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+
+
(CALDAV:supported-vpoll-component-sets)
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
(CALDAV:vpoll-max-items)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value Clause 8.1.2 +on the calendar collection where the resource will be stored;

+
+
(CALDAV:vpoll-max-active)
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value +Clause 8.1.3 on the calendar collection where the resource will +be stored;

+
+
(CALDAV:vpoll-max-voters)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value Clause 8.1.4 on the +calendar collection where the resource will be stored;

+
+
+8.3.<tab/>CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+8.3.1.<tab/>Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+Figure 26>> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<C:calendar-query xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:prop> + <D:getetag/> + <C:calendar-data> + <C:comp name="VCALENDAR"> + <C:prop name="VERSION"/> + <C:comp name="VPOLL"> + <C:prop name="SUMMARY"/> + <C:prop name="UID"/> + <C:prop name="DTSTART"/> + <C:prop name="DTEND"/> + <C:prop name="DURATION"/> + </C:comp> + + </C:comp> + </C:calendar-data> + </D:prop> + <C:filter> + <C:comp-filter name="VCALENDAR"> + <C:comp-filter name="VPOLL"> + <C:time-range start="20121204T000000Z" + end="20121205T000000Z"/> + </C:comp-filter> + </C:comp-filter> + </C:filter> +</C:calendar-query> + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<D:multistatus xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd2"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd3"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> +</D:multistatus> +
+8.4.<tab/>CalDAV time ranges

“CALDAV:time-range XML Element” in 9.9RFC 4791, Section 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends RFC 4791 to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

+Figure 27+-------------------------------------------------------------------+ +| VPOLL has the DTSTART property? | +| +---------------------------------------------------------------+ +| | VPOLL has the DURATION property? | +| | +-----------------------------------------------------------+ +| | | VPOLL has the DTEND property? | +| | | +-------------------------------------------------------+ +| | | | VPOLL has the COMPLETED property? | +| | | | +---------------------------------------------------+ +| | | | | VPOLL has the CREATED property? | +| | | | | +-----------------------------------------------+ +| | | | | | Condition to evaluate | ++---+---+---+---+---+-----------------------------------------------+ +| Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | +| | | | | | ((end > DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+ +
+ +9.<tab/>Security Considerations +

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See RFC 3986 for a +discussion of the security considerations relating to URIs.

+
+10.<tab/>IANA Considerations10.1.<tab/>Parameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in 8.2.4RFC 5545, Section 8.2.4:

+Table 11 + + + + + + + + + + + + + + + + + + + +
Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+Clause 5.4.1 +

+
+

STAY-INFORMED

+
+

Current

+
+

+Clause 5.4.2 +

+
+10.2.<tab/>Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in 8.2.3RFC 5545, Section 8.2.3:

+Table 12 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+Clause 5.5.7 +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+Clause 5.5.3 +

+
+

POLL-MODE

+
+

Current

+
+

+Clause 5.5.4 +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+Clause 5.5.5 +

+
+

POLL-WINNER

+
+

Current

+
+

+Clause 5.5.6 +

+
+

RESPONSE

+
+

Current

+
+

+Clause 5.5.8 +

+
+10.3.<tab/>POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+
+
Poll mode name
+
+

The name of the poll mode.

+
+
Purpose
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
Reference
+
+

A reference to the RFC in which the poll mode is defined

+
+
+10.4.<tab/>POLL-MODE Registrations

This document defines the following registered poll modes.

+Table 13 + + + + + + + + + + + + + + +
Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+ + +
<strong>Appendix A</strong><br/>(informative)<br/><strong>Open issues</strong>

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven’t voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No — voter + has indicated now unable to attend — want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user’s isn’t the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can’t create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event — winning properties ONLY are merged in to the real event.

+

Need to write down what isn’t valid in a VPOLL
+ a. Can’t change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? — some iTip notes On confirm — send itip if appropriate (PUBLISH) +  — all non-participating — shared — feeds + Organizer can specify where result is? + Confirm can specify that itip is sent — ITIP / NONE — parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+Figure A.1BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:douglm@mysite.edu +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:VFREEBUSY +....... +END:VFREEBUSY +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+<strong>Appendix B</strong><br/>(informative)<br/><strong>Change log</strong> +
+
Calext V01: 2019-10-17 MD
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
Calext V00: 2019-05-17 MD
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
V03: 2014-10-28 MD
+
+
    +
  • +

    Add VVOTER and VOTE components.

    +
  • +
  • +

    Add RESPONSE property.

    +
  • +
  • +

    Remove RESPONSE parameter from VOTER.

    +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +

    Add reply-url property and required parameter.

    +
  • +
  • +

    Fix ACCEPT-RESPONSE definition.

    +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +

    Typos fixed, clarifications made.

    +
  • +
  • +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
  • +
  • +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
  • +
  • +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
  • +
  • +

    iTip: fix broken table cells

    +
  • +
  • +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
  • +
  • +

    Added Caldav scheduling section

    +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +

    Removed method CONFIRM

    +
  • +
  • +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
  • +
  • +

    Added POLL-WINNER and verbiage

    +
  • +
  • +

    Added STATUS values

    +
  • +
  • +

    Added RELTYPE=POLL

    +
  • +
  • +

    Added supported-vpoll-component-sets

    +
  • +
  • +

    Added CalDAV related parameters to VOTER

    +
  • +
  • +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
2.<tab/>Normative references

The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

2020-07-16 HTTP Extensions for Distributed Authoring — WEBDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2518.xml https://www.rfc-editor.org/info/rfc2518 RFC 2518 RFC2518 10.17487/RFC2518 1999-02 Y. Goland Internet Engineering Task Force IETF E. Whitehead Internet Engineering Task Force IETF A. Faizi Internet Engineering Task Force IETF S. Carter Internet Engineering Task Force IETF D. Jensen Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] RFC 2518 Fremont, CA 2020-07-16 Uniform Resource Identifier (URI): Generic Syntax https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.3986.xml https://www.rfc-editor.org/info/rfc3986 RFC 3986 RFC3986 10.17487/RFC3986 2005-01 T. Berners-Lee Internet Engineering Task Force IETF R. Fielding Internet Engineering Task Force IETF L. Masinter Internet Engineering Task Force IETF Internet Engineering Task Force IETF en A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] STD 66 RFC 3986 Fremont, CA 2020-07-16 Calendaring Extensions to WebDAV (CalDAV) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.4791.xml https://www.rfc-editor.org/info/rfc4791 RFC 4791 RFC4791 10.17487/RFC4791 2007-03 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF L. Dusseault Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the “calendar-access” feature of CalDAV. [STANDARDS-TRACK] RFC 4791 Fremont, CA 2020-07-16 Internet Calendaring and Scheduling Core Object Specification (iCalendar) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5545.xml https://www.rfc-editor.org/info/rfc5545 RFC 5545 RFC5545 10.17487/RFC5545 2009-09 B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] RFC 5545 Fremont, CA 2020-07-16 iCalendar Transport-Independent Interoperability Protocol (iTIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5546.xml https://www.rfc-editor.org/info/rfc5546 RFC 5546 RFC5546 10.17487/RFC5546 2009-12 C. Daboo Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] RFC 5546 Fremont, CA 2020-07-16 iCalendar Message-Based Interoperability Protocol (iMIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6047.xml https://www.rfc-editor.org/info/rfc6047 RFC 6047 RFC6047 10.17487/RFC6047 2010-12 A. Melnikov Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document, “iCalendar Message-Based Interoperability Protocol (iMIP)”, specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] RFC 6047 Fremont, CA 2020-07-16 Scheduling Extensions to CalDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6638.xml https://www.rfc-editor.org/info/rfc6638 RFC 6638 RFC6638 10.17487/RFC6638 2012-06 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) “calendar-access” feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the “calendar-auto-schedule” feature of CalDAV. [STANDARDS-TRACK] RFC 6638 Fremont, CA 2020-07-30 Event Publishing Extensions to iCalendar https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-calext-eventpub-extensions.xml http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.txt http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.pdf I-D.ietf-calext-eventpub-extensions I-D.ietf-calext-eventpub-extensions draft-ietf-calext-eventpub-extensions-15 2019-10 Michael Douglass Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This specification updates RFC5545 by introducing a number of new iCalendar properties and components which are of particular use for event publishers and in social networking. This specification also defines a new STRUCTURED-DATA property for iCalendar RFC5545 to allow for data that is directly pertinent to an event or task to be included with the calendar data. Internet-Draft draft-ietf-calext-eventpub-extensions-15 Fremont, CA
+Bibliography +
+
diff --git a/documents/cc-51006.rxl b/documents/cc-51006.rxl new file mode 100644 index 0000000..5bc1c99 --- /dev/null +++ b/documents/cc-51006.rxl @@ -0,0 +1,67 @@ + +Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component +CC/CD 51006:2018 +51006 + +2018-11-19 + + + + +CalConnect + + + + + + +Eric York + + + + + + + +Cyrus Daboo + + + + + + + +Michael Douglass + + + + + + +CalConnect + + +1 + +2018-11-19 + +en + + +committee-draft + + +2018 + + +CalConnect + + + + +standard + +FREEBUSY + + + \ No newline at end of file diff --git a/documents/cc-51006.xml b/documents/cc-51006.xml new file mode 100644 index 0000000..4222333 --- /dev/null +++ b/documents/cc-51006.xml @@ -0,0 +1,4916 @@ + + + +Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component +CC/CD 51006:2018 +51006 + +2018-11-19 + + + + +CalConnect + + + + + + +Eric York + + + + + + + +Cyrus Daboo + + + + + + + +Michael Douglass + + + + + + +CalConnect + + +1 + +2018-11-19 + +en + + +committee-draft + + +2018 + + +CalConnect + + + + +standard + +FREEBUSY + + + + + + +

© 2018 The Calendaring and Scheduling Consortium, Inc.

+
+
+ + + + + Warning for Drafts +

This document is not a CalConnect Standard. It is distributed for review and + comment, and is subject to change without notice and may not be referred to as + a Standard. Recipients of this draft are invited to submit, with their + comments, notification of any relevant patent rights of which they are aware + and to provide supporting documentation. +

+
+
+ + + + +

All rights reserved. Unless otherwise specified, no part of this + publication may be reproduced or utilized otherwise in any form or by any + means, electronic or mechanical, including photocopying, or posting on the + internet or an intranet, without prior written permission. Permission can + be requested from the address below.

+
+
+ + + +

The Calendaring and Scheduling Consortium, Inc.

+

4390 Chaffin Lane
+ McKinleyville
+ California 95519
+ United States of America
+
+ copyright@calconnect.org
+ www.calconnect.org +

+
+
+
+ +Foreword

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+

The Calendaring and Scheduling Consortium (“CalConnect”) is a global +non-profit organization with the aim to facilitate interoperability of +collaborative technologies and tools through open standards.

+

CalConnect works closely with international and regional partners, +of which the full list is available on our website +().

+

The procedures used to develop this document and those intended for its +further maintenance are described in the CalConnect Directives.

+

In particular the different approval criteria needed for the different +types of CalConnect documents should be noted. This document was drafted in +accordance with the editorial rules of the CalConnect Directives.

+

Attention is drawn to the possibility that some of the elements of this +document may be the subject of patent rights. CalConnect shall not be +held responsible for identifying any or all such patent rights. Details +of any patent rights identified during the development of the document +will be provided in the Introduction.

+

Any trade name used in this document is information given for the +convenience of users and does not constitute an endorsement.

+

This document was prepared by Technical Committee +FREEBUSY.

Introduction

The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement — up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+ + +Scope +

This document provides a mechanism in iCalendar for consensus scheduling.

+
+ +Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

+ + + +consensus scheduling +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+ +active Vpoll +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+ +voter +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+Simple Consensus Scheduling

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

The usual property.

+
+
ORGANIZER
+
+

The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
SUMMARY
+
+

The usual property. This optional but +recommended property provides the a short title to the poll.

+
+
DESCRIPTION
+
+

The usual property. This optional property +provides more details.

+
+
DTEND
+
+

The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
POLL-MODE
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value “BASIC” +meaning one event will be chosen from the alternatives.

+
+
POLL-COMPLETION
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is “SERVER-SUBMIT” which means the client chooses the winner +but the server will submit the winning choice.

+
+
POLL-PROPERTIES
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value “DTSTART, LOCATION” meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
PARTICIPANT
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to “VOTER”. The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
VOTE
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
VEVENT
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD:REQUEST +BEGIN:VPOLL +POLL-MODE:BASIC +POLL-COMPLETION:SERVER-SUBMIT +POLL-PROPERTIES:DTSTART,LOCATION +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T000000Z +SUMMARY:What to do this week +DTEND:20120101T000000Z +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:mike@example.com +END PARTICIPANT +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL.

+
+
POLL-ITEM-ID
+
+

This provides a unique reference to the sub-component +within the VPOLL. It’s value SHOULD be a small integer.

+
+
+VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

Same as the request.

+
+
ORGANIZER
+
+

Same as the request.

+
+
SUMMARY
+
+

Same as the request.

+
+
PARTICIPANT
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
VOTE
+
+

One per item being voted on.

+
+
POLL-ITEM-ID
+
+

One inside each VOTE component to identify the choice.

+
+
RESPONSE
+
+

One inside each VOTE component to specify the vote.

+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
NOTE
+
+

This is poll-mode specific behavior?

+
+
+

REPLY VPOLL from Cyrus:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: POLLSTATUS +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T020000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN: VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +“SUBMITTED”.

+

VPOLL confirmation:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REQUEST +BEGIN:VPOLL +ORGANIZER:mailto:douglm@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T030000Z +COMPLETED:20120101T030000Z +POLL-COMPLETION:SERVER-SUBMIT +SEQUENCE:0 +SUMMARY:What to do this week +STATUS:CONFIRMED +POLL-WINNER:3 +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+iCalendar ExtensionsUpdated Participant Type Value

Participant type property values are defined in section 11.2.1. of +. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+partvalue /= "VOTER" + +
+
Description
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+reltypeparam /= "RELTYPE" "=" "POLL" +; Property value is a VPOLL uid + +
+
Description
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+Updated Status Value

Status property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+statvalue /= statvalue-poll + ; Status values for "VPOLL". +statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + +
+
Description
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
+New Property ParametersRequired
+
Parameter name
+
+

REQUIRED

+
+
Purpose
+
+

To specify whether the associated property is required in +the current context.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+Stay-Informed
+
Parameter name
+
+

STAY-INFORMED

+
+
Purpose
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+New PropertiesAccept-Response
+
Property name
+
+

ACCEPT-RESPONSE

+
+
Purpose
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + +acceptresponseparams = *(";" other-param) +
+Poll-Completion
+
Property name
+
+

POLL-COMPLETION

+
+
Purpose
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
Description
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
Format Definition
+
+

This property is defined by the following notation:

+
+
+poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + +pcparam = *(";" other-param) + +pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + +
+
Example
+
+

The following is an example of this property:

+
+
+POLL-COMPLETION: SERVER-SUBMIT +
+Poll-Item-Id
+
Property name
+
+

POLL-ITEM-ID

+
+
Purpose
+
+

This property is used in VPOLL child components as an +identifier.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
Description
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + +pollitemidparams = *( + (";" other-param) + ) +
+Poll-Mode
+
Property name
+
+

POLL-MODE

+
+
Purpose
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
Description
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + +pollmodeparams = *(";" other-param) +
+Poll-properties
+
Property name
+
+

POLL-PROPERTIES

+
+
Purpose
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + +pollpropparams = *(";" other-param) +
+Poll-Winner
+
Property name
+
+

POLL-WINNER

+
+
Purpose
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + +pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed +
+Reply-URL
+
Property name
+
+

REPLY-URL

+
+
Purpose
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
Property Parameters
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + +reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) +
+Response
+
Property name
+
+

RESPONSE

+
+
Purpose
+
+

To specify a response vote.

+
+
Value type
+
+

INTEGER

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + +responseparams = *(";" other-param) + +
+
Description
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 — 39 A “NO vote”

    +
  • +
  • +

    40 — 79 A “MAYBE” vote

    +
  • +
  • +

    80 — 89 A “YES — but not preferred vote”

    +
  • +
  • +

    90-100 A “YES” vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+
+New ComponentsVPOLL Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + +pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + +
+
Description
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting — both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the “DTSTART” property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If “DTSTART” is present “DURATION” MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

“DTEND” MAY be specified with or without “DTSTART” and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+VOTE Component
+
Component name
+
+

VOTE

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Conformance
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + +voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + +
+
Description
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER — such as the respondees +availability.

+
+Poll Modes

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC.

+POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+Property restrictions

This poll mode has the following property requirements:

+
+
POLL-ITEM-ID
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
POLL-WINNER
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+iTIP Extensions

This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+ +

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+ + + + + + + + + + + + + + + + + +
OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+ +Delegation +

TBD

+
+ +Acting on Behalf of Other Calendar Users +

TBD

+
+ +Component Revisions +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter — no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component — bump sequence

    +
  • +
+
+ +Message Sequencing +

TBD

+
+Application Protocol ElementsMethods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the “VPOLL” calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the “VPOLL” +calendar component.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+Method: PUBLISH

The “PUBLISH” method in a “VPOLL” calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The “Organizer” MUST be present in a +published iCalendar component. “Voters” MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The “Organizer” may subsequently update (with another +“PUBLISH” method) or cancel (with a “CANCEL” method) a previously +published “VPOLL” calendar component.

+
+
Note
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:PUBLISH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0 or 1

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to “VOTER” — that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+Method: REQUEST

The “REQUEST” method in a “VPOLL” component provides the following +scheduling functions:

+
    +
  • +

    Invite “Voters” to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a “REFRESH” request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of “Voters”.

    +
  • +
  • +

    Forward a “VPOLL” to another uninvited CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, delegate the role of +“Voter” to another CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, change the role of +“Organizer” to another CU.

    +
  • +
+

The “Organizer” originates the “REQUEST”. The recipients of the +“REQUEST” method are the CUs voting in the poll, the “Voters”. +“Voters” use the “REPLY” method to convey votes to the “Organizer”.

+

The “UID” and “SEQUENCE” properties are used to distinguish the +various uses of the “REQUEST” method. If the “UID” property value in +the “REQUEST” is not found on the recipient’s calendar, then the +“REQUEST” is for a new “VPOLL” calendar component. If the “UID” +property value is found on the recipient’s calendar, then the +“REQUEST” is for an update, or a reconfirmation of the “VPOLL” +calendar component.

+

For the “REQUEST” method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REQUEST of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0+

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+ +Rescheduling a poll +

The “REQUEST” method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a “REQUEST” method finds that the “UID” +property value already exists on the calendar but that the “SEQUENCE” +(or “DTSTAMP”) property value in the “REQUEST” method is greater than +the value for the existing poll, then the “REQUEST” method describes +a rescheduling of the poll.

+
+Updating or Reconfirmation of a Poll

The “REQUEST” method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a “REQUEST” method +finds that the “UID” property value already exists on the calendar +and that the “SEQUENCE” property value in the “REQUEST” is the same +as the value for the existing poll, then the “REQUEST” method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update “REQUEST” method is the appropriate response to a +“REFRESH” method sent from a “Voter” to the “Organizer” of a poll.

+

The “Organizer” of a poll may also send unsolicited “REQUEST” +methods. The unsolicited “REQUEST” methods may be used to update the +details of the poll without rescheduling it, to update the “RESPONSE” +parameter of “Voters”, or to reconfirm the poll.

+ +Confirmation of a Poll +

The “REQUEST” method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+ +Closing a Poll +

The “REQUEST” method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+Delegating a Poll to Another CU

Some calendar and scheduling systems allow “Voters” to delegate the +vote to another “Calendar User”. iTIP supports this concept using the +following workflow. Any “Voter” may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original “Voter”, NOT in addition to the +“Voter”. The delegator MUST notify the “Organizer” of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a “REQUEST” +to another CU.

+

The “Delegator” of a poll forwards the existing “REQUEST” to the +“Delegate”. The “REQUEST” method MUST include a “Voter” property +with the calendar address of the “Delegate”. The “Delegator” MUST +also send a “REPLY” method to the “Organizer” with the “Delegator’s” +“Voter” property “DELEGATED-TO” parameter set to the calendar address +of the “Delegate”. Also, a new “Voter” property for the “Delegate” +MUST be included and must specify the calendar user address set in +the “DELEGATED-TO” parameter, as above.

+

In response to the request, the “Delegate” MUST send a “REPLY” method +to the “Organizer”, and optionally to the “Delegator”. The “REPLY”

+

method SHOULD include the “Voter” property with the “DELEGATED-FROM” +parameter value of the “Delegator’s” calendar address.

+

The “Delegator” may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +“Delegator” setting their “role” attribute to “NON-PARTICIPANT” in +the “REPLY” to the “Organizer”.

+ +Changing the Organizer +

The situation may arise where the “Organizer” of a “VPOLL” is no +longer able to perform the “Organizer” role and abdicates without +passing on the “Organizer” role to someone else. When this occurs, +the “Voters” of the “VPOLL” may use out-of-band mechanisms to +communicate the situation and agree upon a new “Organizer”. The new +“Organizer” should then send out a new “REQUEST” with a modified +version of the “VPOLL” in which the “SEQUENCE” number has been +incremented and the “ORGANIZER” property has been changed to the new +“Organizer”.

+
+ +Sending on Behalf of the Organizer +

There are a number of scenarios that support the need for a “Calendar +User” to act on behalf of the “Organizer” without explicit role +changing. This might be the case if the CU designated as “Organizer” +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the “SENT-BY” parameter, a “Calendar User” could +send an updated “VPOLL” “REQUEST”. In the case where one CU sends on +behalf of another CU, the “Voter” responses are still directed back +towards the CU designated as “Organizer”.

+
+Forwarding to an Uninvited CU

A “Voter” invited to a “VPOLL” calendar component may send the +“VPOLL” calendar component to another new CU not previously +associated with the “VPOLL” calendar component. The current “Voter” +participating in the “VPOLL” calendar component does this by +forwarding the original “REQUEST” method to the new CU. The new CU +can send a “REPLY” to the “Organizer” of the “VPOLL” calendar +component. The reply contains a “Voter” property for the new CU.

+

The “Organizer” ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a “REPLY” +from a new (uninvited) CU. If the “Organizer” does not want the new +CU to be part of the poll, the new “Voter” property is not added to +the “VPOLL” calendar component. The “Organizer” MAY send the CU a +“CANCEL” message to indicate that they will not be added to the poll.

+

If the “Organizer” decides to add the new CU, the new “Voter” +property is added to the “VPOLL” calendar component. Furthermore, +the “Organizer” is free to change any “Voter” property parameter from +the values supplied by the new CU to something the “Organizer” +considers appropriate. The “Organizer” SHOULD send the new CU a +“REQUEST” message to inform them that they have been added.

+

When forwarding a “REQUEST” to another CU, the forwarding “Voter” +MUST NOT make changes to the original message.

+ +Updating Voter Status +

The “Organizer” of an poll may also request updated status from one +or more “Voters”. The “Organizer” sends a “REQUEST” method to the +“Voter” and sets the “RSVP=TRUE” property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +“SEQUENCE” property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +“REQUEST” is that their “RSVP” property parameter indicates a request +for updated status. The recipient SHOULD respond with a “REPLY” +method indicating their current vote with respect to the “REQUEST”.

+
+Method: REPLY

The “REPLY” method in a “VPOLL” calendar component is used to respond +(e.g., accept or decline) to a “REQUEST” or to reply to a delegation +“REQUEST”. When used to provide a delegation response, the +“Delegator” SHOULD include the calendar address of the “Delegate” on +the “DELEGATED-TO” property parameter of the “Delegator’s” “CALENDAR-ADDRESS” +property. The “Delegate” SHOULD include the calendar address of the +“Delegator” on the “DELEGATED-FROM” property parameter of the +“Delegate’s” “CALENDAR-ADDRESS” property.

+

The “REPLY” method is also used when processing of a “REQUEST” fails. +Depending on the value of the “REQUEST-STATUS” property, no action +may have been performed.

+

The “Organizer” of a poll may receive the “REPLY” method from a CU +not in the original “REQUEST”. For example, a “REPLY” may be +received from a “Delegate” to a poll. In addition, the “REPLY” +method may be received from an unknown CU (a “Party Crasher”). This +uninvited “Voter” may be accepted, or the “Organizer” may cancel the +poll for the uninvited “Voter” by sending a “CANCEL” method to the +uninvited “Voter”.

+

A “Voter” MAY include a message to the “Organizer” using the +“COMMENT” property. For example, if the user indicates a low +interest and wants to let the “Organizer” know why, the reason can be +expressed in the “COMMENT” property value.

+

The “Organizer” may also receive a “REPLY” from one CU on behalf of +another. Like the scenario enumerated above for the “Organizer”, +“Voters” may have another CU respond on their behalf. This is done +using the “SENT-BY” parameter.

+

The optional properties listed in the table below (those listed as +“0+” or “0 or 1”) MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REPLY of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+ + +

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+ + +

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+
+

VTODO

+
+

0

+
+
+Method: CANCEL

The “CANCEL” method in a “VPOLL” calendar component is used to send a +cancellation notice of an existing poll request to the affected +“Voters”. The message is sent by the “Organizer” of the poll.

+

The “Organizer” MUST send a “CANCEL” message to each “Voter” affected +by the cancellation. This can be done using a single “CANCEL” +message for all “Voters” or by using multiple messages with different +subsets of the affected “Voters” in each.

+

When a “VPOLL” is cancelled, the “SEQUENCE” property value MUST be +incremented as described in .

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:CANCEL of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

1

+
+
+

ATTACH

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: REFRESH

The “REFRESH” method in a “VPOLL” calendar component is used by +“Voters” of an existing event to request an updated description from +the poll “Organizer”. The “REFRESH” method must specify the “UID” +property of the poll to update. The “Organizer” responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REFRESH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0

+
+
+

DESCRIPTION

+
+

0

+
+
+

DTEND

+
+

0

+
+
+

DTSTART

+
+

0

+
+
+

DURATION

+
+

0

+
+
+

GEO

+
+

0

+
+
+

LAST-MODIFIED

+
+

0

+
+
+

LOCATION

+
+

0

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0

+
+
+

RELATED-TO

+
+

0

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0

+
+
+

SEQUENCE

+
+

0

+
+
+

STATUS

+
+

0

+
+
+

SUMMARY

+
+

0

+
+
+

URL

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: POLLSTATUS

The “POLLSTATUS” method in a “VPOLL” calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The “Organizer” MUST be present in the confirmed poll +component. All “Voters” MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:POLLSTATUS of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+CalDAV Extensions

This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends as it a VPOLL component is a +schedulable entity.

+Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+CALDAV:supported-vpoll-component-sets
+
Name
+
+

supported-vpoll-component-sets

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
Definition
+
+
+<!ELEMENT supported-vpoll-component-sets + (supported-vpoll-component-set*) > + +<!ELEMENT supported-vpoll-component-set (comp+)> + +<C:supported-vpoll-component-sets + xmlns:C="urn:ietf:params:xml:ns:caldav"> + + <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT or VFREEBUSY --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> +</C:supported-vpoll-component-sets> +
+CALDAV:vpoll-max-items
+
Name
+
+

vpoll-max-items

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-items (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-items> +
+CALDAV:vpoll-max-active
+
Name
+
+

vpoll-max-active

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-active (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-active> +
+CALDAV:vpoll-max-voters
+
Name
+
+

+vpoll-max-voters +

+
+
Namespace
+
+

+urn:ietf:params:xml:ns:caldav +

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-voters (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-voters> +
+ +CalDAV:even-more-properties + +Extensions to CalDAV scheduling

This specification extends .

+

Each section of Appendix A “Scheduling Privileges Summary” is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+
+
(CALDAV:supported-vpoll-component-sets)
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
(CALDAV:vpoll-max-items)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored;

+
+
(CALDAV:vpoll-max-active)
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored;

+
+
(CALDAV:vpoll-max-voters)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored;

+
+
+CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+>> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<C:calendar-query xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:prop> + <D:getetag/> + <C:calendar-data> + <C:comp name="VCALENDAR"> + <C:prop name="VERSION"/> + <C:comp name="VPOLL"> + <C:prop name="SUMMARY"/> + <C:prop name="UID"/> + <C:prop name="DTSTART"/> + <C:prop name="DTEND"/> + <C:prop name="DURATION"/> + </C:comp> + + </C:comp> + </C:calendar-data> + </D:prop> + <C:filter> + <C:comp-filter name="VCALENDAR"> + <C:comp-filter name="VPOLL"> + <C:time-range start="20121204T000000Z" + end="20121205T000000Z"/> + </C:comp-filter> + </C:comp-filter> + </C:filter> +</C:calendar-query> + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<D:multistatus xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd2"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd3"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> +</D:multistatus> +
+CalDAV time ranges

“CALDAV:time-range XML Element” in 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

++-------------------------------------------------------------------+ +| VPOLL has the DTSTART property? | +| +---------------------------------------------------------------+ +| | VPOLL has the DURATION property? | +| | +-----------------------------------------------------------+ +| | | VPOLL has the DTEND property? | +| | | +-------------------------------------------------------+ +| | | | VPOLL has the COMPLETED property? | +| | | | +---------------------------------------------------+ +| | | | | VPOLL has the CREATED property? | +| | | | | +-----------------------------------------------+ +| | | | | | Condition to evaluate | ++---+---+---+---+---+-----------------------------------------------+ +| Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | +| | | | | | ((end > DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+ +
+ +Security Considerations +

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs.

+
+IANA ConsiderationsParameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in 8.2.4:

+ + + + + + + + + + + + + + + + + + + + +
Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+ +

+
+

STAY-INFORMED

+
+

Current

+
+

+ +

+
+Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in 8.2.3:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+ +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+ +

+
+

POLL-MODE

+
+

Current

+
+

+ +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+ +

+
+

POLL-WINNER

+
+

Current

+
+

+ +

+
+

RESPONSE

+
+

Current

+
+

+ +

+
+POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+
+
Poll mode name
+
+

The name of the poll mode.

+
+
Purpose
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
Reference
+
+

A reference to the RFC in which the poll mode is defined

+
+
+POLL-MODE Registrations

This document defines the following registered poll modes.

+ + + + + + + + + + + + + + + +
Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+ + +
Open issues

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven’t voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No — voter + has indicated now unable to attend — want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user’s isn’t the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can’t create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event — winning properties ONLY are merged in to the real event.

+

Need to write down what isn’t valid in a VPOLL
+ a. Can’t change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? — some iTip notes On confirm — send itip if appropriate (PUBLISH) +  — all non-participating — shared — feeds + Organizer can specify where result is? + Confirm can specify that itip is sent — ITIP / NONE — parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:douglm@mysite.edu +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:VFREEBUSY +....... +END:VFREEBUSY +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+Change log +
+
Calext V01: 2019-10-17 MD
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
Calext V00: 2019-05-17 MD
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
V03: 2014-10-28 MD
+
+
    +
  • +

    Add VVOTER and VOTE components.

    +
  • +
  • +

    Add RESPONSE property.

    +
  • +
  • +

    Remove RESPONSE parameter from VOTER.

    +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +

    Add reply-url property and required parameter.

    +
  • +
  • +

    Fix ACCEPT-RESPONSE definition.

    +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +

    Typos fixed, clarifications made.

    +
  • +
  • +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
  • +
  • +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
  • +
  • +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
  • +
  • +

    iTip: fix broken table cells

    +
  • +
  • +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
  • +
  • +

    Added Caldav scheduling section

    +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +

    Removed method CONFIRM

    +
  • +
  • +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
  • +
  • +

    Added POLL-WINNER and verbiage

    +
  • +
  • +

    Added STATUS values

    +
  • +
  • +

    Added RELTYPE=POLL

    +
  • +
  • +

    Added supported-vpoll-component-sets

    +
  • +
  • +

    Added CalDAV related parameters to VOTER

    +
  • +
  • +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
Normative references

The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

2020-07-16 HTTP Extensions for Distributed Authoring — WEBDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2518.xml https://www.rfc-editor.org/info/rfc2518 RFC 2518 RFC2518 10.17487/RFC2518 1999-02 Y. Goland Internet Engineering Task Force IETF E. Whitehead Internet Engineering Task Force IETF A. Faizi Internet Engineering Task Force IETF S. Carter Internet Engineering Task Force IETF D. Jensen Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] RFC 2518 Fremont, CA 2020-07-16 Uniform Resource Identifier (URI): Generic Syntax https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.3986.xml https://www.rfc-editor.org/info/rfc3986 RFC 3986 RFC3986 10.17487/RFC3986 2005-01 T. Berners-Lee Internet Engineering Task Force IETF R. Fielding Internet Engineering Task Force IETF L. Masinter Internet Engineering Task Force IETF Internet Engineering Task Force IETF en A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] STD 66 RFC 3986 Fremont, CA 2020-07-16 Calendaring Extensions to WebDAV (CalDAV) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.4791.xml https://www.rfc-editor.org/info/rfc4791 RFC 4791 RFC4791 10.17487/RFC4791 2007-03 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF L. Dusseault Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the “calendar-access” feature of CalDAV. [STANDARDS-TRACK] RFC 4791 Fremont, CA 2020-07-16 Internet Calendaring and Scheduling Core Object Specification (iCalendar) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5545.xml https://www.rfc-editor.org/info/rfc5545 RFC 5545 RFC5545 10.17487/RFC5545 2009-09 B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] RFC 5545 Fremont, CA 2020-07-16 iCalendar Transport-Independent Interoperability Protocol (iTIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5546.xml https://www.rfc-editor.org/info/rfc5546 RFC 5546 RFC5546 10.17487/RFC5546 2009-12 C. Daboo Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] RFC 5546 Fremont, CA 2020-07-16 iCalendar Message-Based Interoperability Protocol (iMIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6047.xml https://www.rfc-editor.org/info/rfc6047 RFC 6047 RFC6047 10.17487/RFC6047 2010-12 A. Melnikov Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document, “iCalendar Message-Based Interoperability Protocol (iMIP)”, specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] RFC 6047 Fremont, CA 2020-07-16 Scheduling Extensions to CalDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6638.xml https://www.rfc-editor.org/info/rfc6638 RFC 6638 RFC6638 10.17487/RFC6638 2012-06 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) “calendar-access” feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the “calendar-auto-schedule” feature of CalDAV. [STANDARDS-TRACK] RFC 6638 Fremont, CA 2020-07-30 Event Publishing Extensions to iCalendar https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-calext-eventpub-extensions.xml http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.txt http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.pdf I-D.ietf-calext-eventpub-extensions I-D.ietf-calext-eventpub-extensions draft-ietf-calext-eventpub-extensions-15 2019-10 Michael Douglass Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This specification updates RFC5545 by introducing a number of new iCalendar properties and components which are of particular use for event publishers and in social networking. This specification also defines a new STRUCTURED-DATA property for iCalendar RFC5545 to allow for data that is directly pertinent to an event or task to be included with the calendar data. Internet-Draft draft-ietf-calext-eventpub-extensions-15 Fremont, CA
+Bibliography +
+
diff --git a/documents/draft-ietf-calext-vpoll.html b/documents/draft-ietf-calext-vpoll.html new file mode 100644 index 0000000..e3bbd4f --- /dev/null +++ b/documents/draft-ietf-calext-vpoll.html @@ -0,0 +1,9150 @@ + + + + + + +VPOLL: Consensus Scheduling Component for iCalendar + + + + + + + + + + + + + + + + + + + + + + + + +
Internet-DraftVPOLLJuly 2020
York, et al.Expires 31 January 2021[Page]
+
+
+
+
Workgroup:
+
Network Working Group
+
Internet-Draft:
+
draft-ietf-calext-vpoll-00
+
:
+
+
Published:
+
+ +
+
Intended Status:
+
Standards Track
+
Expires:
+
+
Authors:
+
+
+
E. York
+
+
+
C. Daboo
+
+
+
M. Douglass
+
+
+
+
+

VPOLL: Consensus Scheduling Component for iCalendar

+
+
+

Abstract

+
+

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+
+
+
+
+
+

+Status of This Memo +

+

+ This Internet-Draft is submitted in full conformance with the + provisions of BCP 78 and BCP 79.

+

+ Internet-Drafts are working documents of the Internet Engineering Task + Force (IETF). Note that other groups may also distribute working + documents as Internet-Drafts. The list of current Internet-Drafts is + at https://datatracker.ietf.org/drafts/current/.

+

+ Internet-Drafts are draft documents valid for a maximum of six months + and may be updated, replaced, or obsoleted by other documents at any + time. It is inappropriate to use Internet-Drafts as reference + material or to cite them other than as "work in progress."

+

+ This Internet-Draft will expire on 31 January 2021.

+
+
+ +
+
+

+Table of Contents +

+ +
+
+
+
+

+1. Acknowledgements +

+
+

The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support.

+
+
+
+
+
+

+2. Introduction +

+
+

The currently existing approach to agreeing on meeting times using +iTip [RFC5546] and/or iMip [RFC6047] has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+
+
+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+
+
+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+
+
+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+
+
+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+
+
+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+
+
+
+
+
+

+3. Terms and definitions +

+
+

For the purposes of this document, + the following terms and definitions apply.

+
+
+
+

+3.1. consensus scheduling +

+
+

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+
+
+
+
+

+3.2. active Vpoll +

+
+

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+
+
+
+
+

+3.3. voter +

+
+

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+
+
+
+
+
+
+

+4. Simple Consensus Scheduling +

+
+

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+
+
+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+
+
+
+

+4.1. The VPOLL Component: An Overview +

+
+

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
+
+
DTSTAMP
+
+
+

The usual [RFC5545] property.

+
+
+
+
SEQUENCE
+
+
+

The usual [RFC5545] property. See below for SEQUENCE +behavior.

+
+
+
+
UID
+
+
+

The usual [RFC5545] property.

+
+
+
+
ORGANIZER
+
+
+

The usual [RFC5545] property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
+
+
SUMMARY
+
+
+

The usual [RFC5545] property. This optional but +recommended property provides the a short title to the poll.

+
+
+
+
DESCRIPTION
+
+
+

The usual [RFC5545] property. This optional property +provides more details.

+
+
+
+
DTEND
+
+
+

The usual [RFC5545] property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
+
+
POLL-MODE
+
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives.

+
+
+
+
POLL-COMPLETION
+
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice.

+
+
+
+
POLL-PROPERTIES
+
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
+
+
PARTICIPANT
+
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
+
+
VOTE
+
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
+
+
VEVENT
+
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+
+
+
+
+

EXAMPLE

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD:REQUEST
+BEGIN:VPOLL
+POLL-MODE:BASIC
+POLL-COMPLETION:SERVER-SUBMIT
+POLL-PROPERTIES:DTSTART,LOCATION
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T000000Z
+SUMMARY:What to do this week
+DTEND:20120101T000000Z
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+END PARTICIPANT
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+END PARTICIPANT
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:mike@example.com
+END PARTICIPANT
+BEGIN:VEVENT.......(with a poll-item-id=1)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=2)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=3)
+END:VEVENT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 1
+
+
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+
+
+
+
+
+

+4.2. The VPOLL Alternative Choices: An Overview +

+
+

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard [RFC5545] components. For our +simple use case they are all VEVENT components. In addition to the +usual [RFC5545] properties some extra properties are used for a +VPOLL.

+
+
+
+
POLL-ITEM-ID
+
+
+

This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer.

+
+
+
+
+
+
+
+
+
+

+4.3. VPOLL responses +

+
+

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
+
+
DTSTAMP
+
+
+

The usual [RFC5545] property.

+
+
+
+
SEQUENCE
+
+
+

The usual [RFC5545] property. See below for SEQUENCE +behavior.

+
+
+
+
UID
+
+
+

Same as the request.

+
+
+
+
ORGANIZER
+
+
+

Same as the request.

+
+
+
+
SUMMARY
+
+
+

Same as the request.

+
+
+
+
PARTICIPANT
+
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
+
+
VOTE
+
+
+

One per item being voted on.

+
+
+
+
POLL-ITEM-ID
+
+
+

One inside each VOTE component to identify the choice.

+
+
+
+
RESPONSE
+
+
+

One inside each VOTE component to specify the vote.

+
+
+
+
+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
+
+
NOTE
+
+
+

This is poll-mode specific behavior?

+
+
+
+
+
+
+

EXAMPLE

+
+
+

REPLY VPOLL from Cyrus:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: REPLY
+BEGIN:VPOLL
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T010000Z
+SUMMARY:What to do this week
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+BEGIN:VOTE
+POLL-ITEM-ID:1
+RESPONSE:50
+COMMENT:Work on iTIP
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+COMMENT:Work on WebDAV
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 2
+
+
+
+
+
+

+4.4. VPOLL updates +

+
+

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+
+
+

EXAMPLE

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: POLLSTATUS
+BEGIN:VPOLL
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T020000Z
+SEQUENCE:0
+SUMMARY:What to do this week
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+BEGIN: VOTE
+POLL-ITEM-ID:1
+RESPONSE:50
+COMMENT:Work on iTIP
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+COMMENT:Work on WebDAV
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+BEGIN:VOTE
+POLL-ITEM-ID:1
+RESPONSE:100
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 3
+
+
+
+
+
+

+4.5. VPOLL Completion +

+
+

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+
+
+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED".

+
+
+

EXAMPLE

+
+
+

VPOLL confirmation:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: REQUEST
+BEGIN:VPOLL
+ORGANIZER:mailto:douglm@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T030000Z
+COMPLETED:20120101T030000Z
+POLL-COMPLETION:SERVER-SUBMIT
+SEQUENCE:0
+SUMMARY:What to do this week
+STATUS:CONFIRMED
+POLL-WINNER:3
+BEGIN:VEVENT.......(with a poll-item-id=1)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=2)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=3)
+END:VEVENT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 4
+
+
+
+
+
+

+4.6. Other Responses +

+
+

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+
+
+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+
+
+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+
+
+
+
+
+
+
+

+5. iCalendar Extensions +

+
+
+

+5.1. Updated Participant Type Value +

+
+

Participant type property values are defined in section 11.2.1. of +[I-D.ietf-calext-eventpub-extensions]. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
partvalue       /= "VOTER"
+
+
Figure 5
+
+
+
+
Description
+
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+
+
+
+
+
+
+
+

+5.2. Updated Relation Type Value +

+
+

Relationship parameter type values are defined in section 3.2.15. of +[RFC5545]. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
reltypeparam       /= "RELTYPE" "=" "POLL"
+; Property value is a VPOLL uid
+
+
Figure 6
+
+
+
+
Description
+
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+
+
+
+
+
+
+
+

+5.3. Updated Status Value +

+
+

Status property values are defined in section 3.8.1.11. of [RFC5545]. +This specification updates that type to define valid VPOLL status +values.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
statvalue /= statvalue-poll
+   ; Status values for "VPOLL".
+statvalue-poll = "IN-PROCESS"
+          / "COMPLETED"  ; Poll has closed,
+                         ; nothing has been chosen yet
+          / "CONFIRMED"  ; Poll has closed and
+                         ; winning items confirmed
+          / "SUBMITTED"  ; The winning item has been
+                         ; submitted
+          / "CANCELLED"
+
+
Figure 7
+
+
+
+
Description
+
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
+
+
+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
Figure 8
+
+
+
+
+
+
+
+
+
+

+5.4. New Property Parameters +

+
+
+

+5.4.1. Required +

+
+
+
Parameter name
+
+
+

REQUIRED

+
+
+
+
Purpose
+
+
+

To specify whether the associated property is required in +the current context.

+
+
+
+
Format Definition
+
+
+

This parameter is defined by the following notation:

+
+
+
+
+
+
+
+
+
requirededparam = "REQUIRED"  "=" ("TRUE" / "FALSE")
+  ; Default is FALSE
+
+
Figure 9
+
+
+
+
Description
+
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+
+
+
+
+
+
+
+

+5.4.2. Stay-Informed +

+
+
+
Parameter name
+
+
+

STAY-INFORMED

+
+
+
+
Purpose
+
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
+
+
Format Definition
+
+
+

This parameter is defined by the following notation:

+
+
+
+
+
+
+
+
+
stayinformedparam = "STAY-INFORMED"  "=" ("TRUE" / "FALSE")
+                  ; Default is FALSE
+
+
Figure 10
+
+
+
+
Description
+
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+
+
+
+
+
+
+
+
+
+

+5.5. New Properties +

+
+
+

+5.5.1. Accept-Response +

+
+
+
Property name
+
+
+

ACCEPT-RESPONSE

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+
+
+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":"
+                    iana-token ("," iana-token) CRLF
+
+acceptresponseparams = *(";" other-param)
+
+
Figure 11
+
+
+
+
+
+

+5.5.2. Poll-Completion +

+
+
+
Property name
+
+
+

POLL-COMPLETION

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
+
+
Description
+
+
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

+
+
+

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+
+
+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+
+
+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF
+
+pcparam = *(";" other-param)
+
+pcvalue = "SERVER"  ; The server is responsible for both choosing and
+                   ; submitting the winner(s)
+        / "SERVER-SUBMIT" ; The server is responsible for
+                   ; submitting the winner(s). The client chooses.
+        / "SERVER-CHOICE"  ; The server is responsible for
+                   ; choosing the winner(s). The client will submit.
+        / "CLIENT" ; The client is responsible for both choosing and
+                   ; submitting the winner(s)
+        / iana-token
+        / x-name
+        ;Default is CLIENT
+
+
Figure 12
+
+
+
+
Example
+
+
+

The following is an example of this property:

+
+
+
+
+
+
+
+
+
POLL-COMPLETION: SERVER-SUBMIT
+
+
Figure 13
+
+
+
+
+
+

+5.5.3. Poll-Item-Id +

+
+
+
Property name
+
+
+

POLL-ITEM-ID

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL child components as an +identifier.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Property Parameters
+
+
+

Non-standard parameters can be specified on +this property.

+
+
+
+
Conformance
+
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
+
+
Description
+
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+
+
+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollitemid = "POLL-ITEM-ID" pollitemdparams ":"
+                  integer CRLF
+
+pollitemidparams = *(
+                   (";" other-param)
+            )
+
+
Figure 14
+
+
+
+
+
+

+5.5.4. Poll-Mode +

+
+
+
Property name
+
+
+

POLL-MODE

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
+
+
Description
+
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+
+
+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollmode = "POLL-MODE" pollmodeparams ":"
+             ("BASIC" / iana-token / other-token) CRLF
+
+pollmodeparams = *(";" other-param)
+
+
Figure 15
+
+
+
+
+
+

+5.5.5. Poll-properties +

+
+
+
Property name
+
+
+

POLL-PROPERTIES

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollproperties = "POLL-PROPERTIES" pollpropparams ":"
+             text *("," text) CRLF
+
+pollpropparams = *(";" other-param)
+
+
Figure 16
+
+
+
+
+
+

+5.5.6. Poll-Winner +

+
+
+
Property name
+
+
+

POLL-WINNER

+
+
+
+
Purpose
+
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Property Parameters
+
+
+

Non-standard parameters can be specified on +this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollwinner = "POLL-WINNER" pollwinnerparams ":"
+                 integer CRLF
+
+pollwinnerparams = *(";" other-param)
+
+       ; Used with a STATUS:CONFIRMED VPOLL to indicate which
+       ; components have been confirmed
+
+
Figure 17
+
+
+
+
+
+

+5.5.7. Reply-URL +

+
+
+
Property name
+
+
+

REPLY-URL

+
+
+
+
Purpose
+
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
+
+
Property Parameters
+
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF
+
+reply-urlparams = *(
+                  (";" requiredparam) /
+                  (";" other-param)
+                  )
+
+
Figure 18
+
+
+
+
+
+

+5.5.8. Response +

+
+
+
Property name
+
+
+

RESPONSE

+
+
+
+
Purpose
+
+
+

To specify a response vote.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
response = "RESPONSE" response-params ":" integer CRLF
+                 ; integer value 0..100
+
+responseparams = *(";" other-param)
+
+
Figure 19
+
+
+
+
Description
+
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
+
    +
  • +
    +

    0 - 39 A "NO vote"

    +
    +
  • +
  • +
    +

    40 - 79 A "MAYBE" vote

    +
    +
  • +
  • +
    +

    80 - 89 A "YES - but not preferred vote"

    +
    +
  • +
  • +
    +

    90-100 A "YES" vote.

    +
    +
    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
    +
  • +
+
+
+
+
+
+
+
+
+
+
+

+5.6. New Components +

+
+
+

+5.6.1. VPOLL Component +

+
+
+
Component name
+
+
+

VPOLL

+
+
+
+
Purpose
+
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollc    = "BEGIN" ":" "VPOLL" CRLF
+            pollprop
+            *participantc *eventc *todoc *journalc *freebusyc
+            *availabilityc *alarmc *iana-comp *x-comp
+            "END" ":" "VPOLL" CRLF
+
+pollprop = *(
+          ;
+          ; The following are REQUIRED,
+          ; but MUST NOT occur more than once.
+          ;
+          dtstamp / uid / organizer /
+          ;
+          ; The following are OPTIONAL,
+          ; but MUST NOT occur more than once.
+          ;
+          acceptresponse / class / created / completed /
+          description / dtstart / last-mod / pollmode /
+          pollproperties / priority / seq / status /
+          summary / url /
+          ;
+          ; Either 'dtend' or 'duration' MAY appear in
+          ; a 'pollprop', but 'dtend' and 'duration'
+          ; MUST NOT occur in the same 'pollprop'.
+          ; 'duration' MUST only occur when 'dtstart'
+          ; is present
+          ;
+          dtend / duration /
+          ;
+          ; The following are OPTIONAL,
+          ; and MAY occur more than once.
+          ;
+          attach / categories / comment /
+          contact / rstatus / related /
+          resources / x-prop / iana-prop
+          ;
+          ; The following is OPTIONAL, it SHOULD appear
+          ; once for the confirmation of a BASIC mode
+          ; VPOLL. Other modes may define differing
+          ; requirements.
+          ;
+          pollwinner /
+          ;
+          )
+
+
Figure 20
+
+
+
+
Description
+
+
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

+
+
+

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+
+
+

If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+
+
+

If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+
+
+

"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+
+
+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+
+
+
+
+
+
+
+
+

+5.6.2. VOTE Component +

+
+
+
Component name
+
+
+

VOTE

+
+
+
+
Purpose
+
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
+
+
Conformance
+
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
votec     = "BEGIN" ":" "VOTE" CRLF
+            voteprop
+            *eventc *todoc *journalc *freebusyc
+            *availabilityc *alarmc *iana-comp *x-comp
+            "END" ":" "VOTE" CRLF
+
+voteprop = *(
+           ;
+           ; The following are REQUIRED,
+           ; but MUST NOT occur more than once.
+           ;
+           pollitemid / response /
+           ;
+           ; The following are OPTIONAL,
+           ; and MAY occur more than once.
+           ;
+           comment / x-prop / iana-prop
+           ;
+           )
+
+
Figure 21
+
+
+
+
Description
+
+
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

+
+
+

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+
+
+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+
+
+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.

+
+
+
+
+
+
+
+
+
+
+
+
+
+

+6. Poll Modes +

+
+

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+
+
+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see Section 10.3) in a published RFC.

+
+
+
+

+6.1. POLL-MODE:BASIC +

+
+

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+
+
+
+

+6.1.1. Property restrictions +

+
+

This poll mode has the following property requirements:

+
+
+
+
POLL-ITEM-ID
+
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
+
+
POLL-WINNER
+
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+
+
+
+
+
+
+
+

+6.1.2. Outcome reporting +

+
+

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+
+
+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+
+
+
+
+
+
+
+
+
+

+7. iTIP Extensions +

+
+

This specification introduces a number of extensions to [RFC5546]. +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+
+
+

For many of the iTip processing rules the voters take the place of +attendees.

+
+
+
+

+7.1. Methods +

+
+

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1
MethodDescription
+
+

PUBLISH

+
+
+
+

No changes (yet)

+
+
+
+

REQUEST

+
+
+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+
+
+

REPLY

+
+
+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+
+
+

ADD

+
+
+
+

Not supported for VPOLL.

+
+
+
+

CANCEL

+
+
+
+

There MUST be a single VPOLL component with UID

+
+
+
+

matching that of the poll being cancelled.

+
+
+
+

REFRESH

+
+
+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+
+
+

COUNTER

+
+
+
+

Not supported for VPOLL.

+
+
+
+

DECLINECOUNTER

+
+
+
+

Not supported for VPOLL.

+
+
+
+

POLLSTATUS

+
+
+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+
+
+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+
+
+ + + + + + + + + + + + + + + + + + +
Table 2
OriginatorMethods
+
+

Organizer

+
+
+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+
+
+

Voter

+
+
+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+
+
+
+
+
+
+

+7.2. Interoperability Models +

+
+

Most of the standard iTip specification applies with respect to +organizer and voters.

+
+
+
+

+7.2.1. Delegation +

+
+

TBD

+
+
+
+ +
+
+

+7.2.3. Component Revisions +

+
    +
  • +
    +

    Need to talk about what a change in SEQUENCE means

    +
    +
  • +
  • +
    +

    Sequence change forces a revote.

    +
    +
  • +
  • +
    +

    New voter - no sequence change

    +
    +
  • +
  • +
    +

    Add another poll set or change poll item ids or any change to a child

    +
    +
  • +
  • +
    +

    component - bump sequence

    +
    +
  • +
+
+
+
+
+

+7.2.4. Message Sequencing +

+
+

TBD

+
+
+
+
+
+
+
+

+7.3. Application Protocol Elements +

+
+
+

+7.3.1. Methods for VPOLL Calendar Components +

+
+

This section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+
+
+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3
Presence ValueDescription
+
+

1

+
+
+
+

One instance MUST be present.

+
+
+
+

1+

+
+
+
+

At least one instance MUST be present.

+
+
+
+

0

+
+
+
+

Instances of this property MUST NOT be present.

+
+
+
+

0+

+
+
+
+

Multiple instances MAY be present.

+
+
+
+

0 or 1

+
+
+
+

Up to 1 instance of this property MAY be present.

+
+
+
+
+

The following summarizes the methods that are defined for the "VPOLL" +calendar component.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4
MethodDescription
+
+

PUBLISH

+
+
+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+
+
+

REQUEST

+
+
+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+
+
+

REPLY

+
+
+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+
+
+

CANCEL

+
+
+
+

Cancel a poll.

+
+
+
+

REFRESH

+
+
+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+
+
+

POLLSTATUS

+
+
+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+
+
+
+
+
+
+

+7.3.2. Method: PUBLISH +

+
+

The "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component.

+
+
+
+
Note
+
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+
+
+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 5: +Constraints for a METHOD:PUBLISH of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST equal PUBLISH.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0 or 1

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0 or 1

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

PARTICIPANT

+
+
+
+

0+

+
+
+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTODO

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+
+
+
+
+

+7.3.3. Method: REQUEST +

+
+

The "REQUEST" method in a "VPOLL" component provides the following +scheduling functions:

+
+
    +
  • +
    +

    Invite "Voters" to respond to the poll.

    +
    +
  • +
  • +
    +

    Change the items being voted upon.

    +
    +
  • +
  • +
    +

    Complete or confirm the poll.

    +
    +
  • +
  • +
    +

    Response to a "REFRESH" request.

    +
    +
  • +
  • +
    +

    Update the details of an existing vpoll.

    +
    +
  • +
  • +
    +

    Update the status of "Voters".

    +
    +
  • +
  • +
    +

    Forward a "VPOLL" to another uninvited CU.

    +
    +
  • +
  • +
    +

    For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU.

    +
    +
  • +
  • +
    +

    For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU.

    +
    +
  • +
+
+

The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer".

+
+
+

The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component.

+
+
+

For the "REQUEST" method only a single iCalendar object is permitted.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 6: +Constraints for a METHOD:REQUEST of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REQUEST.

+
+
+
+

VPOLL

+
+
+
+

1

+
+
+
+

PARTICIPANT

+
+
+
+

1+

+
+
+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0 or 1

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTODO

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+
+
+
+7.3.3.1. Rescheduling a poll +
+
+

The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll.

+
+
+
+
+
+
+7.3.3.2. Updating or Reconfirmation of a Poll +
+
+

The "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method

+
+
+

describes an update of the poll details, but not a rescheduling of +the POLL.

+
+
+

The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll.

+
+
+

The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.

+
+
+
+
+
+
+7.3.3.3. Confirmation of a Poll +
+
+

The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+
+
+
+
+
+7.3.3.4. Closing a Poll +
+
+

The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+
+
+
+
+
+7.3.3.5. Delegating a Poll to Another CU +
+
+

Some calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU.

+
+
+

The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above.

+
+
+

In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY"

+
+
+

method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address.

+
+
+

The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".

+
+
+
+
+
+
+7.3.3.6. Changing the Organizer +
+
+

The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer".

+
+
+
+
+
+
+7.3.3.7. Sending on Behalf of the Organizer +
+
+

There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer".

+
+
+
+
+
+
+7.3.3.8. Forwarding to an Uninvited CU +
+
+

A "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU.

+
+
+

The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll.

+
+
+

If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added.

+
+
+

When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.

+
+
+
+
+
+
+7.3.3.9. Updating Voter Status +
+
+

The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST".

+
+
+
+
+
+
+
+

+7.3.4. Method: REPLY +

+
+

The "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property.

+
+
+

The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed.

+
+
+

The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter".

+
+
+

A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value.

+
+
+

The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter.

+
+
+

The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 7: +Constraints for a METHOD:REPLY of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REPLY.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

All components MUST have the same

+
+
+
+

UID.

+
+
+
+

PARTICIPANT

+
+
+
+

1

+
+
+
+

Identifies the Voter replying.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID of the original

+
+
+
+

REQUEST.

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

1+

+
+
+
+

One per item being voted on.

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

SUMMARY

+
+
+
+

0 or 1

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0 or 1

+
+
+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+
+
+

VAVAILABILITY

+
+
+
+

0

+
+
+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.5. Method: CANCEL +

+
+

The "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll.

+
+
+

The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each.

+
+
+

When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in Section 7.2.3.

+
+
+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 8: +Constraints for a METHOD:CANCEL of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be CANCEL.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

All must have the same UID.

+
+
+
+

PARTICIPANT

+
+
+
+

0+

+
+
+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID of the original REQUEST.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+
+
+

SUMMARY

+
+
+
+

0 or 1

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.6. Method: REFRESH +

+
+

The "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 9: +Constraints for a METHOD:REFRESH of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REFRESH.

+
+
+
+

VPOLL

+
+
+
+

1

+
+
+
+

PARTICIPANT

+
+
+
+

1

+
+
+
+

MUST identify the requester as a voter.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID associated with original REQUEST.

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

ATTACH

+
+
+
+

0

+
+
+
+

CATEGORIES

+
+
+
+

0

+
+
+
+

CLASS

+
+
+
+

0

+
+
+
+

CONTACT

+
+
+
+

0

+
+
+
+

CREATED

+
+
+
+

0

+
+
+
+

DESCRIPTION

+
+
+
+

0

+
+
+
+

DTEND

+
+
+
+

0

+
+
+
+

DTSTART

+
+
+
+

0

+
+
+
+

DURATION

+
+
+
+

0

+
+
+
+

GEO

+
+
+
+

0

+
+
+
+

LAST-MODIFIED

+
+
+
+

0

+
+
+
+

LOCATION

+
+
+
+

0

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0

+
+
+
+

RELATED-TO

+
+
+
+

0

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

RESOURCES

+
+
+
+

0

+
+
+
+

SEQUENCE

+
+
+
+

0

+
+
+
+

STATUS

+
+
+
+

0

+
+
+
+

SUMMARY

+
+
+
+

0

+
+
+
+

URL

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.7. Method: POLLSTATUS +

+
+

The "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 10: +Constraints for a METHOD:POLLSTATUS of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST equal POLLSTATUS.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

PARTICIPANT

+
+
+
+

1+

+
+
+
+

The voters containing their current vote

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

Only present for a completed poll

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

ATTACH

+
+
+
+

0

+
+
+
+

CATEGORIES

+
+
+
+

0

+
+
+
+

CLASS

+
+
+
+

0

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

CONTACT

+
+
+
+

0

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+
+
+
+
+
+
+
+
+

+8. CalDAV Extensions +

+
+

This specification extends [RFC4791] in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+
+
+

Additionally, it extends [RFC6638] as it a VPOLL component is a +schedulable entity.

+
+
+
+

+8.1. Calendar Collection Properties +

+
+

This section defines new CalDAV properties for calendar collections.

+
+
+
+

+8.1.1. CALDAV:supported-vpoll-component-sets +

+
+
+
Name
+
+
+

supported-vpoll-component-sets

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

+
+
+

It also specifies the combination of allowed component types.

+
+
+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition Section 8.2 being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT supported-vpoll-component-sets
+     (supported-vpoll-component-set*) >
+
+<!ELEMENT supported-vpoll-component-set (comp+)>
+
+
Figure 22
+
+
+
+
+
<C:supported-vpoll-component-sets
+     xmlns:C="urn:ietf:params:xml:ns:caldav">
+
+  <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VEVENT" />
+    <C:comp name="VFREEBUSY" />
+    <C:comp name="VTODO" />
+  </C:supported-vpoll-component-set>
+
+  <!-- VPOLLs with just VEVENT or VFREEBUSY -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VEVENT" />
+    <C:comp name="VFREEBUSY" />
+  </C:supported-vpoll-component-set>
+
+  <!-- VPOLLs with just VEVENT -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VEVENT" />
+  </C:supported-vpoll-component-set>
+
+  <!-- VPOLLs with just VTODO -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VTODO" />
+  </C:supported-vpoll-component-set>
+</C:supported-vpoll-component-sets>
+
+
Figure 23
+
+
+
+
+
+

+8.1.2. CALDAV:vpoll-max-items +

+
+
+
Name
+
+
+

vpoll-max-items

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition +Section 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT vpoll-max-items (#PCDATA)>
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 24
+
+
+
+
+
<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav"
+>25</C:vpoll-max-items>
+
+
Figure 25
+
+
+
+
+
+

+8.1.3. CALDAV:vpoll-max-active +

+
+
+
Name
+
+
+

vpoll-max-active

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition +Section 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT vpoll-max-active (#PCDATA)>
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 26
+
+
+
+
+
<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav"
+>25</C:vpoll-max-active>
+
+
Figure 27
+
+
+
+
+
+

+8.1.4. CALDAV:vpoll-max-voters +

+
+
+
Name
+
+
+

+vpoll-max-voters

+
+
+
+
Namespace
+
+
+

+urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition Section 8.2 +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT vpoll-max-voters (#PCDATA)>
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 28
+
+
+
+
+
<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav"
+>25</C:vpoll-max-voters>
+
+
Figure 29
+
+
+
+ +
+
+

+8.1.6. Extensions to CalDAV scheduling +

+
+

This specification extends [RFC6638].

+
+
+

Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL.

+
+
+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+
+
+
+
+
+
+
+

+8.2. Additional Preconditions for PUT, COPY, and MOVE +

+
+

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+
+
+

The new preconditions are:

+
+
+
+
(CALDAV:supported-vpoll-component-sets)
+
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
+
+
(CALDAV:vpoll-max-items)
+
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value Section 8.1.2 +on the calendar collection where the resource will be stored;

+
+
+
+
(CALDAV:vpoll-max-active)
+
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value +Section 8.1.3 on the calendar collection where the resource will +be stored;

+
+
+
+
(CALDAV:vpoll-max-voters)
+
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value Section 8.1.4 on the +calendar collection where the resource will be stored;

+
+
+
+
+
+
+
+
+
+

+8.3. CalDAV:calendar-query Report +

+
+

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+
+
+
+

+8.3.1. Example: Partial Retrieval of VPOLL +

+
+

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+
+
+
+
+
>> Request <<
+
+REPORT /cyrus/work/ HTTP/1.1
+Host: cal.example.com
+Depth: 1
+Content-Type: application/xml; charset="utf-8"
+Content-Length: xxxx
+
+<?xml version="1.0" encoding="utf-8" ?>
+<C:calendar-query xmlns:D="DAV:"
+              xmlns:C="urn:ietf:params:xml:ns:caldav">
+  <D:prop>
+    <D:getetag/>
+    <C:calendar-data>
+      <C:comp name="VCALENDAR">
+        <C:prop name="VERSION"/>
+        <C:comp name="VPOLL">
+          <C:prop name="SUMMARY"/>
+          <C:prop name="UID"/>
+          <C:prop name="DTSTART"/>
+          <C:prop name="DTEND"/>
+          <C:prop name="DURATION"/>
+        </C:comp>
+
+      </C:comp>
+    </C:calendar-data>
+  </D:prop>
+  <C:filter>
+    <C:comp-filter name="VCALENDAR">
+      <C:comp-filter name="VPOLL">
+        <C:time-range start="20121204T000000Z"
+                      end="20121205T000000Z"/>
+      </C:comp-filter>
+    </C:comp-filter>
+  </C:filter>
+</C:calendar-query>
+
+>> Response <<
+
+HTTP/1.1 207 Multi-Status
+Date: Sat, 11 Nov 2012 09:32:12 GMT
+Content-Type: application/xml; charset="utf-8"
+Content-Length: xxxx
+
+<?xml version="1.0" encoding="utf-8" ?>
+<D:multistatus xmlns:D="DAV:"
+           xmlns:C="urn:ietf:params:xml:ns:caldav">
+  <D:response>
+    <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href>
+    <D:propstat>
+      <D:prop>
+        <D:getetag>"fffff-abcd2"</D:getetag>
+        <C:calendar-data>BEGIN:VCALENDAR
+VERSION:2.0
+BEGIN:VPOLL
+DTSTART;TZID=US/Eastern:20121202T120000
+DURATION:PT4D
+SUMMARY:Poll #2
+UID:00959BC664CA650E933C892C@example.com
+END:VPOLL
+END:VCALENDAR
+</C:calendar-data>
+      </D:prop>
+      <D:status>HTTP/1.1 200 OK</D:status>
+    </D:propstat>
+  </D:response>
+  <D:response>
+    <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href>
+    <D:propstat>
+      <D:prop>
+        <D:getetag>"fffff-abcd3"</D:getetag>
+        <C:calendar-data>BEGIN:VCALENDAR
+
+VERSION:2.0
+PRODID:-//Example Corp.//CalDAV Client//EN
+BEGIN:VPOLL
+DTSTART;TZID=US/Eastern:20121204T100000
+DURATION:PT4D
+SUMMARY:Poll #3
+UID:DC6C50A017428C5216A2F1CD@example.com
+END:VPOLL
+END:VCALENDAR
+</C:calendar-data>
+      </D:prop>
+      <D:status>HTTP/1.1 200 OK</D:status>
+    </D:propstat>
+  </D:response>
+</D:multistatus>
+
+
Figure 30
+
+
+
+
+
+
+
+

+8.4. CalDAV time ranges +

+
+

"CALDAV:time-range XML Element" in [RFC4791] describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends [RFC4791] to +describe the meaning of time ranges for VPOLL

+
+
+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

+
+
+
+
+
+-------------------------------------------------------------------+
+| VPOLL has the DTSTART property?                                   |
+|   +---------------------------------------------------------------+
+|   |   VPOLL has the DURATION property?                            |
+|   |   +-----------------------------------------------------------+
+|   |   | VPOLL has the DTEND property?                             |
+|   |   |   +-------------------------------------------------------+
+|   |   |   | VPOLL has the COMPLETED property?                     |
+|   |   |   |   +---------------------------------------------------+
+|   |   |   |   | VPOLL has the CREATED property?                   |
+|   |   |   |   |   +-----------------------------------------------+
+|   |   |   |   |   | Condition to evaluate                         |
++---+---+---+---+---+-----------------------------------------------+
+| Y | Y | N | * | * | (start  <= DTSTART+DURATION)  AND             |
+|   |   |   |   |   | ((end   >  DTSTART)  OR                       |
+|   |   |   |   |   |  (end   >= DTSTART+DURATION))                 |
++---+---+---+---+---+-----------------------------------------------+
+| Y | N | Y | * | * | ((start <  DTEND)    OR  (start <= DTSTART))  |
+|   |   |   |   |   | AND                                           |
+|   |   |   |   |   | ((end   >  DTSTART)  OR  (end   >= DTEND))    |
++---+---+---+---+---+-----------------------------------------------+
+| Y | N | N | * | * | (start  <= DTSTART)  AND (end >  DTSTART)     |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | Y | * | * | (start  <  DTEND)    AND (end >= DTEND)       |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | Y | Y | ((start <= CREATED)  OR  (start <= COMPLETED))|
+|   |   |   |   |   | AND                                           |
+|   |   |   |   |   | ((end   >= CREATED)  OR  (end   >= COMPLETED))|
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | Y | N | (start  <= COMPLETED) AND (end  >= COMPLETED) |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | N | Y | (end    >  CREATED)                           |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | N | N | TRUE                                          |
++---+---+---+---+---+-----------------------------------------------+
+
+
Figure 31
+
+
+
+
+
+
+
+

+9. Security Considerations +

+
+

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See [RFC3986] for a +discussion of the security considerations relating to URIs.

+
+
+
+
+
+

+10. IANA Considerations +

+
+
+

+10.1. Parameter Registrations +

+
+

This document defines the following new iCalendar property parameters +to be added to the registry defined in [RFC5545]:

+
+
+ + + + + + + + + + + + + + + + + + + + + +
Table 11
Property ParameterStatusReference
+
+

REQUIRED

+
+
+
+

Current

+
+
+ +
+
+

STAY-INFORMED

+
+
+
+

Current

+
+
+ +
+
+
+
+
+
+

+10.2. Property Registrations +

+
+

This document defines the following new iCalendar properties to be +added to the registry defined in [RFC5545]:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12
PropertyStatusReference
+
+

ACCEPT-RESPONSE

+
+
+
+

Current

+
+
+ +
+
+

POLL-ITEM-ID

+
+
+
+

Current

+
+
+ +
+
+

POLL-MODE

+
+
+
+

Current

+
+
+ +
+
+

POLL-PROPERTIES

+
+
+
+

Current

+
+
+ +
+
+

POLL-WINNER

+
+
+
+

Current

+
+
+ +
+
+

RESPONSE

+
+
+
+

Current

+
+
+ +
+
+
+
+
+
+

+10.3. POLL-MODE Registration Template +

+
+

A poll mode is defined by completing the following template.

+
+
+
+
Poll mode name
+
+
+

The name of the poll mode.

+
+
+
+
Purpose
+
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
+
+
Reference
+
+
+

A reference to the RFC in which the poll mode is defined

+
+
+
+
+
+
+
+
+
+

+10.4. POLL-MODE Registrations +

+
+

This document defines the following registered poll modes.

+
+
+ + + + + + + + + + + + + + + + +
Table 13
Poll mode namePurposeReference
+
+

BASIC

+
+
+
+

To provide simple voting for a single outcome from a number of candidates.

+
+
+
+

Current

+
+
+
+
+
+
+
+
+
+

+11. Normative references +

+
+
[RFC2518]
+
+Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D. Jensen, "HTTP Extensions for Distributed Authoring - WEBDAV", IETF RFC 2518, IETF RFC 2518, DOI 10.17487/RFC2518, , <https://www.rfc-editor.org/info/rfc2518>.
+
+
[RFC3986]
+
+Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", IETF RFC 3986, IETF RFC 3986, DOI 10.17487/RFC3986, , <https://www.rfc-editor.org/info/rfc3986>.
+
+
[RFC4791]
+
+Daboo, C., Desruisseaux, B., and L. Dusseault, "Calendaring Extensions to WebDAV (CalDAV)", IETF RFC 4791, IETF RFC 4791, DOI 10.17487/RFC4791, , <https://www.rfc-editor.org/info/rfc4791>.
+
+
[RFC5545]
+
+Desruisseaux, B., Ed., "Internet Calendaring and Scheduling Core Object Specification (iCalendar)", IETF RFC 5545, IETF RFC 5545, DOI 10.17487/RFC5545, , <https://www.rfc-editor.org/info/rfc5545>.
+
+
[RFC5546]
+
+Daboo, C., Ed., "iCalendar Transport-Independent Interoperability Protocol (iTIP)", IETF RFC 5546, IETF RFC 5546, DOI 10.17487/RFC5546, , <https://www.rfc-editor.org/info/rfc5546>.
+
+
[RFC6047]
+
+Melnikov, A., Ed., "iCalendar Message-Based Interoperability Protocol (iMIP)", IETF RFC 6047, IETF RFC 6047, DOI 10.17487/RFC6047, , <https://www.rfc-editor.org/info/rfc6047>.
+
+
[RFC6638]
+
+Daboo, C. and B. Desruisseaux, "Scheduling Extensions to CalDAV", IETF RFC 6638, IETF RFC 6638, DOI 10.17487/RFC6638, , <https://www.rfc-editor.org/info/rfc6638>.
+
+
[I-D.ietf-calext-eventpub-extensions]
+
+Douglass, M., "Event Publishing Extensions to iCalendar", IETF I-D.ietf-calext-eventpub-extensions, IETF I-D.ietf-calext-eventpub-extensions, .
+
+
+
+
+
+
+

+12. Bibliography +

+
+
+
+
+

+Appendix A. Open issues +

+
+

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+
+
+

Notifications: Need to do a section on what Notifications to + support. + A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user?

+
+
+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote

+
+
+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+
+
+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+
+
+

Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event.

+
+
+

Need to write down what isn't valid in a VPOLL + a. Can't change POLL-MODE

+
+
+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+
+
+

? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER

+
+
+

Need to add example of freebusy in response

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest
+METHOD: REPLY
+BEGIN:VPOLL
+ORGANIZER:mailto:douglm@mysite.edu
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T010000Z
+SEQUENCE:0
+SUMMARY:What to do this week
+BEGIN:VFREEBUSY
+.......
+END:VFREEBUSY
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 32
+
+
+
+
+
+

+Appendix B. Change log +

+
+
+
Calext V01: 2019-10-17 MD
+
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
+
+
Calext V00: 2019-05-17 MD
+
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
+
+
V03: 2014-10-28 MD
+
+
    +
  • +
    +

    Add VVOTER and VOTE components.

    +
    +
  • +
  • +
    +

    Add RESPONSE property.

    +
    +
  • +
  • +
    +

    Remove RESPONSE parameter from VOTER.

    +
    +
  • +
+
+
+
V03: 2014-05-12 MD
+
+
    +
  • +
    +

    Add reply-url property and required parameter.

    +
    +
  • +
  • +
    +

    Fix ACCEPT-RESPONSE definition.

    +
    +
  • +
+
+
+
V02: 2014-05-12 MD
+
+
    +
  • +
    +

    Typos fixed, clarifications made.

    +
    +
  • +
  • +
    +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
    +
  • +
  • +
    +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
    +
  • +
  • +
    +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
    +
  • +
  • +
    +

    iTip: fix broken table cells

    +
    +
  • +
  • +
    +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
    +
  • +
  • +
    +

    Added Caldav scheduling section

    +
    +
  • +
+
+
+
V01: 2013-08-07 MD
+
+
    +
  • +
    +

    Removed method CONFIRM

    +
    +
  • +
  • +
    +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
    +
  • +
  • +
    +

    Added POLL-WINNER and verbiage

    +
    +
  • +
  • +
    +

    Added STATUS values

    +
    +
  • +
  • +
    +

    Added RELTYPE=POLL

    +
    +
  • +
  • +
    +

    Added supported-vpoll-component-sets

    +
    +
  • +
  • +
    +

    Added CalDAV related parameters to VOTER

    +
    +
  • +
  • +
    +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
    +
  • +
+
+
+
Initial version: 2012-11-02 MD
+
+
+
+
+
+
+
+
+

+Authors' Addresses +

+
+
Eric York
+ +
+
+
Cyrus Daboo
+ +
+
+
Michael Douglass
+ +
+
+
+ + + diff --git a/documents/draft-ietf-calext-vpoll.rfc.xml b/documents/draft-ietf-calext-vpoll.rfc.xml new file mode 100644 index 0000000..f27533f --- /dev/null +++ b/documents/draft-ietf-calext-vpoll.rfc.xml @@ -0,0 +1,3140 @@ + + + + + + + + + + VPOLL: Consensus Scheduling Component for iCalendar + + + +
+ + eric.york@gmail.com + +
+
+ +
+ + cyrus@daboo.name + +
+
+ +
+ + mikeadouglass@gmail.com + +
+
+ Internet + + +This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives. + +
+ +
+ Acknowledgements + The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support. +
+
+ Introduction + The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing. + Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities. + A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time. + Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice. + The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact. + These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process. +
+
+ Terms and definitions + For the purposes of this document, + the following terms and definitions apply. +
+consensus scheduling +The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task. +
+
+active Vpoll +A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period +
+
+voter +A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented. +
+
+
+ Simple Consensus Scheduling + This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees. + This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives. +
The VPOLL Component: An OverviewThe VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate: +
DTSTAMP
+The usual property. +
SEQUENCE
+The usual property. See below for SEQUENCE +behavior. +
UID
+The usual property. +
ORGANIZER
+The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same. +
SUMMARY
+The usual property. This optional but +recommended property provides the a short title to the poll. +
DESCRIPTION
+The usual property. This optional property +provides more details. +
DTEND
+The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active. +
POLL-MODE
+A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives. +
POLL-COMPLETION
+A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice. +
POLL-PROPERTIES
+A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process. +
PARTICIPANT
+There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on. +
VOTE
+A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration. +
VEVENT
+In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting. +
+EXAMPLEVPOLL with 3 voters and 3 alternative meetings:
+As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.
+
The VPOLL Alternative Choices: An OverviewWithin the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL. +
POLL-ITEM-ID
+This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer. +
+
VPOLL responsesUpon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components: +
DTSTAMP
+The usual property. +
SEQUENCE
+The usual property. See below for SEQUENCE +behavior. +
UID
+Same as the request. +
ORGANIZER
+Same as the request. +
SUMMARY
+Same as the request. +
PARTICIPANT
+One only with a CALENDAR-ADDRESS identifying the voter replying. +
VOTE
+One per item being voted on. +
POLL-ITEM-ID
+One inside each VOTE component to identify the choice. +
RESPONSE
+One inside each VOTE component to specify the vote. +
+Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3. +
NOTE
+This is poll-mode specific behavior? +
+EXAMPLEREPLY VPOLL from Cyrus:
+
VPOLL updatesWhen the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components. +EXAMPLE
+
VPOLL CompletionAfter a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED. +The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED". +EXAMPLEVPOLL confirmation:
+
Other ResponsesA voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care. +An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices. +This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.
+
+
+ iCalendar Extensions +
Updated Participant Type ValueParticipant type property values are defined in section 11.2.1. of +. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL. +
+
Updated Relation Type ValueRelationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component. +
+
Updated Status ValueStatus property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+These values allow clients and servers to handle the +choosing and submission of winning choices. +
+ +
+
+
New Property Parameters
Required
Parameter name
+REQUIRED +
Purpose
+To specify whether the associated property is required in +the current context. +
Format Definition
+This parameter is defined by the following notation: +
+
+ +
Description
+This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies. +
+
Stay-Informed
Parameter name
+STAY-INFORMED +
Purpose
+To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed. +
Format Definition
+This parameter is defined by the following notation: +
+
+ +
Description
+This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant. +
+
New Properties
Accept-Response
Property name
+ACCEPT-RESPONSE +
Purpose
+This property is used in VPOLL to indicate the types of +component that may be supplied in a response. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives. +If this property is not present voters are only allowed to respond +to the choices in the request. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Completion
Property name
+POLL-COMPLETION +
Purpose
+This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s). +
Description
When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action. +Server initiated submission requires that the submitted choice +MUST be a valid calendaring component. +POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.
Format Definition
+This property is defined by the following notation: +
+
+ +
Example
+The following is an example of this property: +
+
+
+
Poll-Item-Id
Property name
+POLL-ITEM-ID +
Purpose
+This property is used in VPOLL child components as an +identifier. +
Value type
+INTEGER +
Property Parameters
+Non-standard parameters can be specified on +this property. +
Conformance
+This property MUST be specified in a VOTE component and +in VPOLL choice items. +
Description
+In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on. +POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Mode
Property name
+POLL-MODE +
Purpose
+This property is used in VPOLL to indicate what voting mode +is to be applied. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component or +its sub-components. +
Description
+The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID. +Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-properties
Property name
+POLL-PROPERTIES +
Purpose
+This property is used in VPOLL to define which icalendar +properties are being voted on. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Winner
Property name
+POLL-WINNER +
Purpose
+This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won. +
Value type
+INTEGER +
Property Parameters
+Non-standard parameters can be specified on +this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Reply-URL
Property name
+REPLY-URL +
Purpose
+This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service. +
Property Parameters
+Non-standard, required or iana parameters can +be specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Response
Property name
+RESPONSE +
Purpose
+To specify a response vote. +
Value type
+INTEGER +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
+This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention: +
    +
  • +0 - 39 A "NO vote" +
  • +
  • +40 - 79 A "MAYBE" vote +
  • +
  • +80 - 89 A "YES - but not preferred vote" +
  • +
  • +90-100 A "YES" vote. +Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe). +
  • +
+
+
New Components
VPOLL Component
Component name
+VPOLL +
Purpose
+This component provides a mechanism by which voters can +vote on provided choices. +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components. +If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created. +If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration. +"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property. +If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.
+
VOTE Component
Component name
+VOTE +
Purpose
+This component provides a mechanism by which voters can +vote on provided choices. +
Conformance
+This component may be specified zero or more times in a PARTICIPANT component which identifies the voter. +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.The required and optional properties and their meanings will depend +upon the POLL-MODE in effect. +For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice. +If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.
+
+
+ Poll Modes + The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property. + New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC. +
POLL-MODE:BASICBASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected. +
Property restrictionsThis poll mode has the following property requirements: +
POLL-ITEM-ID
+Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll. +
POLL-WINNER
+On confirmation of the poll this property MUST be +present and identifies the winning component. +
+
Outcome reportingTo confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED. +When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.
+
+
+ iTIP Extensions + This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters. + For many of the iTip processing rules the voters take the place of +attendees. +
MethodsThere are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined. +
MethodDescription
+PUBLISH + +No changes (yet) +
+REQUEST + +Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on. +
+REPLY + +There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only. +
+ADD + +Not supported for VPOLL. +
+CANCEL + +There MUST be a single VPOLL component with UID +
+matching that of the poll being cancelled. +
+REFRESH + +The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found. +
+COUNTER + +Not supported for VPOLL. +
+DECLINECOUNTER + +Not supported for VPOLL. +
+POLLSTATUS + +Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS. +
+The following table shows the above methods broken down by who can +send them with VPOLL components. +
OriginatorMethods
+Organizer + +CANCEL, PUBLISH, REQUEST, POLLSTATUS +
+Voter + +REPLY, REFRESH, REQUEST (only when delegating) +
+
Interoperability ModelsMost of the standard iTip specification applies with respect to +organizer and voters. +
Delegation + +TBD +
+
Acting on Behalf of Other Calendar Users + +TBD +
+
Component Revisions + +
    +
  • +Need to talk about what a change in SEQUENCE means +
  • +
  • +Sequence change forces a revote. +
  • +
  • +New voter - no sequence change +
  • +
  • +Add another poll set or change poll item ids or any change to a child +
  • +
  • +component - bump sequence +
  • +
+
+
Message Sequencing + +TBD +
+
Application Protocol Elements
Methods for VPOLL Calendar ComponentsThis section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method. +The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object. +
Presence ValueDescription
+1 + +One instance MUST be present. +
+1+ + +At least one instance MUST be present. +
+0 + +Instances of this property MUST NOT be present. +
+0+ + +Multiple instances MAY be present. +
+0 or 1 + +Up to 1 instance of this property MAY be present. +
+The following summarizes the methods that are defined for the "VPOLL" +calendar component. +
MethodDescription
+PUBLISH + +Post notification of an poll. Used primarily as a +method of advertising the existence of a poll. +
+REQUEST + +To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach. +
+REPLY + +Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100. +
+CANCEL + +Cancel a poll. +
+REFRESH + +A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester. +
+POLLSTATUS + +Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT. +
+
Method: PUBLISHThe "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component. +
Note
+Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification. +
+This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:PUBLISH of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST equal PUBLISH. +
+VPOLL + +1+ +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 + +If present defines the start of the poll. Otherwise the poll starts when it is created and distributed. +
+ORGANIZER + +1 +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0 or 1 +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+LAST-MODIFIED + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 or 1 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of COMPLETED/CONFIRMED/CANCELLED. +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+PARTICIPANT + +0+ + +Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters +
+REQUEST-STATUS + +0 +
+VALARM + +0+ +
+VEVENT + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VFREEBUSY + +0 +
+VJOURNAL + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTODO + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+
Method: REQUESTThe "REQUEST" method in a "VPOLL" component provides the following +scheduling functions: +
    +
  • +Invite "Voters" to respond to the poll. +
  • +
  • +Change the items being voted upon. +
  • +
  • +Complete or confirm the poll. +
  • +
  • +Response to a "REFRESH" request. +
  • +
  • +Update the details of an existing vpoll. +
  • +
  • +Update the status of "Voters". +
  • +
  • +Forward a "VPOLL" to another uninvited CU. +
  • +
  • +For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU. +
  • +
  • +For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU. +
  • +
+The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer". +The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component. +For the "REQUEST" method only a single iCalendar object is permitted. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REQUEST of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REQUEST. +
+VPOLL + +1 +
+PARTICIPANT + +1+ + +Identified as voters with the PARTICIPANT-TYPE=VOTER +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 + +If present defines the start of the poll. Otherwise the poll starts when it is created and distributed. +
+ORGANIZER + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 or 1 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+REQUEST-STATUS + +0 +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of COMPLETED/CONFIRMED/CANCELLED. +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+VALARM + +0+ +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VEVENT + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VFREEBUSY + +0 +
+VJOURNAL + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTODO + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+
Rescheduling a poll + +The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll. +
+
Updating or Reconfirmation of a PollThe "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method +describes an update of the poll details, but not a rescheduling of +the POLL. +The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll. +The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.
+
Confirmation of a Poll + +The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component. +
+
Closing a Poll + +The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED. +
+
Delegating a Poll to Another CUSome calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU. +The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above. +In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY" +method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address. +The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".
+
Changing the Organizer + +The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer". +
+
Sending on Behalf of the Organizer + +There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer". +
+
Forwarding to an Uninvited CUA "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU. +The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll. +If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added. +When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.
+
Updating Voter Status + +The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST". +
+
Method: REPLYThe "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property. +The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed. +The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter". +A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value. +The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter. +The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY) +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REPLY of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REPLY. +
+VPOLL + +1+ + +All components MUST have the same +
+UID. +
+PARTICIPANT + +1 + +Identifies the Voter replying. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+UID + +1 + +MUST be the UID of the original +
+REQUEST. +
+SEQUENCE + +0 or 1 + +If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0. +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DTSTART + +0 or 1 +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +1+ + +One per item being voted on. +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+REQUEST-STATUS + +0+ +
+STATUS + +0 or 1 +
+SUMMARY + +0 or 1 +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+VALARM + +0 +
+VTIMEZONE + +0 or 1 + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VEVENT + +0 +
+VFREEBUSY + +0 or 1 + +A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy. +
+VAVAILABILITY + +0 + +A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available. +
+VJOURNAL + +0 +
+VTODO + +0 +
+
Method: CANCELThe "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll. +The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each. +When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in . +Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:CANCEL of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be CANCEL. +
+VPOLL + +1+ + +All must have the same UID. +
+PARTICIPANT + +0+ + +MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled. +
+UID + +1 + +MUST be the UID of the original REQUEST. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+SEQUENCE + +1 +
+ATTACH + +0+ +
+ACCEPT-RESPONSE + +0 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DTSTART + +0 or 1 +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included. +
+SUMMARY + +0 or 1 +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+REQUEST-STATUS + +0 +
+VALARM + +0 +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VTODO + +0 +
+VJOURNAL + +0 +
+VEVENT + +0 +
+VFREEBUSY + +0 +
+
Method: REFRESHThe "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REFRESH of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REFRESH. +
+VPOLL + +1 +
+PARTICIPANT + +1 + +MUST identify the requester as a voter. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+UID + +1 + +MUST be the UID associated with original REQUEST. +
+COMMENT + +0+ +
+COMPLETED + +0 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+ACCEPT-RESPONSE + +0 +
+ATTACH + +0 +
+CATEGORIES + +0 +
+CLASS + +0 +
+CONTACT + +0 +
+CREATED + +0 +
+DESCRIPTION + +0 +
+DTEND + +0 +
+DTSTART + +0 +
+DURATION + +0 +
+GEO + +0 +
+LAST-MODIFIED + +0 +
+LOCATION + +0 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 +
+RELATED-TO + +0 +
+REQUEST-STATUS + +0 +
+RESOURCES + +0 +
+SEQUENCE + +0 +
+STATUS + +0 +
+SUMMARY + +0 +
+URL + +0 +
+VALARM + +0 +
+VTIMEZONE + +0+ +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VTODO + +0 +
+VJOURNAL + +0 +
+VEVENT + +0 +
+VFREEBUSY + +0 +
+
Method: POLLSTATUSThe "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:POLLSTATUS of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST equal POLLSTATUS. +
+VPOLL + +1+ +
+PARTICIPANT + +1+ + +The voters containing their current vote +
+COMPLETED + +0 or 1 + +Only present for a completed poll +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 +
+ORGANIZER + +1 +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+ACCEPT-RESPONSE + +0 +
+ATTACH + +0 +
+CATEGORIES + +0 +
+CLASS + +0 +
+COMMENT + +0+ +
+CONTACT + +0 +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+LAST-MODIFIED + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of TENTATIVE/CONFIRMED/CANCELLED. +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+REQUEST-STATUS + +0 +
+VALARM + +0+ +
+VEVENT + +0 + +All candidate components SHOULD NOT be present. +
+VFREEBUSY + +0 +
+VJOURNAL + +0 + +All candidate components SHOULD NOT be present. +
+VTODO + +0 + +All candidate components SHOULD NOT be present. +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+
+
+ CalDAV Extensions + This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports. + Additionally, it extends as it a VPOLL component is a +schedulable entity. +
Calendar Collection PropertiesThis section defines new CalDAV properties for calendar collections. +
CALDAV:supported-vpoll-component-sets
Name
+supported-vpoll-component-sets +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.It also specifies the combination of allowed component types. +Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.
Definition
+
+ +]]>
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +]]>
+
+
CALDAV:vpoll-max-items
Name
+vpoll-max-items +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component. +
Definition
+
+PCDATA value: a numeric value (integer greater than zero)]]>
+ +
25]]>
+
+
CALDAV:vpoll-max-active
Name
+vpoll-max-active +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Provides a numeric value indicating the maximum number of +active vpolls at any one time. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs. +
Definition
+
+PCDATA value: a numeric value (integer greater than zero)]]>
+ +
25]]>
+
+
CALDAV:vpoll-max-voters
Name
+ +vpoll-max-voters + +
Namespace
+ +urn:ietf:params:xml:ns:caldav + +
Purpose
+Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component. +
Definition
+
+PCDATA value: a numeric value (integer greater than zero)]]>
+ +
25]]>
+
+
CalDAV:even-more-properties + +
+
Extensions to CalDAV schedulingThis specification extends . +Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL. +Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.
+
Additional Preconditions for PUT, COPY, and MOVEThis specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection. +The new preconditions are: +
(CALDAV:supported-vpoll-component-sets)
+The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection; +
(CALDAV:vpoll-max-items)
+The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored; +
(CALDAV:vpoll-max-active)
+The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored; +
(CALDAV:vpoll-max-voters)
+The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored; +
+
CalDAV:calendar-query ReportThis allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself. +
Example: Partial Retrieval of VPOLLIn this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION. +
> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + + + + + + + + + + + + + + + + + + + + + + + + + + + + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + + + + + http://cal.example.com/cyrus/work/poll2.ics + + + "fffff-abcd2" + BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR + + + HTTP/1.1 200 OK + + + + http://cal.example.com/cyrus/work/poll3.ics + + + "fffff-abcd3" + BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR + + + HTTP/1.1 200 OK + + +]]>
+
+
CalDAV time ranges"CALDAV:time-range XML Element" in describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL +A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified. +
DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+]]>
+
+
+
+ Security Considerations + Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs. +
+
+ IANA Considerations +
Parameter RegistrationsThis document defines the following new iCalendar property parameters +to be added to the registry defined in : +
Property ParameterStatusReference
+REQUIRED + +Current + + + + +
+STAY-INFORMED + +Current + + + + +
+
Property RegistrationsThis document defines the following new iCalendar properties to be +added to the registry defined in : +
PropertyStatusReference
+ACCEPT-RESPONSE + +Current + + + + +
+POLL-ITEM-ID + +Current + + + + +
+POLL-MODE + +Current + + + + +
+POLL-PROPERTIES + +Current + + + + +
+POLL-WINNER + +Current + + + + +
+RESPONSE + +Current + + + + +
+
POLL-MODE Registration TemplateA poll mode is defined by completing the following template. +
Poll mode name
+The name of the poll mode. +
Purpose
+The purpose of the poll mode. Give a short but clear +description. +
Reference
+A reference to the RFC in which the poll mode is defined +
+
POLL-MODE RegistrationsThis document defines the following registered poll modes. +
Poll mode namePurposeReference
+BASIC + +To provide simple voting for a single outcome from a number of candidates. + +Current +
+
+
+ + + Normative references + + + HTTP Extensions for Distributed Authoring — WEBDAV + + + + + + + + This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] + + + + + IETF RFC 2518 + + + + + + Uniform Resource Identifier (URI): Generic Syntax + + + + + + A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] + + + + + IETF RFC 3986 + + + + + + Calendaring Extensions to WebDAV (CalDAV) + + + + + + This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the "calendar-access" feature of CalDAV. [STANDARDS-TRACK] + + + + + IETF RFC 4791 + + + + + + Internet Calendaring and Scheduling Core Object Specification (iCalendar) + + + + This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] + + + + + IETF RFC 5545 + + + + + + iCalendar Transport-Independent Interoperability Protocol (iTIP) + + + + This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] + + + + + IETF RFC 5546 + + + + + + iCalendar Message-Based Interoperability Protocol (iMIP) + + + + This document, "iCalendar Message-Based Interoperability Protocol (iMIP)", specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] + + + + + IETF RFC 6047 + + + + + + Scheduling Extensions to CalDAV + + + + + This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) "calendar-access" feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the "calendar-auto-schedule" feature of CalDAV. [STANDARDS-TRACK] + + + + + IETF RFC 6638 + + + + + + Event Publishing Extensions to iCalendar + + + + This specification updates RFC5545 by introducing a number of new iCalendar properties and components which are of particular use for event publishers and in social networking. This specification also defines a new STRUCTURED-DATA property for iCalendar RFC5545 to allow for data that is directly pertinent to an event or task to be included with the calendar data. + + + + + + IETF I-D.ietf-calext-eventpub-extensions + + + + + Bibliography + +
+ Open issues + public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property + Notifications: Need to do a section on what Notifications to + support. + A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user? + Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote + Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status + ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration + Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event. + Need to write down what isn't valid in a VPOLL + a. Can't change POLL-MODE + Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc + ? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER + Need to add example of freebusy in response +
+ +
+
+
+ Change log +
+
Calext V01: 2019-10-17 MD
+
+Replace VVOTER and VOTER with PARTICIPANT. +
+
Calext V00: 2019-05-17 MD
+
+First calext version. Moved source to metanorma. No changes to specification. +
+
V03: 2014-10-28 MD
+
+
    +
  • +Add VVOTER and VOTE components. +
  • +
  • +Add RESPONSE property. +
  • +
  • +Remove RESPONSE parameter from VOTER. +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +Add reply-url property and required parameter. +
  • +
  • +Fix ACCEPT-RESPONSE definition. +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +Typos fixed, clarifications made. +
  • +
  • +Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT +
  • +
  • +Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values. +
  • +
  • +iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent +
  • +
  • +iTip: fix broken table cells +
  • +
  • +Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table +
  • +
  • +Added Caldav scheduling section +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +Removed method CONFIRM +
  • +
  • +Removed pollitemid from VPOLL abnf. Added text for pollwinner +
  • +
  • +Added POLL-WINNER and verbiage +
  • +
  • +Added STATUS values +
  • +
  • +Added RELTYPE=POLL +
  • +
  • +Added supported-vpoll-component-sets +
  • +
  • +Added CalDAV related parameters to VOTER +
  • +
  • +Removed bad CalDAV query example. State that queries cannot +target the sub-components. +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
+
+
diff --git a/documents/draft-ietf-calext-vpoll.rxl b/documents/draft-ietf-calext-vpoll.rxl new file mode 100644 index 0000000..a9b7b65 --- /dev/null +++ b/documents/draft-ietf-calext-vpoll.rxl @@ -0,0 +1,73 @@ + +VPOLL: Consensus Scheduling Component for iCalendar +VPOLL +www.linkedin.com/in/eryork +draft-ietf-calext-vpoll-00 +draft-ietf-calext-vpoll-00 + + + + +Eric York + +eric.york@gmail.com + + + + + + +Cyrus Daboo + +cyrus@daboo.name + + + + + + +Michael Douglass + +mikeadouglass@gmail.com + + + + + +Internet Engineering Task Force +IETF + + + +2019-11-05 + +en + + +standard + + +2020 + + +Internet Engineering Task Force +IETF + + + + +IETF + + +standard + + +internet-draft +Internet +trust200902 +true + +yes + + + \ No newline at end of file diff --git a/documents/draft-ietf-calext-vpoll.txt b/documents/draft-ietf-calext-vpoll.txt new file mode 100644 index 0000000..19f2ede --- /dev/null +++ b/documents/draft-ietf-calext-vpoll.txt @@ -0,0 +1,3472 @@ + + + + +Network Working Group E. York +Internet-Draft +Intended status: Standards Track C. Daboo +Expires: 31 January 2021 + M. Douglass + 30 July 2020 + + + VPOLL: Consensus Scheduling Component for iCalendar + draft-ietf-calext-vpoll-00 + +Abstract + + This specification introduces a new iCalendar component which allows + for consensus scheduling, that is, voting on a number of alternative + meeting or task alternatives. + +Status of This Memo + + This Internet-Draft is submitted in full conformance with the + provisions of BCP 78 and BCP 79. + + Internet-Drafts are working documents of the Internet Engineering + Task Force (IETF). Note that other groups may also distribute + working documents as Internet-Drafts. The list of current Internet- + Drafts is at https://datatracker.ietf.org/drafts/current/. + + Internet-Drafts are draft documents valid for a maximum of six months + and may be updated, replaced, or obsoleted by other documents at any + time. It is inappropriate to use Internet-Drafts as reference + material or to cite them other than as "work in progress." + + This Internet-Draft will expire on 31 January 2021. + +Copyright Notice + + Copyright (c) 2020 IETF Trust and the persons identified as the + document authors. All rights reserved. + + This document is subject to BCP 78 and the IETF Trust's Legal + Provisions Relating to IETF Documents (https://trustee.ietf.org/ + license-info) in effect on the date of publication of this document. + Please review these documents carefully, as they describe your rights + and restrictions with respect to this document. Code Components + extracted from this document must include Simplified BSD License text + as described in Section 4.e of the Trust Legal Provisions and are + provided without warranty as described in the Simplified BSD License. + + + + +York, et al. Expires 31 January 2021 [Page 1] + +Internet-Draft VPOLL July 2020 + + +Table of Contents + + 1. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 3 + 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 + 3. Terms and definitions . . . . . . . . . . . . . . . . . . . . 4 + 3.1. consensus scheduling . . . . . . . . . . . . . . . . . . 4 + 3.2. active Vpoll . . . . . . . . . . . . . . . . . . . . . . 4 + 3.3. voter . . . . . . . . . . . . . . . . . . . . . . . . . . 4 + 4. Simple Consensus Scheduling . . . . . . . . . . . . . . . . . 5 + 4.1. The VPOLL Component: An Overview . . . . . . . . . . . . 5 + 4.2. The VPOLL Alternative Choices: An Overview . . . . . . . 7 + 4.3. VPOLL responses . . . . . . . . . . . . . . . . . . . . . 8 + 4.4. VPOLL updates . . . . . . . . . . . . . . . . . . . . . . 9 + 4.5. VPOLL Completion . . . . . . . . . . . . . . . . . . . . 11 + 4.6. Other Responses . . . . . . . . . . . . . . . . . . . . . 12 + 5. iCalendar Extensions . . . . . . . . . . . . . . . . . . . . 12 + 5.1. Updated Participant Type Value . . . . . . . . . . . . . 12 + 5.2. Updated Relation Type Value . . . . . . . . . . . . . . . 12 + 5.3. Updated Status Value . . . . . . . . . . . . . . . . . . 13 + 5.4. New Property Parameters . . . . . . . . . . . . . . . . . 13 + 5.4.1. Required . . . . . . . . . . . . . . . . . . . . . . 13 + 5.4.2. Stay-Informed . . . . . . . . . . . . . . . . . . . . 14 + 5.5. New Properties . . . . . . . . . . . . . . . . . . . . . 14 + 5.5.1. Accept-Response . . . . . . . . . . . . . . . . . . . 14 + 5.5.2. Poll-Completion . . . . . . . . . . . . . . . . . . . 15 + 5.5.3. Poll-Item-Id . . . . . . . . . . . . . . . . . . . . 16 + 5.5.4. Poll-Mode . . . . . . . . . . . . . . . . . . . . . . 17 + 5.5.5. Poll-properties . . . . . . . . . . . . . . . . . . . 17 + 5.5.6. Poll-Winner . . . . . . . . . . . . . . . . . . . . . 18 + 5.5.7. Reply-URL . . . . . . . . . . . . . . . . . . . . . . 19 + 5.5.8. Response . . . . . . . . . . . . . . . . . . . . . . 19 + 5.6. New Components . . . . . . . . . . . . . . . . . . . . . 20 + 5.6.1. VPOLL Component . . . . . . . . . . . . . . . . . . . 20 + 5.6.2. VOTE Component . . . . . . . . . . . . . . . . . . . 22 + 6. Poll Modes . . . . . . . . . . . . . . . . . . . . . . . . . 23 + 6.1. POLL-MODE:BASIC . . . . . . . . . . . . . . . . . . . . . 24 + 6.1.1. Property restrictions . . . . . . . . . . . . . . . . 24 + 6.1.2. Outcome reporting . . . . . . . . . . . . . . . . . . 24 + 7. iTIP Extensions . . . . . . . . . . . . . . . . . . . . . . . 24 + 7.1. Methods . . . . . . . . . . . . . . . . . . . . . . . . . 24 + 7.2. Interoperability Models . . . . . . . . . . . . . . . . . 26 + 7.2.1. Delegation . . . . . . . . . . . . . . . . . . . . . 26 + 7.2.2. Acting on Behalf of Other Calendar Users . . . . . . 26 + 7.2.3. Component Revisions . . . . . . . . . . . . . . . . . 26 + 7.2.4. Message Sequencing . . . . . . . . . . . . . . . . . 26 + 7.3. Application Protocol Elements . . . . . . . . . . . . . . 26 + 7.3.1. Methods for VPOLL Calendar Components . . . . . . . . 26 + 7.3.2. Method: PUBLISH . . . . . . . . . . . . . . . . . . . 28 + + + +York, et al. Expires 31 January 2021 [Page 2] + +Internet-Draft VPOLL July 2020 + + + 7.3.3. Method: REQUEST . . . . . . . . . . . . . . . . . . . 31 + 7.3.4. Method: REPLY . . . . . . . . . . . . . . . . . . . . 37 + 7.3.5. Method: CANCEL . . . . . . . . . . . . . . . . . . . 40 + 7.3.6. Method: REFRESH . . . . . . . . . . . . . . . . . . . 43 + 7.3.7. Method: POLLSTATUS . . . . . . . . . . . . . . . . . 45 + 8. CalDAV Extensions . . . . . . . . . . . . . . . . . . . . . . 47 + 8.1. Calendar Collection Properties . . . . . . . . . . . . . 47 + 8.1.1. CALDAV:supported-vpoll-component-sets . . . . . . . . 47 + 8.1.2. CALDAV:vpoll-max-items . . . . . . . . . . . . . . . 49 + 8.1.3. CALDAV:vpoll-max-active . . . . . . . . . . . . . . . 50 + 8.1.4. CALDAV:vpoll-max-voters . . . . . . . . . . . . . . . 51 + 8.1.5. CalDAV:even-more-properties . . . . . . . . . . . . . 51 + 8.1.6. Extensions to CalDAV scheduling . . . . . . . . . . . 51 + 8.2. Additional Preconditions for PUT, COPY, and MOVE . . . . 52 + 8.3. CalDAV:calendar-query Report . . . . . . . . . . . . . . 52 + 8.3.1. Example: Partial Retrieval of VPOLL . . . . . . . . . 53 + 8.4. CalDAV time ranges . . . . . . . . . . . . . . . . . . . 55 + 9. Security Considerations . . . . . . . . . . . . . . . . . . . 56 + 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 56 + 10.1. Parameter Registrations . . . . . . . . . . . . . . . . 57 + 10.2. Property Registrations . . . . . . . . . . . . . . . . . 57 + 10.3. POLL-MODE Registration Template . . . . . . . . . . . . 57 + 10.4. POLL-MODE Registrations . . . . . . . . . . . . . . . . 58 + 11. Normative references . . . . . . . . . . . . . . . . . . . . 58 + 12. Bibliography . . . . . . . . . . . . . . . . . . . . . . . . 59 + Appendix A. Open issues . . . . . . . . . . . . . . . . . . . . 59 + Appendix B. Change log . . . . . . . . . . . . . . . . . . . . . 60 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 61 + +1. Acknowledgements + + The authors would like to thank the members of the Calendaring and + Scheduling Consortium (CalConnect) for contributing their ideas and + support. + +2. Introduction + + The currently existing approach to agreeing on meeting times using + iTip [RFC5546] and/or iMip [RFC6047] has some significant failings. + There is no useful bargaining or suggestion mechanism in iTip, only + the ability for a potential attendee to accept or refuse or to + counter with a time of their own choosing. + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 3] + +Internet-Draft VPOLL July 2020 + + + Part of the problem is that for many potential attendees, their + freebusy is not an accurate representation of their availability. In + fact, when trying to schedule conference calls across different + organizations, attendees may not be allowed to provide freebusy + information or availability as this may reveal something of the + organizations internal activities. + + A number of studies have shown that large amounts of time are spent + trying to come to an agreement - up to and beyond 20 working hours + per meeting. Many organizers fall back on other approaches such as + phone calls and email to determine a suitable time. + + Online services have appeared as a result and these allow + participants to vote on a number of alternatives without revealing or + using freebusy or availability. When agreement is reached a + conventional scheduling message may be sent to the attendees. This + approach appears to reach consensus fairly rapidly. Peer pressure + may have some bearing on this as all voters are usually able to see + the current state of the voting and may adjust their own meeting + schedules to make themselves available for a popular choice. + + The component and properties defined in this specification provide a + standardized structure for this process and allow calendar clients + and servers and web based services to interact. + + These structures also have uses beyond the relatively simple needs of + most meeting organizers. The process of coming to consensus can also + be viewed as a bidding process. + +3. Terms and definitions + + For the purposes of this document, the following terms and + definitions apply. + +3.1. consensus scheduling + + The process whereby users come to some agreement on meeting or task + alternatives and then book that meeting or task. + +3.2. active Vpoll + + A VPoll may have a DTSTART, DTEND and DURATION which may define the + start and end of the active voting period + +3.3. voter + + A participant who votes on the alternatives. A voter need not be an + attendee of any of the alternatives presented. + + + +York, et al. Expires 31 January 2021 [Page 4] + +Internet-Draft VPOLL July 2020 + + +4. Simple Consensus Scheduling + + This specification defines components and properties which can be + used for simple consensus scheduling but also have the generality to + handle more complex cases. To provide an easy (and for many - + sufficient) introduction to consensus scheduling and VPOLL we will + outline the flow of information for the simple case of voting on a + number of meeting alternatives which differ only in time. In + addition the voters will all be potential attendees. + + This specification not only defines data structures but adds a new + iTip method used when consensus has been reached. This document will + show how a VPOLL object is used to inform voters of the state of a + simple vote on some alternatives. + +4.1. The VPOLL Component: An Overview + + The VPOLL component acts as a wrapper for a number of alternatives to + be voted on, together with some properties and a new component used + to maintain the state of the voting. For our simple example the + following VPOLL properties and sub-components are either required or + appropriate: + + DTSTAMP The usual [RFC5545] property. + + SEQUENCE The usual [RFC5545] property. See below for SEQUENCE + behavior. + + UID The usual [RFC5545] property. + + ORGANIZER The usual [RFC5545] property. In general this need not be + an organizer of any of the alternatives. In this simple outline + we assume it is the same. + + SUMMARY The usual [RFC5545] property. This optional but recommended + property provides the a short title to the poll. + + DESCRIPTION The usual [RFC5545] property. This optional property + provides more details. + + DTEND The usual [RFC5545] property. This optional property provides + a poll closing time and date after which the VPOLL is no longer + active. + + POLL-MODE A new property which defines how the votes are used to + obtain a result. For our use case it will take the value "BASIC" + meaning one event will be chosen from the alternatives. + + + + +York, et al. Expires 31 January 2021 [Page 5] + +Internet-Draft VPOLL July 2020 + + + POLL-COMPLETION A new property which defines who (server or client) + chooses and/or submits the winning choice. In our example the + value is "SERVER-SUBMIT" which means the client chooses the winner + but the server will submit the winning choice. + + POLL-PROPERTIES A new property which defines which icalendar + properties are being voted on. For our use case it will take the + value "DTSTART, LOCATION" meaning only those properties are + significant for voting. Other properties in the events may differ + but are not considered significant for the voting process. + + PARTICIPANT There is one of these components for each voter with the + PARTICIPANT-TYPE set to "VOTER". The CALENDAR-ADDRESS property + identifies the voter and this component will contain one VOTE + component for each item being voted on. + + VOTE A new component. There is one of these for each voter and + choice. It usually contains at least a POLL-ITEM-ID property to + identify the choice and a RESPONSE property to provide a vote. + For more complex poll modes it may contain other information such + as cost or estimated duration. + + VEVENT In our simple use case there will be multiple VEVENT sub- + components defining the alternatives. Each will have a different + date and or time for the meeting. + + EXAMPLE + + VPOLL with 3 voters and 3 alternative meetings: + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 6] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD:REQUEST + BEGIN:VPOLL + POLL-MODE:BASIC + POLL-COMPLETION:SERVER-SUBMIT + POLL-PROPERTIES:DTSTART,LOCATION + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T000000Z + SUMMARY:What to do this week + DTEND:20120101T000000Z + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + END PARTICIPANT + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + END PARTICIPANT + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:mike@example.com + END PARTICIPANT + BEGIN:VEVENT.......(with a poll-item-id=1) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=2) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=3) + END:VEVENT + END:VPOLL + END:VCALENDAR + + Figure 1 + + As can be seen in the example above, there is an iTip METHOD property + with the value REQUEST. The VPOLL object will be distributed to all + the voters, either through iMip or through some VPOLL enabled + service. + +4.2. The VPOLL Alternative Choices: An Overview + + Within the VPOLL component we have the alternatives to vote on. In + many respects these are standard [RFC5545] components. For our + simple use case they are all VEVENT components. In addition to the + usual [RFC5545] properties some extra properties are used for a + VPOLL. + + + +York, et al. Expires 31 January 2021 [Page 7] + +Internet-Draft VPOLL July 2020 + + + POLL-ITEM-ID This provides a unique reference to the sub-component + within the VPOLL. It's value SHOULD be a small integer. + +4.3. VPOLL responses + + Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL + component containing their vote. In our simple case it will have the + following properties and components: + + DTSTAMP The usual [RFC5545] property. + + SEQUENCE The usual [RFC5545] property. See below for SEQUENCE + behavior. + + UID Same as the request. + + ORGANIZER Same as the request. + + SUMMARY Same as the request. + + PARTICIPANT One only with a CALENDAR-ADDRESS identifying the voter + replying. + + VOTE One per item being voted on. + + POLL-ITEM-ID One inside each VOTE component to identify the choice. + + RESPONSE One inside each VOTE component to specify the vote. + + Note that a voter can send a number of REPLYs for each REQUEST sent + by the organizer. Each REPLY completely replaces the voting record + for that voter for all components being voted on. In our example, if + Eric responds and votes for items 1 and 2 and then responds again + with a vote for only item 3, the final outcome is one vote on item 3. + + NOTE This is poll-mode specific behavior? + + EXAMPLE + + REPLY VPOLL from Cyrus: + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 8] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: REPLY + BEGIN:VPOLL + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T010000Z + SUMMARY:What to do this week + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + BEGIN:VOTE + POLL-ITEM-ID:1 + RESPONSE:50 + COMMENT:Work on iTIP + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + COMMENT:Work on WebDAV + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 2 + +4.4. VPOLL updates + + When the organizer receives a response from one or more voters the + current state of the poll is sent to all voters. The new iTip method + POLLSTATUS is used. The VPOLL can contain a reduced set of + properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, + ORGANIZER and one or more PARTICIPANT components each populated with + zero or more VOTE components. + + EXAMPLE + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 9] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: POLLSTATUS + BEGIN:VPOLL + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T020000Z + SEQUENCE:0 + SUMMARY:What to do this week + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + BEGIN: VOTE + POLL-ITEM-ID:1 + RESPONSE:50 + COMMENT:Work on iTIP + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + COMMENT:Work on WebDAV + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + BEGIN:VOTE + POLL-ITEM-ID:1 + RESPONSE:100 + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 3 + + + +York, et al. Expires 31 January 2021 [Page 10] + +Internet-Draft VPOLL July 2020 + + +4.5. VPOLL Completion + + After a number of REPLY messages have been received the poll will be + considered complete. If there is a DTEND on the poll the system may + automatically close the poll, or the organizer may, at any time, + consider the poll complete. A VPOLL can be completed (and + effectively closed for voting) by sending an iTip REQUEST message + with the VPOLL STATUS property set to COMPLETED. + + The poll winner is confirmed by sending a final iTip REQUEST message + with the VPOLL STATUS property set to CONFIRMED. In this case the + VPOLL component contains all the events being voted on along with a + POLL-WINNER property to identify the winning event. As the POLL- + COMPLETION property is set to SERVER-SUBMIT the server will submit + the winning choice and when it has done so set the STATUS to + "SUBMITTED". + + EXAMPLE + + VPOLL confirmation: + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: REQUEST + BEGIN:VPOLL + ORGANIZER:mailto:douglm@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T030000Z + COMPLETED:20120101T030000Z + POLL-COMPLETION:SERVER-SUBMIT + SEQUENCE:0 + SUMMARY:What to do this week + STATUS:CONFIRMED + POLL-WINNER:3 + BEGIN:VEVENT.......(with a poll-item-id=1) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=2) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=3) + END:VEVENT + END:VPOLL + END:VCALENDAR + + Figure 4 + + + + + + +York, et al. Expires 31 January 2021 [Page 11] + +Internet-Draft VPOLL July 2020 + + +4.6. Other Responses + + A voter being asked to choose between a number of ORGANIZER supplied + alternatives may find none of them acceptable or may simply not care. + + An alternative response, which may be disallowed by the ORGANIZER, is + to send back the respondees availability or freebusy or even one or + more new, alternative choices. + + This is accomplished by responding with a VOTE component which has no + POLL-ITEM-ID property. In this case it MUST contain some alternative + information. What form this takes depends on the poll mode in + effect. + +5. iCalendar Extensions + +5.1. Updated Participant Type Value + + Participant type property values are defined in section 11.2.1. of + [I-D.ietf-calext-eventpub-extensions]. This specification updates + that type to include the new participant type VOTER to provide + information about the voter and to contain their votes. + + Format Definition This property parameter is redefined by the + following notation: + + partvalue /= "VOTER" + + Figure 5 + + Description The new property value indicates that the associated + PARTICIPANT component identifies a voter in a VPOLL. + +5.2. Updated Relation Type Value + + Relationship parameter type values are defined in section 3.2.15. of + [RFC5545]. This specification updates that type to include the new + relationship value POLL to provide a link to the VPOLL component in + which the current component appears. + + Format Definition This property parameter is redefined by the + following notation: + + reltypeparam /= "RELTYPE" "=" "POLL" + ; Property value is a VPOLL uid + + Figure 6 + + + + +York, et al. Expires 31 January 2021 [Page 12] + +Internet-Draft VPOLL July 2020 + + + Description This parameter can be specified on a property that + references another related calendar component. The new parameter + value indicates that the associated property references a VPOLL + component which contains the current component. + +5.3. Updated Status Value + + Status property values are defined in section 3.8.1.11. of [RFC5545]. + This specification updates that type to define valid VPOLL status + values. + + Format Definition This property parameter is redefined by the + following notation: + + statvalue /= statvalue-poll + ; Status values for "VPOLL". + statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + + Figure 7 + + Description These values allow clients and servers to handle the + choosing and submission of winning choices. + + If the client is choosing and the server submitting then the + client should set the POLL-WINNER property, set the status to + CONFIRMED and save the poll. When the server submits the winning + choice it will set the status to SUBMITTED. + + Figure 8 + +5.4. New Property Parameters + +5.4.1. Required + + Parameter name REQUIRED + + Purpose To specify whether the associated property is required in + the current context. + + Format Definition This parameter is defined by the following + notation: + + + +York, et al. Expires 31 January 2021 [Page 13] + +Internet-Draft VPOLL July 2020 + + + requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + + Figure 9 + + Description This parameter MAY be specified on REPLY-URL and, if the + value is TRUE, indicates the organizer requires all replies to be + made via the specified service rather than iTip replies. + +5.4.2. Stay-Informed + + Parameter name STAY-INFORMED + + Purpose To specify the voter also wants to be added as an ATTENDEE + when the poll is confirmed. + + Format Definition This parameter is defined by the following + notation: + + stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + + Figure 10 + + Description This parameter MAY be specified on the CALENDAR-ADDRESS + property in the PARTICIPANT component and, if the value is TRUE, + indicates the voter wishes to be added to the final choice as a + non participant. + +5.5. New Properties + +5.5.1. Accept-Response + + Property name ACCEPT-RESPONSE + + Purpose This property is used in VPOLL to indicate the types of + component that may be supplied in a response. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description When used in a VPOLL this property indicates what + allowable component types may be returned in a reply. Typically + this would allow a voter to respond with their freebusy or + availability rather than choosing one of the presented + alternatives. + + + +York, et al. Expires 31 January 2021 [Page 14] + +Internet-Draft VPOLL July 2020 + + + If this property is not present voters are only allowed to respond + to the choices in the request. + + Format Definition This property is defined by the following + notation: + + acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + + acceptresponseparams = *(";" other-param) + + Figure 11 + +5.5.2. Poll-Completion + + Property name POLL-COMPLETION + + Purpose This property is used in VPOLL to indicate whether the + client or server is responsible for choosing and/or submitting the + winner(s). + + Description When a VPOLL is stored on a server which is capable of + handling choosing and submission of winning choices a value of + SERVER indicates that the server should close the poll, choose the + winner and submit whenever it is appropriate to do so. + + For example, in BASIC poll-mode, reaching the DTEND of the poll + could trigger this server side action. + + Server initiated submission requires that the submitted choice + MUST be a valid calendaring component. + + POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- + winner, set the status to CONFIRMED and then store the poll on the + server. The server will then submit the winning choice and set + the status to SUBMITTED. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 15] + +Internet-Draft VPOLL July 2020 + + + poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + + pcparam = *(";" other-param) + + pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + + Figure 12 + + Example The following is an example of this property: + + POLL-COMPLETION: SERVER-SUBMIT + + Figure 13 + +5.5.3. Poll-Item-Id + + Property name POLL-ITEM-ID + + Purpose This property is used in VPOLL child components as an + identifier. + + Value type INTEGER + + Property Parameters Non-standard parameters can be specified on this + property. + + Conformance This property MUST be specified in a VOTE component and + in VPOLL choice items. + + Description In a METHOD:REQUEST each choice component MUST have a + POLL-ITEM-ID property. Each set of components with the same POLL- + ITEM-ID value represents one overall set of items to be voted on. + + POLL-ITEM-ID SHOULD be a unique small integer for each component + or set of components. If it remains the same between REQUESTs + then the previous response for that component MAY be re-used. To + force a re-vote on a component due to a significant change, the + POLL-ITEM-ID MUST change. + + + +York, et al. Expires 31 January 2021 [Page 16] + +Internet-Draft VPOLL July 2020 + + + Format Definition This property is defined by the following + notation: + + pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + + pollitemidparams = *( + (";" other-param) + ) + + Figure 14 + +5.5.4. Poll-Mode + + Property name POLL-MODE + + Purpose This property is used in VPOLL to indicate what voting mode + is to be applied. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component or + its sub-components. + + Description The poll mode defines how the votes are applied to + obtain a result. BASIC mode, the default, means that the voters + are selecting one component (or group of components) with a given + POLL=ITEM-ID. + + Other polling modes may be defined in updates to this + specification. These may allow for such modes as ranking or task + assignment. + + Format Definition This property is defined by the following + notation: + + pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + + pollmodeparams = *(";" other-param) + + Figure 15 + +5.5.5. Poll-properties + + Property name POLL-PROPERTIES + + + + +York, et al. Expires 31 January 2021 [Page 17] + +Internet-Draft VPOLL July 2020 + + + Purpose This property is used in VPOLL to define which icalendar + properties are being voted on. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description This property defines which icalendar properties are + significant in the voting process. It may not be clear to voters + which properties are varying in a significant manner. Clients may + use this property to highlight those listed properties. + + Format Definition This property is defined by the following + notation: + + pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + + pollpropparams = *(";" other-param) + + Figure 16 + +5.5.6. Poll-Winner + + Property name POLL-WINNER + + Purpose This property is used in a basic mode VPOLL to indicate + which of the VPOLL sub-components won. + + Value type INTEGER + + Property Parameters Non-standard parameters can be specified on this + property. + + Conformance This property MAY be specified in a VPOLL component. + + Description For poll confirmation each child component MUST have a + POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD + have a POLL-WINNER property which MUST correspond to one of the + POLL-ITEM-ID properties and indicates which sub-component was the + winner. + + Format Definition This property is defined by the following + notation: + + + + + + +York, et al. Expires 31 January 2021 [Page 18] + +Internet-Draft VPOLL July 2020 + + + pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + + pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed + + Figure 17 + +5.5.7. Reply-URL + + Property name REPLY-URL + + Purpose This property may be used in scheduling messages to indicate + additional reply methods, for example a web-service. + + Property Parameters Non-standard, required or iana parameters can be + specified on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description When used in a scheduling message this property + indicates additional or required services that can be used to + reply. Typically this would be a web service of some form. + + Format Definition This property is defined by the following + notation: + + reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + + reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) + + Figure 18 + +5.5.8. Response + + Property name RESPONSE + + Purpose To specify a response vote. + + Value type INTEGER + + Format Definition This property is defined by the following + notation: + + + +York, et al. Expires 31 January 2021 [Page 19] + +Internet-Draft VPOLL July 2020 + + + response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + + responseparams = *(";" other-param) + + Figure 19 + + Description This parameter can be specified on the POLL-ITEM-ID + property to provide the value of the voters response. This + parameter allows for fine grained responses which are appropriate + to some applications. For the case of individuals voting for a + choice of events, client applications SHOULD conform to the + following convention: + + * 0 - 39 A "NO vote" + + * 40 - 79 A "MAYBE" vote + + * 80 - 89 A "YES - but not preferred vote" + + * 90-100 A "YES" vote. + + Clients MUST preserve the response value when there is no + change from the user even if they have a UI with fixed states + (e.g. yes/no/maybe). + +5.6. New Components + +5.6.1. VPOLL Component + + Component name VPOLL + + Purpose This component provides a mechanism by which voters can vote + on provided choices. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 20] + +Internet-Draft VPOLL July 2020 + + + pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + + pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + + Figure 20 + + Description This component provides a mechanism by which voters can + + + +York, et al. Expires 31 January 2021 [Page 21] + +Internet-Draft VPOLL July 2020 + + + vote on provided choices. The outcome depends upon the POLL-MODE + in effect. + + The PARTICIPANT components in VPOLL requests provide information + on each recipient who will be voting - both their identity through + the CALENDAR-ADDRESS property and their votes through the VOTE + components. + + If specified, the "DTSTART" property defines the start or opening + of the poll active period. If absent the poll is presumed to have + started when created. + + If "DTSTART" is present "DURATION" MAY be specified and indicates + the duration, and hence the ending, of the poll. The value of the + property MUST be a positive duration. + + "DTEND" MAY be specified with or without "DTSTART" and indicates + the ending of the poll. If DTEND is specified it MUST be later + than the DTSTART or CREATED property. + + If one or more VALARM components are included in the VPOLL they + are not components to be voted on and MUST NOT contain a POLL- + ITEM-ID property. VALARM sub-components may be used to provide + warnings to the user when polls are due to start or end. + +5.6.2. VOTE Component + + Component name VOTE + + Purpose This component provides a mechanism by which voters can vote + on provided choices. + + Conformance This component may be specified zero or more times in a + PARTICIPANT component which identifies the voter. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 22] + +Internet-Draft VPOLL July 2020 + + + votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + + voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + + Figure 21 + + Description This component appears inside the PARTICIPANT component + with a PARTICIPANT-TYPE of VOTER to identify the voter. This + component contains that participants responses. + + The required and optional properties and their meanings will + depend upon the POLL-MODE in effect. + + For any POLL-MODE, POLL-ITEM-ID is used to associate the + information to a choice supplied by the organizer. This means + that each VOTE component only provides information about that + choice. + + If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- + ID may be provided in a REPLY to indicate a possible new choice or + to provide information to the ORGANIZER - such as the respondees + availability. + +6. Poll Modes + + The VPOLL component is intended to allow for various forms of + polling. The particular form in efffect is indicated by the POLL- + MODE property. + + New poll modes can be registered by including a completed POLL-MODE + Registration Template (see Section 10.3) in a published RFC. + + + + +York, et al. Expires 31 January 2021 [Page 23] + +Internet-Draft VPOLL July 2020 + + +6.1. POLL-MODE:BASIC + + BASIC poll mode is the form of voting in which one possible outcome + is chosen from a set of possibilities. Usually this will be + represented as a number of possible event objects one of which will + be selected. + +6.1.1. Property restrictions + + This poll mode has the following property requirements: + + POLL-ITEM-ID Each contained sub-component that is being voted upon + MUST contain a POLL-ITEM_ID property which is unique within the + context of the POLL. The value MUST NOT be reused when events are + removed and/or added to the poll. + + POLL-WINNER On confirmation of the poll this property MUST be + present and identifies the winning component. + +6.1.2. Outcome reporting + + To confirm the winner the POLL-WINNER property MUST be present and + the STATUS MUST be set to CONFIRMED. + + When the winning VEVENT or VTODO is not a scheduled entity, that is, + it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER + property and a list of non-participating ATTENDEEs. This allows the + winning entity to be distributed to the participants through iTip or + some other protocol. + +7. iTIP Extensions + + This specification introduces a number of extensions to [RFC5546]. + In group scheduling the parties involved are organizer and attendees. + In VPOLL the parties are organizer and voters. + + For many of the iTip processing rules the voters take the place of + attendees. + +7.1. Methods + + There are some extensions to the behavior of iTip methods for a VPOLL + object and two new methods are defined. + + + + + + + + +York, et al. Expires 31 January 2021 [Page 24] + +Internet-Draft VPOLL July 2020 + + + +----------------+------------------------------------------------+ + | Method | Description | + +================+================================================+ + | PUBLISH | No changes (yet) | + +----------------+------------------------------------------------+ + | REQUEST | Each child component MUST have a POLL-ITEM-ID | + | | property. Each set of components with the | + | | same POLL-ITEM-ID value represents one overall | + | | set of items to be voted on. | + +----------------+------------------------------------------------+ + | REPLY | There MUST be a single VPOLL component which | + | | MUST have: either one or more POLL-ITEM-ID | + | | properties with a RESPONSE param matching that | + | | from a REQUEST or a VFREEBUSY or VAVAILABILITY | + | | child component showing overall busy/available | + | | time. The VPOLL MUST have one voter only. | + +----------------+------------------------------------------------+ + | ADD | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | CANCEL | There MUST be a single VPOLL component with | + | | UID | + +----------------+------------------------------------------------+ + | | matching that of the poll being cancelled. | + +----------------+------------------------------------------------+ + | REFRESH | The organizer returns a METHOD:REQUEST with | + | | the current full state, or a METHOD:CANCEL or | + | | an error if no matching poll is found. | + +----------------+------------------------------------------------+ + | COUNTER | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | DECLINECOUNTER | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | POLLSTATUS | Used to send the current state of the poll to | + | | all voters. The VPOLL can contain a reduced | + | | set of properties but MUST contain DTSTAMP, | + | | SEQUENCE (if not 0), UID, ORGANIZER and | + | | PARTICIPANTS. | + +----------------+------------------------------------------------+ + + Table 1 + + The following table shows the above methods broken down by who can + send them with VPOLL components. + + + + + + + + +York, et al. Expires 31 January 2021 [Page 25] + +Internet-Draft VPOLL July 2020 + + + +------------+------------------------------------------------+ + | Originator | Methods | + +============+================================================+ + | Organizer | CANCEL, PUBLISH, REQUEST, POLLSTATUS | + +------------+------------------------------------------------+ + | Voter | REPLY, REFRESH, REQUEST (only when delegating) | + +------------+------------------------------------------------+ + + Table 2 + +7.2. Interoperability Models + + Most of the standard iTip specification applies with respect to + organizer and voters. + +7.2.1. Delegation + + TBD + +7.2.2. Acting on Behalf of Other Calendar Users + + TBD + +7.2.3. Component Revisions + + * Need to talk about what a change in SEQUENCE means + + * Sequence change forces a revote. + + * New voter - no sequence change + + * Add another poll set or change poll item ids or any change to a + child + + * component - bump sequence + +7.2.4. Message Sequencing + + TBD + +7.3. Application Protocol Elements + +7.3.1. Methods for VPOLL Calendar Components + + This section defines the property set restrictions for the method + types that are applicable to the "VPOLL" calendar component. Each + method is defined using a table that clarifies the property + constraints that define the particular method. + + + +York, et al. Expires 31 January 2021 [Page 26] + +Internet-Draft VPOLL July 2020 + + + The presence column uses the following values to assert whether a + property is required or optional, and the number of times it may + appear in the iCalendar object. + + +----------------+-------------------------------------------------+ + | Presence Value | Description | + +================+=================================================+ + | 1 | One instance MUST be present. | + +----------------+-------------------------------------------------+ + | 1+ | At least one instance MUST be present. | + +----------------+-------------------------------------------------+ + | 0 | Instances of this property MUST NOT be present. | + +----------------+-------------------------------------------------+ + | 0+ | Multiple instances MAY be present. | + +----------------+-------------------------------------------------+ + | 0 or 1 | Up to 1 instance of this property MAY be | + | | present. | + +----------------+-------------------------------------------------+ + + Table 3 + + The following summarizes the methods that are defined for the "VPOLL" + calendar component. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 27] + +Internet-Draft VPOLL July 2020 + + + +------------+------------------------------------------------------+ + | Method | Description | + +============+======================================================+ + | PUBLISH | Post notification of an poll. Used primarily | + | | as a method of advertising the existence of a | + | | poll. | + +------------+------------------------------------------------------+ + | REQUEST | To make a request for a poll. This is an | + | | explicit invitation to one or more voters. | + | | Poll requests are also used to update, change | + | | or confirm an existing poll. Clients that | + | | cannot handle REQUEST MAY degrade the poll to | + | | view it as a PUBLISH. REQUEST SHOULD NOT be | + | | used just to set the status of the poll - | + | | POLLSTATUS provides a more compact approach. | + +------------+------------------------------------------------------+ + | REPLY | Reply to a poll request. Voters may set | + | | their RESPONSE parameter to supply the | + | | current vote in the range 0 to 100. | + +------------+------------------------------------------------------+ + | CANCEL | Cancel a poll. | + +------------+------------------------------------------------------+ + | REFRESH | A request is sent to an Organizer by a Voter | + | | asking for the latest version of a poll to be | + | | resent to the requester. | + +------------+------------------------------------------------------+ + | POLLSTATUS | Used to send the current state of the poll to | + | | all voters. The VPOLL can contain a reduced | + | | set of properties but MUST contain DTSTAMP, | + | | SEQUENCE (if not 0), UID, ORGANIZER and | + | | PARTICIPANT. | + +------------+------------------------------------------------------+ + + Table 4 + +7.3.2. Method: PUBLISH + + The "PUBLISH" method in a "VPOLL" calendar component is an + unsolicited posting of an iCalendar object. Any CU may add published + components to their calendar. The "Organizer" MUST be present in a + published iCalendar component. "Voters" MUST NOT be present. Its + expected usage is for encapsulating an arbitrary poll as an iCalendar + object. The "Organizer" may subsequently update (with another + "PUBLISH" method) or cancel (with a "CANCEL" method) a previously + published "VPOLL" calendar component. + + Note Not clear how useful this is but needs some work on + transmitting the current vote without any voter identification. + + + +York, et al. Expires 31 January 2021 [Page 28] + +Internet-Draft VPOLL July 2020 + + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST equal PUBLISH. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | If present defines the start of the | + | | | poll. Otherwise the poll starts | + | | | when it is created and distributed. | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + + + +York, et al. Expires 31 January 2021 [Page 29] + +Internet-Draft VPOLL July 2020 + + + | | | present. | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of COMPLETED/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 0+ | Only PARTICIPANT components with | + | | | PARTICIPANT-TYPE not equal to | + | | | "VOTER" - that is, no voters | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + + + +York, et al. Expires 31 January 2021 [Page 30] + +Internet-Draft VPOLL July 2020 + + + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + + Table 5: Constraints for a METHOD:PUBLISH of a VPOLL + +7.3.3. Method: REQUEST + + The "REQUEST" method in a "VPOLL" component provides the following + scheduling functions: + + * Invite "Voters" to respond to the poll. + + * Change the items being voted upon. + + * Complete or confirm the poll. + + * Response to a "REFRESH" request. + + * Update the details of an existing vpoll. + + * Update the status of "Voters". + + * Forward a "VPOLL" to another uninvited CU. + + * For an existing "VPOLL" calendar component, delegate the role of + "Voter" to another CU. + + * For an existing "VPOLL" calendar component, change the role of + "Organizer" to another CU. + + The "Organizer" originates the "REQUEST". The recipients of the + "REQUEST" method are the CUs voting in the poll, the "Voters". + "Voters" use the "REPLY" method to convey votes to the "Organizer". + + The "UID" and "SEQUENCE" properties are used to distinguish the + various uses of the "REQUEST" method. If the "UID" property value in + the "REQUEST" is not found on the recipient's calendar, then the + "REQUEST" is for a new "VPOLL" calendar component. If the "UID" + property value is found on the recipient's calendar, then the + "REQUEST" is for an update, or a reconfirmation of the "VPOLL" + calendar component. + + + +York, et al. Expires 31 January 2021 [Page 31] + +Internet-Draft VPOLL July 2020 + + + For the "REQUEST" method only a single iCalendar object is permitted. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST be REQUEST. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1 | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1+ | Identified as voters with the | + | | | PARTICIPANT-TYPE=VOTER | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | If present defines the start of the | + | | | poll. Otherwise the poll starts | + | | | when it is created and distributed. | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + + + +York, et al. Expires 31 January 2021 [Page 32] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of COMPLETED/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0+ | Depending upon the poll mode in | + + + +York, et al. Expires 31 January 2021 [Page 33] + +Internet-Draft VPOLL July 2020 + + + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + + Table 6: Constraints for a METHOD:REQUEST of a VPOLL + +7.3.3.1. Rescheduling a poll + + The "REQUEST" method may be used to reschedule a poll, that is force + a revote. A rescheduled poll involves a change to the existing poll + in terms of its time the components being voted on may have changed. + If the recipient CUA of a "REQUEST" method finds that the "UID" + property value already exists on the calendar but that the "SEQUENCE" + (or "DTSTAMP") property value in the "REQUEST" method is greater than + the value for the existing poll, then the "REQUEST" method describes + a rescheduling of the poll. + +7.3.3.2. Updating or Reconfirmation of a Poll + + The "REQUEST" method may be used to update or reconfirm a poll. An + update to an existing poll does not involve changes to the time or + candidates, and might not involve a change to the location or + description for the poll. If the recipient CUA of a "REQUEST" method + finds that the "UID" property value already exists on the calendar + and that the "SEQUENCE" property value in the "REQUEST" is the same + as the value for the existing poll, then the "REQUEST" method + + describes an update of the poll details, but not a rescheduling of + the POLL. + + The update "REQUEST" method is the appropriate response to a + "REFRESH" method sent from a "Voter" to the "Organizer" of a poll. + + + + + + +York, et al. Expires 31 January 2021 [Page 34] + +Internet-Draft VPOLL July 2020 + + + The "Organizer" of a poll may also send unsolicited "REQUEST" + methods. The unsolicited "REQUEST" methods may be used to update the + details of the poll without rescheduling it, to update the "RESPONSE" + parameter of "Voters", or to reconfirm the poll. + +7.3.3.3. Confirmation of a Poll + + The "REQUEST" method may be used to confirm a poll, that is announce + the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and + for BASIC mode a VPOLL POLL-WINNER property must be provided with the + poll-id of the winning component. + +7.3.3.4. Closing a Poll + + The "REQUEST" method may be used to close a poll, that is indicate + voting is completed. The STATUS MUST be set to COMPLETED. + +7.3.3.5. Delegating a Poll to Another CU + + Some calendar and scheduling systems allow "Voters" to delegate the + vote to another "Calendar User". iTIP supports this concept using the + following workflow. Any "Voter" may delegate their right to vote in + a poll to another CU. The implication is that the delegate + participates in lieu of the original "Voter", NOT in addition to the + "Voter". The delegator MUST notify the "Organizer" of this action + using the steps outlined below. Implementations may support or + restrict delegation as they see fit. For instance, some + implementations may restrict a delegate from delegating a "REQUEST" + to another CU. + + The "Delegator" of a poll forwards the existing "REQUEST" to the + "Delegate". The "REQUEST" method MUST include a "Voter" property + with the calendar address of the "Delegate". The "Delegator" MUST + also send a "REPLY" method to the "Organizer" with the "Delegator's" + "Voter" property "DELEGATED-TO" parameter set to the calendar address + of the "Delegate". Also, a new "Voter" property for the "Delegate" + MUST be included and must specify the calendar user address set in + the "DELEGATED-TO" parameter, as above. + + In response to the request, the "Delegate" MUST send a "REPLY" method + to the "Organizer", and optionally to the "Delegator". The "REPLY" + + method SHOULD include the "Voter" property with the "DELEGATED-FROM" + parameter value of the "Delegator's" calendar address. + + + + + + + +York, et al. Expires 31 January 2021 [Page 35] + +Internet-Draft VPOLL July 2020 + + + The "Delegator" may continue to receive updates to the poll even + though they will not be attending. This is accomplished by the + "Delegator" setting their "role" attribute to "NON-PARTICIPANT" in + the "REPLY" to the "Organizer". + +7.3.3.6. Changing the Organizer + + The situation may arise where the "Organizer" of a "VPOLL" is no + longer able to perform the "Organizer" role and abdicates without + passing on the "Organizer" role to someone else. When this occurs, + the "Voters" of the "VPOLL" may use out-of-band mechanisms to + communicate the situation and agree upon a new "Organizer". The new + "Organizer" should then send out a new "REQUEST" with a modified + version of the "VPOLL" in which the "SEQUENCE" number has been + incremented and the "ORGANIZER" property has been changed to the new + "Organizer". + +7.3.3.7. Sending on Behalf of the Organizer + + There are a number of scenarios that support the need for a "Calendar + User" to act on behalf of the "Organizer" without explicit role + changing. This might be the case if the CU designated as "Organizer" + is sick or unable to perform duties associated with that function. + In these cases, iTIP supports the notion of one CU acting on behalf + of another. Using the "SENT-BY" parameter, a "Calendar User" could + send an updated "VPOLL" "REQUEST". In the case where one CU sends on + behalf of another CU, the "Voter" responses are still directed back + towards the CU designated as "Organizer". + +7.3.3.8. Forwarding to an Uninvited CU + + A "Voter" invited to a "VPOLL" calendar component may send the + "VPOLL" calendar component to another new CU not previously + associated with the "VPOLL" calendar component. The current "Voter" + participating in the "VPOLL" calendar component does this by + forwarding the original "REQUEST" method to the new CU. The new CU + can send a "REPLY" to the "Organizer" of the "VPOLL" calendar + component. The reply contains a "Voter" property for the new CU. + + The "Organizer" ultimately decides whether or not the new CU becomes + part of the poll and is not obligated to do anything with a "REPLY" + from a new (uninvited) CU. If the "Organizer" does not want the new + CU to be part of the poll, the new "Voter" property is not added to + the "VPOLL" calendar component. The "Organizer" MAY send the CU a + "CANCEL" message to indicate that they will not be added to the poll. + + + + + + +York, et al. Expires 31 January 2021 [Page 36] + +Internet-Draft VPOLL July 2020 + + + If the "Organizer" decides to add the new CU, the new "Voter" + property is added to the "VPOLL" calendar component. Furthermore, + the "Organizer" is free to change any "Voter" property parameter from + the values supplied by the new CU to something the "Organizer" + considers appropriate. The "Organizer" SHOULD send the new CU a + "REQUEST" message to inform them that they have been added. + + When forwarding a "REQUEST" to another CU, the forwarding "Voter" + MUST NOT make changes to the original message. + +7.3.3.9. Updating Voter Status + + The "Organizer" of an poll may also request updated status from one + or more "Voters". The "Organizer" sends a "REQUEST" method to the + "Voter" and sets the "RSVP=TRUE" property parameter on the + PARTICIPANT CALENDAR-ADDRESS. The "SEQUENCE" property for the poll + is not changed from its previous value. A recipient will determine + that the only change in the "REQUEST" is that their "RSVP" property + parameter indicates a request for updated status. The recipient + SHOULD respond with a "REPLY" method indicating their current vote + with respect to the "REQUEST". + +7.3.4. Method: REPLY + + The "REPLY" method in a "VPOLL" calendar component is used to respond + (e.g., accept or decline) to a "REQUEST" or to reply to a delegation + "REQUEST". When used to provide a delegation response, the + "Delegator" SHOULD include the calendar address of the "Delegate" on + the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR- + ADDRESS" property. The "Delegate" SHOULD include the calendar + address of the "Delegator" on the "DELEGATED-FROM" property parameter + of the "Delegate's" "CALENDAR-ADDRESS" property. + + The "REPLY" method is also used when processing of a "REQUEST" fails. + Depending on the value of the "REQUEST-STATUS" property, no action + may have been performed. + + The "Organizer" of a poll may receive the "REPLY" method from a CU + not in the original "REQUEST". For example, a "REPLY" may be + received from a "Delegate" to a poll. In addition, the "REPLY" + method may be received from an unknown CU (a "Party Crasher"). This + uninvited "Voter" may be accepted, or the "Organizer" may cancel the + poll for the uninvited "Voter" by sending a "CANCEL" method to the + uninvited "Voter". + + + + + + + +York, et al. Expires 31 January 2021 [Page 37] + +Internet-Draft VPOLL July 2020 + + + A "Voter" MAY include a message to the "Organizer" using the + "COMMENT" property. For example, if the user indicates a low + interest and wants to let the "Organizer" know why, the reason can be + expressed in the "COMMENT" property value. + + The "Organizer" may also receive a "REPLY" from one CU on behalf of + another. Like the scenario enumerated above for the "Organizer", + "Voters" may have another CU respond on their behalf. This is done + using the "SENT-BY" parameter. + + The optional properties listed in the table below (those listed as + "0+" or "0 or 1") MUST NOT be changed from those of the original + request. (But see comments on VFREEBUSY and VAVAILABILITY) + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST be REPLY. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | All components MUST have the same | + +-----------------+----------+-------------------------------------+ + | | | UID. | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1 | Identifies the Voter replying. | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | UID | 1 | MUST be the UID of the original | + +-----------------+----------+-------------------------------------+ + | | | REQUEST. | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | If non-zero, MUST be the sequence | + | | | number of the original REQUEST. | + | | | MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + + + +York, et al. Expires 31 January 2021 [Page 38] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 1+ | One per item being voted on. | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + + + +York, et al. Expires 31 January 2021 [Page 39] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0 | | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0 or 1 | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0 | | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 or 1 | A voter may respond with a | + | | | VFREEBUSY component indicating that | + | | | the ORGANIZER may select some other | + | | | time which is not marked as busy. | + +-----------------+----------+-------------------------------------+ + | VAVAILABILITY | 0 | A voter may respond with a | + | | | VAVAILABILITY component indicating | + | | | that the ORGANIZER may select some | + | | | other time which is shown as | + | | | available. | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0 | | + +-----------------+----------+-------------------------------------+ + | VTODO | 0 | | + +-----------------+----------+-------------------------------------+ + + Table 7: Constraints for a METHOD:REPLY of a VPOLL + +7.3.5. Method: CANCEL + + The "CANCEL" method in a "VPOLL" calendar component is used to send a + cancellation notice of an existing poll request to the affected + "Voters". The message is sent by the "Organizer" of the poll. + + The "Organizer" MUST send a "CANCEL" message to each "Voter" affected + by the cancellation. This can be done using a single "CANCEL" + message for all "Voters" or by using multiple messages with different + subsets of the affected "Voters" in each. + + When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be + incremented as described in Section 7.2.3. + + Once a CANCEL message has been sent to all voters no further voting + may take place. The poll is considered closed. + + + +York, et al. Expires 31 January 2021 [Page 40] + +Internet-Draft VPOLL July 2020 + + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+----------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+==================================+ + | METHOD | 1 | MUST be CANCEL. | + +-----------------+----------+----------------------------------+ + | VPOLL | 1+ | All must have the same UID. | + +-----------------+----------+----------------------------------+ + | PARTICIPANT | 0+ | MUST include some or all Voters | + | | | being removed from the poll. | + | | | MUST include some or all Voters | + | | | if the entire poll is cancelled. | + +-----------------+----------+----------------------------------+ + | UID | 1 | MUST be the UID of the original | + | | | REQUEST. | + +-----------------+----------+----------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+----------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+----------------------------------+ + | SEQUENCE | 1 | | + +-----------------+----------+----------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+----------------------------------+ + | ACCEPT-RESPONSE | 0 | | + +-----------------+----------+----------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+----------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+----------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+----------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | DESCRIPTION | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+----------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+----------------------------------+ + + + +York, et al. Expires 31 January 2021 [Page 41] + +Internet-Draft VPOLL July 2020 + + + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+----------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+----------------------------------+ + | POLL-MODE | 0 | | + +-----------------+----------+----------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+----------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+----------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+----------------------------------+ + | STATUS | 0 or 1 | MUST be set to CANCELLED to | + | | | cancel the entire event. If | + | | | uninviting specific Attendees, | + | | | then MUST NOT be included. | + +-----------------+----------+----------------------------------+ + | SUMMARY | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+----------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+----------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+----------------------------------+ + | VALARM | 0 | | + +-----------------+----------+----------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+----------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+----------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+----------------------------------+ + | VTODO | 0 | | + + + +York, et al. Expires 31 January 2021 [Page 42] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+----------------------------------+ + | VJOURNAL | 0 | | + +-----------------+----------+----------------------------------+ + | VEVENT | 0 | | + +-----------------+----------+----------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+----------------------------------+ + + Table 8: Constraints for a METHOD:CANCEL of a VPOLL + +7.3.6. Method: REFRESH + + The "REFRESH" method in a "VPOLL" calendar component is used by + "Voters" of an existing event to request an updated description from + the poll "Organizer". The "REFRESH" method must specify the "UID" + property of the poll to update. The "Organizer" responds with the + latest description and version of the poll. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +--------------------+----------+----------------------------+ + | Component/Property | Presence | Comment | + +====================+==========+============================+ + | METHOD | 1 | MUST be REFRESH. | + +--------------------+----------+----------------------------+ + | VPOLL | 1 | | + +--------------------+----------+----------------------------+ + | PARTICIPANT | 1 | MUST identify the | + | | | requester as a voter. | + +--------------------+----------+----------------------------+ + | DTSTAMP | 1 | | + +--------------------+----------+----------------------------+ + | ORGANIZER | 1 | | + +--------------------+----------+----------------------------+ + | UID | 1 | MUST be the UID associated | + | | | with original REQUEST. | + +--------------------+----------+----------------------------+ + | COMMENT | 0+ | | + +--------------------+----------+----------------------------+ + | COMPLETED | 0 | | + +--------------------+----------+----------------------------+ + | IANA-PROPERTY | 0+ | | + +--------------------+----------+----------------------------+ + | X-PROPERTY | 0+ | | + +--------------------+----------+----------------------------+ + | ACCEPT-RESPONSE | 0 | | + +--------------------+----------+----------------------------+ + + + +York, et al. Expires 31 January 2021 [Page 43] + +Internet-Draft VPOLL July 2020 + + + | ATTACH | 0 | | + +--------------------+----------+----------------------------+ + | CATEGORIES | 0 | | + +--------------------+----------+----------------------------+ + | CLASS | 0 | | + +--------------------+----------+----------------------------+ + | CONTACT | 0 | | + +--------------------+----------+----------------------------+ + | CREATED | 0 | | + +--------------------+----------+----------------------------+ + | DESCRIPTION | 0 | | + +--------------------+----------+----------------------------+ + | DTEND | 0 | | + +--------------------+----------+----------------------------+ + | DTSTART | 0 | | + +--------------------+----------+----------------------------+ + | DURATION | 0 | | + +--------------------+----------+----------------------------+ + | GEO | 0 | | + +--------------------+----------+----------------------------+ + | LAST-MODIFIED | 0 | | + +--------------------+----------+----------------------------+ + | LOCATION | 0 | | + +--------------------+----------+----------------------------+ + | POLL-ITEM-ID | 0 | | + +--------------------+----------+----------------------------+ + | POLL-MODE | 0 | | + +--------------------+----------+----------------------------+ + | POLL-PROPERTIES | 0 | | + +--------------------+----------+----------------------------+ + | PRIORITY | 0 | | + +--------------------+----------+----------------------------+ + | RELATED-TO | 0 | | + +--------------------+----------+----------------------------+ + | REQUEST-STATUS | 0 | | + +--------------------+----------+----------------------------+ + | RESOURCES | 0 | | + +--------------------+----------+----------------------------+ + | SEQUENCE | 0 | | + +--------------------+----------+----------------------------+ + | STATUS | 0 | | + +--------------------+----------+----------------------------+ + | SUMMARY | 0 | | + +--------------------+----------+----------------------------+ + | URL | 0 | | + +--------------------+----------+----------------------------+ + | VALARM | 0 | | + +--------------------+----------+----------------------------+ + + + +York, et al. Expires 31 January 2021 [Page 44] + +Internet-Draft VPOLL July 2020 + + + | VTIMEZONE | 0+ | | + +--------------------+----------+----------------------------+ + | IANA-COMPONENT | 0+ | | + +--------------------+----------+----------------------------+ + | X-COMPONENT | 0+ | | + +--------------------+----------+----------------------------+ + | VTODO | 0 | | + +--------------------+----------+----------------------------+ + | VJOURNAL | 0 | | + +--------------------+----------+----------------------------+ + | VEVENT | 0 | | + +--------------------+----------+----------------------------+ + | VFREEBUSY | 0 | | + +--------------------+----------+----------------------------+ + + Table 9: Constraints for a METHOD:REFRESH of a VPOLL + +7.3.7. Method: POLLSTATUS + + The "POLLSTATUS" method in a "VPOLL" calendar component is used to + inform recipients of the current status of the poll in a compact + manner. The "Organizer" MUST be present in the confirmed poll + component. All "Voters" MUST be present. The selected component(s) + according to the poll mode SHOULD NOT be present in the poll + component. Clients receiving this message may store the confirmed + items in their calendars. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST equal POLLSTATUS. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1+ | The voters containing their current | + | | | vote | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | Only present for a completed poll | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + + + +York, et al. Expires 31 January 2021 [Page 45] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0 | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0 | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0 | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of TENTATIVE/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + + + +York, et al. Expires 31 January 2021 [Page 46] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + + Table 10: Constraints for a METHOD:POLLSTATUS of a VPOLL + +8. CalDAV Extensions + + This specification extends [RFC4791] in that it defines a new + component and new iCalendar properties to be supported and requires + extra definitions related to time-ranges and reports. + + Additionally, it extends [RFC6638] as it a VPOLL component is a + schedulable entity. + +8.1. Calendar Collection Properties + + This section defines new CalDAV properties for calendar collections. + +8.1.1. CALDAV:supported-vpoll-component-sets + + Name supported-vpoll-component-sets + + Namespace urn:ietf:params:xml:ns:caldav + + + +York, et al. Expires 31 January 2021 [Page 47] + +Internet-Draft VPOLL July 2020 + + + Purpose Specifies the calendar component types (e.g., VEVENT, VTODO, + etc.) and combination of types that may be included in a VPOLL + component. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:supported-vpoll-component-sets property is + used to specify restrictions on the calendar component types that + VPOLL components may contain in a calendar collection. + + It also specifies the combination of allowed component types. + + Any attempt by the client to store VPOLL components with component + types or combinations of types not listed in this property, if it + exists, MUST result in an error, with the "CALDAV:supported-vpoll- + component-sets" precondition Section 8.2 being violated. Since + this property is protected, it cannot be changed by clients using + a PROPPATCH request. However, clients can initialize the value of + this property when creating a new calendar collection with + MKCALENDAR. In the absence of this property, the server MUST + accept all component types, and the client can assume that all + component types are accepted. + + Definition + + + + + + Figure 22 + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 48] + +Internet-Draft VPOLL July 2020 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Figure 23 + +8.1.2. CALDAV:vpoll-max-items + + Name vpoll-max-items + + Namespace urn:ietf:params:xml:ns:caldav + + Purpose Provides a numeric value indicating the maximum number of + items that may be contained in any instance of a VPOLL calendar + object resource stored in the calendar collection. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:vpoll-max-items is used to specify a numeric + value that indicates the maximum number of iCalendar components in + any one instance of a VPOLL calendar object resource stored in a + calendar collection. Any attempt to store a calendar object + resource with more components per instance than this value MUST + + + +York, et al. Expires 31 January 2021 [Page 49] + +Internet-Draft VPOLL July 2020 + + + result in an error, with the CALDAV: vpoll-max-items precondition + Section 8.2 being violated. In the absence of this property, the + client can assume that the server can handle any number of items + in a VPOLL calendar component. + + Definition + + + PCDATA value: a numeric value (integer greater than zero) + + Figure 24 + + 25 + + Figure 25 + +8.1.3. CALDAV:vpoll-max-active + + Name vpoll-max-active + + Namespace urn:ietf:params:xml:ns:caldav + + Purpose Provides a numeric value indicating the maximum number of + active vpolls at any one time. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:vpoll-max-active is used to specify a numeric + value that indicates the maximum number of active VPOLLs at any + one time. Any attempt to store a new active VPOLL calendar object + resource which results in exceeding this limit MUST result in an + error, with the "CALDAV:vpoll-max-active" precondition Section 8.2 + being violated. In the absence of this property, the client can + assume that the server can handle any number of active VPOLLs. + + Definition + + + PCDATA value: a numeric value (integer greater than zero) + + Figure 26 + + 25 + + + + +York, et al. Expires 31 January 2021 [Page 50] + +Internet-Draft VPOLL July 2020 + + + Figure 27 + +8.1.4. CALDAV:vpoll-max-voters + + Name "vpoll-max-voters" + + Namespace "urn:ietf:params:xml:ns:caldav" + + Purpose Provides a numeric value indicating the maximum number of + voters for any instance of a VPOLL calendar object resource stored + in the calendar collection. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND "DAV:allprop" request (as defined in [RFC2518]). + + Description The "CALDAV:vpoll-max-voters" is used to specify a + numeric value that indicates the maximum number of voters for any + one instance of a VPOLL calendar object resource stored in a + calendar collection. Any attempt to store a calendar object + resource with more voters per instance than this value MUST result + in an error, with the CALDAV: "vpoll-max-voters" precondition + Section 8.2 being violated. In the absence of this property, the + client can assume that the server can handle any number of voters + in a VPOLL calendar component. + + Definition + + + PCDATA value: a numeric value (integer greater than zero) + + Figure 28 + + 25 + + Figure 29 + +8.1.5. CalDAV:even-more-properties + +8.1.6. Extensions to CalDAV scheduling + + This specification extends [RFC6638]. + + Each section of Appendix A "Scheduling Privileges Summary" is + extended to include VPOLL. + + + + + +York, et al. Expires 31 January 2021 [Page 51] + +Internet-Draft VPOLL July 2020 + + + Any reference to the ATTENDEE property should be read to include the + CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. + That is, for scheduling purposes the CALENDAR-ADDRESS property is + handled in exactly the same manner as the ATTENDEE property. + +8.2. Additional Preconditions for PUT, COPY, and MOVE + + This specification creates additional Preconditions for PUT, COPY, + and MOVE methods. These preconditions apply when a PUT operation of + a VPOLL calendar object resource into a calendar collection occurs, + or when a COPY or MOVE operation of a calendar object resource into a + calendar collection occurs, or when a COPY or MOVE operation occurs + on a calendar collection. + + The new preconditions are: + + (CALDAV:supported-vpoll-component-sets) The VPOLL resource submitted + in the PUT request, or targeted by a COPY or MOVE request, MUST + contain a type or combination of calendar component that is + supported in the targeted calendar collection; + + (CALDAV:vpoll-max-items) The VPOLL resource submitted in the PUT + request, or targeted by a COPY or MOVE request, MUST have a number + of sub-components (excluding VTIMEZONE) less than or equal to the + value of the "CALDAV:vpoll-max-items" property value Section 8.1.2 + on the calendar collection where the resource will be stored; + + (CALDAV:vpoll-max-active) The PUT request, or COPY or MOVE request, + MUST not result in the number of active VPOLLs being greater than + the value of the "CALDAV:vpoll-max-active" property value + Section 8.1.3 on the calendar collection where the resource will + be stored; + + (CALDAV:vpoll-max-voters) The VPOLL resource submitted in the PUT + request, or targeted by a COPY or MOVE request, MUST have a number + of voters represented by PARTICIPANT components less than or equal + to the value of the "CALDAV:vpoll-max-voters" property value + Section 8.1.4 on the calendar collection where the resource will + be stored; + +8.3. CalDAV:calendar-query Report + + This allows the retrieval of VPOLLs and their included components. + The query specification allows queries to be directed at the + contained sub-components. For VPOLL queries this feature is + disallowed. Time-range queries can only target the vpoll component + itself. + + + + +York, et al. Expires 31 January 2021 [Page 52] + +Internet-Draft VPOLL July 2020 + + +8.3.1. Example: Partial Retrieval of VPOLL + + In this example, the client requests the server to return specific + components and properties of the VPOLL components that overlap the + time range from December 4, 2012, at 00:00:00 A.M. UTC to December + 5, 2012, at 00:00:00 A.M. UTC. In addition, the "DAV:getetag" + property is also requested and returned as part of the response. + Note that due to the CALDAV: calendar-data element restrictions, the + DTSTAMP property in VPOLL components has not been returned, and the + only property returned in the VCALENDAR object is VERSION. + + >> Request << + + REPORT /cyrus/work/ HTTP/1.1 + Host: cal.example.com + Depth: 1 + Content-Type: application/xml; charset="utf-8" + Content-Length: xxxx + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 53] + +Internet-Draft VPOLL July 2020 + + + >> Response << + + HTTP/1.1 207 Multi-Status + Date: Sat, 11 Nov 2012 09:32:12 GMT + Content-Type: application/xml; charset="utf-8" + Content-Length: xxxx + + + + + http://cal.example.com/cyrus/work/poll2.ics + + + "fffff-abcd2" + BEGIN:VCALENDAR + VERSION:2.0 + BEGIN:VPOLL + DTSTART;TZID=US/Eastern:20121202T120000 + DURATION:PT4D + SUMMARY:Poll #2 + UID:00959BC664CA650E933C892C@example.com + END:VPOLL + END:VCALENDAR + + + HTTP/1.1 200 OK + + + + http://cal.example.com/cyrus/work/poll3.ics + + + "fffff-abcd3" + BEGIN:VCALENDAR + + VERSION:2.0 + PRODID:-//Example Corp.//CalDAV Client//EN + BEGIN:VPOLL + DTSTART;TZID=US/Eastern:20121204T100000 + DURATION:PT4D + SUMMARY:Poll #3 + UID:DC6C50A017428C5216A2F1CD@example.com + END:VPOLL + END:VCALENDAR + + + HTTP/1.1 200 OK + + + +York, et al. Expires 31 January 2021 [Page 54] + +Internet-Draft VPOLL July 2020 + + + + + + + Figure 30 + +8.4. CalDAV time ranges + + "CALDAV:time-range XML Element" in [RFC4791] describes how to specify + time ranges to limit the set of calendar components returned by the + server. This specification extends [RFC4791] to describe the meaning + of time ranges for VPOLL + + A VPOLL component is said to overlap a given time range if the + condition for the corresponding component state specified in the + table below is satisfied. The conditions depend on the presence of + the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the + VPOLL component. Note that, as specified above, the DTEND value MUST + be a DATE-TIME value equal to or after the DTSTART value if + specified. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 55] + +Internet-Draft VPOLL July 2020 + + + +-------------------------------------------------------------------+ + | VPOLL has the DTSTART property? | + | +---------------------------------------------------------------+ + | | VPOLL has the DURATION property? | + | | +-----------------------------------------------------------+ + | | | VPOLL has the DTEND property? | + | | | +-------------------------------------------------------+ + | | | | VPOLL has the COMPLETED property? | + | | | | +---------------------------------------------------+ + | | | | | VPOLL has the CREATED property? | + | | | | | +-----------------------------------------------+ + | | | | | | Condition to evaluate | + +---+---+---+---+---+-----------------------------------------------+ + | Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | + | | | | | | ((end > DTSTART) OR | + | | | | | | (end >= DTSTART+DURATION)) | + +---+---+---+---+---+-----------------------------------------------+ + | Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | + | | | | | | AND | + | | | | | | ((end > DTSTART) OR (end >= DTEND)) | + +---+---+---+---+---+-----------------------------------------------+ + | Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| + | | | | | | AND | + | | | | | | ((end >= CREATED) OR (end >= COMPLETED))| + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | N | Y | (end > CREATED) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | N | N | TRUE | + +---+---+---+---+---+-----------------------------------------------+ + + Figure 31 + +9. Security Considerations + + Applications using these property need to be aware of the risks + entailed in using the URIs provided as values. See [RFC3986] for a + discussion of the security considerations relating to URIs. + +10. IANA Considerations + + + + + + +York, et al. Expires 31 January 2021 [Page 56] + +Internet-Draft VPOLL July 2020 + + +10.1. Parameter Registrations + + This document defines the following new iCalendar property parameters + to be added to the registry defined in [RFC5545]: + + +--------------------+---------+---------------+ + | Property Parameter | Status | Reference | + +====================+=========+===============+ + | REQUIRED | Current | Section 5.4.1 | + +--------------------+---------+---------------+ + | STAY-INFORMED | Current | Section 5.4.2 | + +--------------------+---------+---------------+ + + Table 11 + +10.2. Property Registrations + + This document defines the following new iCalendar properties to be + added to the registry defined in [RFC5545]: + + +-----------------+---------+---------------+ + | Property | Status | Reference | + +=================+=========+===============+ + | ACCEPT-RESPONSE | Current | Section 5.5.7 | + +-----------------+---------+---------------+ + | POLL-ITEM-ID | Current | Section 5.5.3 | + +-----------------+---------+---------------+ + | POLL-MODE | Current | Section 5.5.4 | + +-----------------+---------+---------------+ + | POLL-PROPERTIES | Current | Section 5.5.5 | + +-----------------+---------+---------------+ + | POLL-WINNER | Current | Section 5.5.6 | + +-----------------+---------+---------------+ + | RESPONSE | Current | Section 5.5.8 | + +-----------------+---------+---------------+ + + Table 12 + +10.3. POLL-MODE Registration Template + + A poll mode is defined by completing the following template. + + Poll mode name The name of the poll mode. + + Purpose The purpose of the poll mode. Give a short but clear + description. + + Reference A reference to the RFC in which the poll mode is defined + + + +York, et al. Expires 31 January 2021 [Page 57] + +Internet-Draft VPOLL July 2020 + + +10.4. POLL-MODE Registrations + + This document defines the following registered poll modes. + + +-----------+---------------------------------------+-----------+ + | Poll mode | Purpose | Reference | + | name | | | + +===========+=======================================+===========+ + | BASIC | To provide simple voting for a single | Current | + | | outcome from a number of candidates. | | + +-----------+---------------------------------------+-----------+ + + Table 13 + +11. Normative references + + [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D. + Jensen, "HTTP Extensions for Distributed Authoring - + WEBDAV", IETF RFC 2518, IETF RFC 2518, + DOI 10.17487/RFC2518, February 1999, + . + + [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform + Resource Identifier (URI): Generic Syntax", IETF RFC 3986, + IETF RFC 3986, DOI 10.17487/RFC3986, January 2005, + . + + [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, + "Calendaring Extensions to WebDAV (CalDAV)", IETF RFC + 4791, IETF RFC 4791, DOI 10.17487/RFC4791, March 2007, + . + + [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and + Scheduling Core Object Specification (iCalendar)", IETF + RFC 5545, IETF RFC 5545, DOI 10.17487/RFC5545, September + 2009, . + + [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent + Interoperability Protocol (iTIP)", IETF RFC 5546, IETF RFC + 5546, DOI 10.17487/RFC5546, December 2009, + . + + [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based + Interoperability Protocol (iMIP)", IETF RFC 6047, IETF RFC + 6047, DOI 10.17487/RFC6047, December 2010, + . + + + + + +York, et al. Expires 31 January 2021 [Page 58] + +Internet-Draft VPOLL July 2020 + + + [RFC6638] Daboo, C. and B. Desruisseaux, "Scheduling Extensions to + CalDAV", IETF RFC 6638, IETF RFC 6638, + DOI 10.17487/RFC6638, June 2012, + . + + [I-D.ietf-calext-eventpub-extensions] + Douglass, M., "Event Publishing Extensions to iCalendar", + IETF I-D.ietf-calext-eventpub-extensions, IETF I-D.ietf- + calext-eventpub-extensions, October 2019. + +12. Bibliography + +Appendix A. Open issues + + public-comment: Not documented and was a parameter on something. + Really sounds like a PARTICIPANT or VOTE property + + Notifications: Need to do a section on what Notifications to support. + A. VPOLL is about to end and you haven't voted on it yet. Instead + reuse VALARMS to notify the user? + + Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any events + booked as a result of confirmation. MUST winning event be cancelled + for POLL-MODE basic? No - voter has indicated now unable to attend - + want to revote + + Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. Requires + retention of VPOLL retention period Removed status + + ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create a + poll with a set of events where I am just the attendee of the events. + Are there any other restrictions for components in a VPOLL? Add to + security consideration + + Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event. + + Need to write down what isn't valid in a VPOLL a. Can't change POLL- + MODE + + Guide for ATTENDEE roles chair, NON-PARTICIPANT etc + + + +York, et al. Expires 31 January 2021 [Page 59] + +Internet-Draft VPOLL July 2020 + + + ? - some iTip notes On confirm - send itip if appropriate (PUBLISH) - + all non-participating - shared - feeds Organizer can specify where + result is? Confirm can specify that itip is sent - ITIP / NONE - + parameter ? on POLL-WINNER + + Need to add example of freebusy in response + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest + METHOD: REPLY + BEGIN:VPOLL + ORGANIZER:mailto:douglm@mysite.edu + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T010000Z + SEQUENCE:0 + SUMMARY:What to do this week + BEGIN:VFREEBUSY + ....... + END:VFREEBUSY + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 32 + +Appendix B. Change log + + Calext V01: 2019-10-17 MD Replace VVOTER and VOTER with PARTICIPANT. + + Calext V00: 2019-05-17 MD First calext version. Moved source to + metanorma. No changes to specification. + + V03: 2014-10-28 MD * Add VVOTER and VOTE components. + + * Add RESPONSE property. + + * Remove RESPONSE parameter from VOTER. + + V03: 2014-05-12 MD * Add reply-url property and required parameter. + + * Fix ACCEPT-RESPONSE definition. + + V02: 2014-05-12 MD * Typos fixed, clarifications made. + + + + +York, et al. Expires 31 January 2021 [Page 60] + +Internet-Draft VPOLL July 2020 + + + * Removed spurious COMMENT param. Switched some + to PUBLIC-COMMENT + + * Changed STAY-INFORMED to remove boolean value + type and state explicit TRUE/FALSE values. + + * iTip: Allow VPOLL DTSTART to be optional and + allow VAVAILABILITY as subcomponent + + * iTip: fix broken table cells + + * Add POLL-PROPERTIES, POLL-WINNER to 5545 + extensions table + + * Added Caldav scheduling section + + V01: 2013-08-07 MD * Removed method CONFIRM + + * Removed pollitemid from VPOLL abnf. Added + text for pollwinner + + * Added POLL-WINNER and verbiage + + * Added STATUS values + + * Added RELTYPE=POLL + + * Added supported-vpoll-component-sets + + * Added CalDAV related parameters to VOTER + + * Removed bad CalDAV query example. State that + queries cannot target the sub-components. + + Initial version: 2012-11-02 MD + +Authors' Addresses + + Eric York + + Email: eric.york@gmail.com + + + Cyrus Daboo + + Email: cyrus@daboo.name + + + + + +York, et al. Expires 31 January 2021 [Page 61] + +Internet-Draft VPOLL July 2020 + + + Michael Douglass + + Email: mikeadouglass@gmail.com + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 62] diff --git a/documents/draft-ietf-calext-vpoll.xml b/documents/draft-ietf-calext-vpoll.xml new file mode 100644 index 0000000..19237c9 --- /dev/null +++ b/documents/draft-ietf-calext-vpoll.xml @@ -0,0 +1,4859 @@ + + + +VPOLL: Consensus Scheduling Component for iCalendar +VPOLL +www.linkedin.com/in/eryork +draft-ietf-calext-vpoll-00 +draft-ietf-calext-vpoll-00 + + + + +Eric York + +eric.york@gmail.com + + + + + + +Cyrus Daboo + +cyrus@daboo.name + + + + + + +Michael Douglass + +mikeadouglass@gmail.com + + + + + +Internet Engineering Task Force +IETF + + + +2019-11-05 + +en + + +standard + + +2020 + + +Internet Engineering Task Force +IETF + + + + +IETF + + +standard + + +internet-draft +Internet +trust200902 +true + +yes + + + + +Foreword +

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+
+Acknowledgements +

The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support.

+
+Introduction

The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

+ + + +consensus scheduling +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+ +active Vpoll +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+ +voter +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+Simple Consensus Scheduling

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

The usual property.

+
+
ORGANIZER
+
+

The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
SUMMARY
+
+

The usual property. This optional but +recommended property provides the a short title to the poll.

+
+
DESCRIPTION
+
+

The usual property. This optional property +provides more details.

+
+
DTEND
+
+

The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
POLL-MODE
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives.

+
+
POLL-COMPLETION
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice.

+
+
POLL-PROPERTIES
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
PARTICIPANT
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
VOTE
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
VEVENT
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD:REQUEST +BEGIN:VPOLL +POLL-MODE:BASIC +POLL-COMPLETION:SERVER-SUBMIT +POLL-PROPERTIES:DTSTART,LOCATION +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T000000Z +SUMMARY:What to do this week +DTEND:20120101T000000Z +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:mike@example.com +END PARTICIPANT +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL.

+
+
POLL-ITEM-ID
+
+

This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer.

+
+
+VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

Same as the request.

+
+
ORGANIZER
+
+

Same as the request.

+
+
SUMMARY
+
+

Same as the request.

+
+
PARTICIPANT
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
VOTE
+
+

One per item being voted on.

+
+
POLL-ITEM-ID
+
+

One inside each VOTE component to identify the choice.

+
+
RESPONSE
+
+

One inside each VOTE component to specify the vote.

+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
NOTE
+
+

This is poll-mode specific behavior?

+
+
+

REPLY VPOLL from Cyrus:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: POLLSTATUS +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T020000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN: VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED".

+

VPOLL confirmation:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REQUEST +BEGIN:VPOLL +ORGANIZER:mailto:douglm@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T030000Z +COMPLETED:20120101T030000Z +POLL-COMPLETION:SERVER-SUBMIT +SEQUENCE:0 +SUMMARY:What to do this week +STATUS:CONFIRMED +POLL-WINNER:3 +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+iCalendar ExtensionsUpdated Participant Type Value

Participant type property values are defined in section 11.2.1. of +. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+partvalue /= "VOTER" + +
+
Description
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+reltypeparam /= "RELTYPE" "=" "POLL" +; Property value is a VPOLL uid + +
+
Description
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+Updated Status Value

Status property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+statvalue /= statvalue-poll + ; Status values for "VPOLL". +statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + +
+
Description
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
+New Property ParametersRequired
+
Parameter name
+
+

REQUIRED

+
+
Purpose
+
+

To specify whether the associated property is required in +the current context.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+Stay-Informed
+
Parameter name
+
+

STAY-INFORMED

+
+
Purpose
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+New PropertiesAccept-Response
+
Property name
+
+

ACCEPT-RESPONSE

+
+
Purpose
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + +acceptresponseparams = *(";" other-param) +
+Poll-Completion
+
Property name
+
+

POLL-COMPLETION

+
+
Purpose
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
Description
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
Format Definition
+
+

This property is defined by the following notation:

+
+
+poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + +pcparam = *(";" other-param) + +pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + +
+
Example
+
+

The following is an example of this property:

+
+
+POLL-COMPLETION: SERVER-SUBMIT +
+Poll-Item-Id
+
Property name
+
+

POLL-ITEM-ID

+
+
Purpose
+
+

This property is used in VPOLL child components as an +identifier.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
Description
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + +pollitemidparams = *( + (";" other-param) + ) +
+Poll-Mode
+
Property name
+
+

POLL-MODE

+
+
Purpose
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
Description
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + +pollmodeparams = *(";" other-param) +
+Poll-properties
+
Property name
+
+

POLL-PROPERTIES

+
+
Purpose
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + +pollpropparams = *(";" other-param) +
+Poll-Winner
+
Property name
+
+

POLL-WINNER

+
+
Purpose
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + +pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed +
+Reply-URL
+
Property name
+
+

REPLY-URL

+
+
Purpose
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
Property Parameters
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + +reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) +
+Response
+
Property name
+
+

RESPONSE

+
+
Purpose
+
+

To specify a response vote.

+
+
Value type
+
+

INTEGER

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + +responseparams = *(";" other-param) + +
+
Description
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 - 39 A "NO vote"

    +
  • +
  • +

    40 - 79 A "MAYBE" vote

    +
  • +
  • +

    80 - 89 A "YES - but not preferred vote"

    +
  • +
  • +

    90-100 A "YES" vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+
+New ComponentsVPOLL Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + +pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + +
+
Description
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+VOTE Component
+
Component name
+
+

VOTE

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Conformance
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + +voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + +
+
Description
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.

+
+Poll Modes

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC.

+POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+Property restrictions

This poll mode has the following property requirements:

+
+
POLL-ITEM-ID
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
POLL-WINNER
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+iTIP Extensions

This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+ +

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+ + + + + + + + + + + + + + + + + +
OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+ +Delegation +

TBD

+
+ +Acting on Behalf of Other Calendar Users +

TBD

+
+ +Component Revisions +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter - no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component - bump sequence

    +
  • +
+
+ +Message Sequencing +

TBD

+
+Application Protocol ElementsMethods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the "VPOLL" +calendar component.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+Method: PUBLISH

The "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component.

+
+
Note
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:PUBLISH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0 or 1

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+Method: REQUEST

The "REQUEST" method in a "VPOLL" component provides the following +scheduling functions:

+
    +
  • +

    Invite "Voters" to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a "REFRESH" request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of "Voters".

    +
  • +
  • +

    Forward a "VPOLL" to another uninvited CU.

    +
  • +
  • +

    For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU.

    +
  • +
  • +

    For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU.

    +
  • +
+

The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer".

+

The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component.

+

For the "REQUEST" method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REQUEST of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0+

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+ +Rescheduling a poll +

The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll.

+
+Updating or Reconfirmation of a Poll

The "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll.

+

The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.

+ +Confirmation of a Poll +

The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+ +Closing a Poll +

The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+Delegating a Poll to Another CU

Some calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU.

+

The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above.

+

In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY"

+

method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address.

+

The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".

+ +Changing the Organizer +

The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer".

+
+ +Sending on Behalf of the Organizer +

There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer".

+
+Forwarding to an Uninvited CU

A "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU.

+

The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll.

+

If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added.

+

When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.

+ +Updating Voter Status +

The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST".

+
+Method: REPLY

The "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property.

+

The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed.

+

The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter".

+

A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value.

+

The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter.

+

The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REPLY of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+ + +

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+ + +

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+
+

VTODO

+
+

0

+
+
+Method: CANCEL

The "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll.

+

The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each.

+

When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in .

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:CANCEL of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

1

+
+
+

ATTACH

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: REFRESH

The "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REFRESH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0

+
+
+

DESCRIPTION

+
+

0

+
+
+

DTEND

+
+

0

+
+
+

DTSTART

+
+

0

+
+
+

DURATION

+
+

0

+
+
+

GEO

+
+

0

+
+
+

LAST-MODIFIED

+
+

0

+
+
+

LOCATION

+
+

0

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0

+
+
+

RELATED-TO

+
+

0

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0

+
+
+

SEQUENCE

+
+

0

+
+
+

STATUS

+
+

0

+
+
+

SUMMARY

+
+

0

+
+
+

URL

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: POLLSTATUS

The "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:POLLSTATUS of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+CalDAV Extensions

This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends as it a VPOLL component is a +schedulable entity.

+Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+CALDAV:supported-vpoll-component-sets
+
Name
+
+

supported-vpoll-component-sets

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
Definition
+
+
+<!ELEMENT supported-vpoll-component-sets + (supported-vpoll-component-set*) > + +<!ELEMENT supported-vpoll-component-set (comp+)> + +<C:supported-vpoll-component-sets + xmlns:C="urn:ietf:params:xml:ns:caldav"> + + <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT or VFREEBUSY --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> +</C:supported-vpoll-component-sets> +
+CALDAV:vpoll-max-items
+
Name
+
+

vpoll-max-items

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-items (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-items> +
+CALDAV:vpoll-max-active
+
Name
+
+

vpoll-max-active

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-active (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-active> +
+CALDAV:vpoll-max-voters
+
Name
+
+

+vpoll-max-voters +

+
+
Namespace
+
+

+urn:ietf:params:xml:ns:caldav +

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-voters (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-voters> +
+ +CalDAV:even-more-properties + +Extensions to CalDAV scheduling

This specification extends .

+

Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+
+
(CALDAV:supported-vpoll-component-sets)
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
(CALDAV:vpoll-max-items)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored;

+
+
(CALDAV:vpoll-max-active)
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored;

+
+
(CALDAV:vpoll-max-voters)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored;

+
+
+CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+>> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<C:calendar-query xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:prop> + <D:getetag/> + <C:calendar-data> + <C:comp name="VCALENDAR"> + <C:prop name="VERSION"/> + <C:comp name="VPOLL"> + <C:prop name="SUMMARY"/> + <C:prop name="UID"/> + <C:prop name="DTSTART"/> + <C:prop name="DTEND"/> + <C:prop name="DURATION"/> + </C:comp> + + </C:comp> + </C:calendar-data> + </D:prop> + <C:filter> + <C:comp-filter name="VCALENDAR"> + <C:comp-filter name="VPOLL"> + <C:time-range start="20121204T000000Z" + end="20121205T000000Z"/> + </C:comp-filter> + </C:comp-filter> + </C:filter> +</C:calendar-query> + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<D:multistatus xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd2"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd3"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> +</D:multistatus> +
+CalDAV time ranges

"CALDAV:time-range XML Element" in 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

++-------------------------------------------------------------------+ +| VPOLL has the DTSTART property? | +| +---------------------------------------------------------------+ +| | VPOLL has the DURATION property? | +| | +-----------------------------------------------------------+ +| | | VPOLL has the DTEND property? | +| | | +-------------------------------------------------------+ +| | | | VPOLL has the COMPLETED property? | +| | | | +---------------------------------------------------+ +| | | | | VPOLL has the CREATED property? | +| | | | | +-----------------------------------------------+ +| | | | | | Condition to evaluate | ++---+---+---+---+---+-----------------------------------------------+ +| Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | +| | | | | | ((end > DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+ +
+ +Security Considerations +

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs.

+
+IANA ConsiderationsParameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in 8.2.4:

+ + + + + + + + + + + + + + + + + + + + +
Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+ +

+
+

STAY-INFORMED

+
+

Current

+
+

+ +

+
+Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in 8.2.3:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+ +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+ +

+
+

POLL-MODE

+
+

Current

+
+

+ +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+ +

+
+

POLL-WINNER

+
+

Current

+
+

+ +

+
+

RESPONSE

+
+

Current

+
+

+ +

+
+POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+
+
Poll mode name
+
+

The name of the poll mode.

+
+
Purpose
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
Reference
+
+

A reference to the RFC in which the poll mode is defined

+
+
+POLL-MODE Registrations

This document defines the following registered poll modes.

+ + + + + + + + + + + + + + + +
Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+ + + + +
Open issues

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event.

+

Need to write down what isn't valid in a VPOLL
+ a. Can't change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:douglm@mysite.edu +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:VFREEBUSY +....... +END:VFREEBUSY +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+Change log +
+
Calext V01: 2019-10-17 MD
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
Calext V00: 2019-05-17 MD
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
V03: 2014-10-28 MD
+
+
    +
  • +

    Add VVOTER and VOTE components.

    +
  • +
  • +

    Add RESPONSE property.

    +
  • +
  • +

    Remove RESPONSE parameter from VOTER.

    +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +

    Add reply-url property and required parameter.

    +
  • +
  • +

    Fix ACCEPT-RESPONSE definition.

    +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +

    Typos fixed, clarifications made.

    +
  • +
  • +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
  • +
  • +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
  • +
  • +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
  • +
  • +

    iTip: fix broken table cells

    +
  • +
  • +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
  • +
  • +

    Added Caldav scheduling section

    +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +

    Removed method CONFIRM

    +
  • +
  • +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
  • +
  • +

    Added POLL-WINNER and verbiage

    +
  • +
  • +

    Added STATUS values

    +
  • +
  • +

    Added RELTYPE=POLL

    +
  • +
  • +

    Added supported-vpoll-component-sets

    +
  • +
  • +

    Added CalDAV related parameters to VOTER

    +
  • +
  • +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
Normative references 2020-07-16 HTTP Extensions for Distributed Authoring — WEBDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2518.xml https://www.rfc-editor.org/info/rfc2518 RFC 2518 RFC2518 10.17487/RFC2518 1999-02 Y. Goland Internet Engineering Task Force IETF E. Whitehead Internet Engineering Task Force IETF A. Faizi Internet Engineering Task Force IETF S. Carter Internet Engineering Task Force IETF D. Jensen Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] RFC 2518 Fremont, CA 2020-07-16 Uniform Resource Identifier (URI): Generic Syntax https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.3986.xml https://www.rfc-editor.org/info/rfc3986 RFC 3986 RFC3986 10.17487/RFC3986 2005-01 T. Berners-Lee Internet Engineering Task Force IETF R. Fielding Internet Engineering Task Force IETF L. Masinter Internet Engineering Task Force IETF Internet Engineering Task Force IETF en A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] STD 66 RFC 3986 Fremont, CA 2020-07-16 Calendaring Extensions to WebDAV (CalDAV) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.4791.xml https://www.rfc-editor.org/info/rfc4791 RFC 4791 RFC4791 10.17487/RFC4791 2007-03 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF L. Dusseault Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the "calendar-access" feature of CalDAV. [STANDARDS-TRACK] RFC 4791 Fremont, CA 2020-07-16 Internet Calendaring and Scheduling Core Object Specification (iCalendar) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5545.xml https://www.rfc-editor.org/info/rfc5545 RFC 5545 RFC5545 10.17487/RFC5545 2009-09 B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] RFC 5545 Fremont, CA 2020-07-16 iCalendar Transport-Independent Interoperability Protocol (iTIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5546.xml https://www.rfc-editor.org/info/rfc5546 RFC 5546 RFC5546 10.17487/RFC5546 2009-12 C. Daboo Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] RFC 5546 Fremont, CA 2020-07-16 iCalendar Message-Based Interoperability Protocol (iMIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6047.xml https://www.rfc-editor.org/info/rfc6047 RFC 6047 RFC6047 10.17487/RFC6047 2010-12 A. Melnikov Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document, "iCalendar Message-Based Interoperability Protocol (iMIP)", specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] RFC 6047 Fremont, CA 2020-07-16 Scheduling Extensions to CalDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6638.xml https://www.rfc-editor.org/info/rfc6638 RFC 6638 RFC6638 10.17487/RFC6638 2012-06 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) "calendar-access" feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the "calendar-auto-schedule" feature of CalDAV. [STANDARDS-TRACK] RFC 6638 Fremont, CA 2020-07-30 Event Publishing Extensions to iCalendar https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-calext-eventpub-extensions.xml http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.txt http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.pdf I-D.ietf-calext-eventpub-extensions I-D.ietf-calext-eventpub-extensions draft-ietf-calext-eventpub-extensions-15 2019-10 Michael Douglass Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This specification updates RFC5545 by introducing a number of new iCalendar properties and components which are of particular use for event publishers and in social networking. This specification also defines a new STRUCTURED-DATA property for iCalendar RFC5545 to allow for data that is directly pertinent to an event or task to be included with the calendar data. Internet-Draft draft-ietf-calext-eventpub-extensions-15 Fremont, CA +Bibliography + +
diff --git a/documents/draft-york-vpoll.html b/documents/draft-york-vpoll.html new file mode 100644 index 0000000..b0fb05b --- /dev/null +++ b/documents/draft-york-vpoll.html @@ -0,0 +1,9150 @@ + + + + + + +VPOLL: Consensus Scheduling Component for iCalendar + + + + + + + + + + + + + + + + + + + + + + + + +
Internet-DraftVPOLLJuly 2020
York, et al.Expires 31 January 2021[Page]
+
+
+
+
Workgroup:
+
Network Working Group
+
Internet-Draft:
+
draft-york-vpoll-05
+
:
+
+
Published:
+
+ +
+
Intended Status:
+
Standards Track
+
Expires:
+
+
Authors:
+
+
+
E. York
+
+
+
C. Daboo
+
+
+
M. Douglass
+
+
+
+
+

VPOLL: Consensus Scheduling Component for iCalendar

+
+
+

Abstract

+
+

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+
+
+
+
+
+

+Status of This Memo +

+

+ This Internet-Draft is submitted in full conformance with the + provisions of BCP 78 and BCP 79.

+

+ Internet-Drafts are working documents of the Internet Engineering Task + Force (IETF). Note that other groups may also distribute working + documents as Internet-Drafts. The list of current Internet-Drafts is + at https://datatracker.ietf.org/drafts/current/.

+

+ Internet-Drafts are draft documents valid for a maximum of six months + and may be updated, replaced, or obsoleted by other documents at any + time. It is inappropriate to use Internet-Drafts as reference + material or to cite them other than as "work in progress."

+

+ This Internet-Draft will expire on 31 January 2021.

+
+
+ +
+
+

+Table of Contents +

+ +
+
+
+
+

+1. Acknowledgements +

+
+

The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support.

+
+
+
+
+
+

+2. Introduction +

+
+

The currently existing approach to agreeing on meeting times using +iTip [RFC5546] and/or iMip [RFC6047] has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+
+
+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+
+
+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+
+
+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+
+
+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+
+
+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+
+
+
+
+
+

+3. Terms and definitions +

+
+

For the purposes of this document, + the following terms and definitions apply.

+
+
+
+

+3.1. consensus scheduling +

+
+

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+
+
+
+
+

+3.2. active Vpoll +

+
+

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+
+
+
+
+

+3.3. voter +

+
+

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+
+
+
+
+
+
+

+4. Simple Consensus Scheduling +

+
+

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+
+
+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+
+
+
+

+4.1. The VPOLL Component: An Overview +

+
+

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
+
+
DTSTAMP
+
+
+

The usual [RFC5545] property.

+
+
+
+
SEQUENCE
+
+
+

The usual [RFC5545] property. See below for SEQUENCE +behavior.

+
+
+
+
UID
+
+
+

The usual [RFC5545] property.

+
+
+
+
ORGANIZER
+
+
+

The usual [RFC5545] property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
+
+
SUMMARY
+
+
+

The usual [RFC5545] property. This optional but +recommended property provides the a short title to the poll.

+
+
+
+
DESCRIPTION
+
+
+

The usual [RFC5545] property. This optional property +provides more details.

+
+
+
+
DTEND
+
+
+

The usual [RFC5545] property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
+
+
POLL-MODE
+
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives.

+
+
+
+
POLL-COMPLETION
+
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice.

+
+
+
+
POLL-PROPERTIES
+
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
+
+
PARTICIPANT
+
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
+
+
VOTE
+
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
+
+
VEVENT
+
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+
+
+
+
+

EXAMPLE

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD:REQUEST
+BEGIN:VPOLL
+POLL-MODE:BASIC
+POLL-COMPLETION:SERVER-SUBMIT
+POLL-PROPERTIES:DTSTART,LOCATION
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T000000Z
+SUMMARY:What to do this week
+DTEND:20120101T000000Z
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+END PARTICIPANT
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+END PARTICIPANT
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:mike@example.com
+END PARTICIPANT
+BEGIN:VEVENT.......(with a poll-item-id=1)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=2)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=3)
+END:VEVENT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 1
+
+
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+
+
+
+
+
+

+4.2. The VPOLL Alternative Choices: An Overview +

+
+

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard [RFC5545] components. For our +simple use case they are all VEVENT components. In addition to the +usual [RFC5545] properties some extra properties are used for a +VPOLL.

+
+
+
+
POLL-ITEM-ID
+
+
+

This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer.

+
+
+
+
+
+
+
+
+
+

+4.3. VPOLL responses +

+
+

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
+
+
DTSTAMP
+
+
+

The usual [RFC5545] property.

+
+
+
+
SEQUENCE
+
+
+

The usual [RFC5545] property. See below for SEQUENCE +behavior.

+
+
+
+
UID
+
+
+

Same as the request.

+
+
+
+
ORGANIZER
+
+
+

Same as the request.

+
+
+
+
SUMMARY
+
+
+

Same as the request.

+
+
+
+
PARTICIPANT
+
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
+
+
VOTE
+
+
+

One per item being voted on.

+
+
+
+
POLL-ITEM-ID
+
+
+

One inside each VOTE component to identify the choice.

+
+
+
+
RESPONSE
+
+
+

One inside each VOTE component to specify the vote.

+
+
+
+
+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
+
+
NOTE
+
+
+

This is poll-mode specific behavior?

+
+
+
+
+
+
+

EXAMPLE

+
+
+

REPLY VPOLL from Cyrus:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: REPLY
+BEGIN:VPOLL
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T010000Z
+SUMMARY:What to do this week
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+BEGIN:VOTE
+POLL-ITEM-ID:1
+RESPONSE:50
+COMMENT:Work on iTIP
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+COMMENT:Work on WebDAV
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 2
+
+
+
+
+
+

+4.4. VPOLL updates +

+
+

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+
+
+

EXAMPLE

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: POLLSTATUS
+BEGIN:VPOLL
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T020000Z
+SEQUENCE:0
+SUMMARY:What to do this week
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+BEGIN: VOTE
+POLL-ITEM-ID:1
+RESPONSE:50
+COMMENT:Work on iTIP
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+COMMENT:Work on WebDAV
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+BEGIN:VOTE
+POLL-ITEM-ID:1
+RESPONSE:100
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 3
+
+
+
+
+
+

+4.5. VPOLL Completion +

+
+

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+
+
+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED".

+
+
+

EXAMPLE

+
+
+

VPOLL confirmation:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: REQUEST
+BEGIN:VPOLL
+ORGANIZER:mailto:douglm@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T030000Z
+COMPLETED:20120101T030000Z
+POLL-COMPLETION:SERVER-SUBMIT
+SEQUENCE:0
+SUMMARY:What to do this week
+STATUS:CONFIRMED
+POLL-WINNER:3
+BEGIN:VEVENT.......(with a poll-item-id=1)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=2)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=3)
+END:VEVENT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 4
+
+
+
+
+
+

+4.6. Other Responses +

+
+

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+
+
+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+
+
+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+
+
+
+
+
+
+
+

+5. iCalendar Extensions +

+
+
+

+5.1. Updated Participant Type Value +

+
+

Participant type property values are defined in section 11.2.1. of +[I-D.ietf-calext-eventpub-extensions]. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
partvalue       /= "VOTER"
+
+
Figure 5
+
+
+
+
Description
+
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+
+
+
+
+
+
+
+

+5.2. Updated Relation Type Value +

+
+

Relationship parameter type values are defined in section 3.2.15. of +[RFC5545]. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
reltypeparam       /= "RELTYPE" "=" "POLL"
+; Property value is a VPOLL uid
+
+
Figure 6
+
+
+
+
Description
+
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+
+
+
+
+
+
+
+

+5.3. Updated Status Value +

+
+

Status property values are defined in section 3.8.1.11. of [RFC5545]. +This specification updates that type to define valid VPOLL status +values.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
statvalue /= statvalue-poll
+   ; Status values for "VPOLL".
+statvalue-poll = "IN-PROCESS"
+          / "COMPLETED"  ; Poll has closed,
+                         ; nothing has been chosen yet
+          / "CONFIRMED"  ; Poll has closed and
+                         ; winning items confirmed
+          / "SUBMITTED"  ; The winning item has been
+                         ; submitted
+          / "CANCELLED"
+
+
Figure 7
+
+
+
+
Description
+
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
+
+
+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
Figure 8
+
+
+
+
+
+
+
+
+
+

+5.4. New Property Parameters +

+
+
+

+5.4.1. Required +

+
+
+
Parameter name
+
+
+

REQUIRED

+
+
+
+
Purpose
+
+
+

To specify whether the associated property is required in +the current context.

+
+
+
+
Format Definition
+
+
+

This parameter is defined by the following notation:

+
+
+
+
+
+
+
+
+
requirededparam = "REQUIRED"  "=" ("TRUE" / "FALSE")
+  ; Default is FALSE
+
+
Figure 9
+
+
+
+
Description
+
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+
+
+
+
+
+
+
+

+5.4.2. Stay-Informed +

+
+
+
Parameter name
+
+
+

STAY-INFORMED

+
+
+
+
Purpose
+
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
+
+
Format Definition
+
+
+

This parameter is defined by the following notation:

+
+
+
+
+
+
+
+
+
stayinformedparam = "STAY-INFORMED"  "=" ("TRUE" / "FALSE")
+                  ; Default is FALSE
+
+
Figure 10
+
+
+
+
Description
+
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+
+
+
+
+
+
+
+
+
+

+5.5. New Properties +

+
+
+

+5.5.1. Accept-Response +

+
+
+
Property name
+
+
+

ACCEPT-RESPONSE

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+
+
+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":"
+                    iana-token ("," iana-token) CRLF
+
+acceptresponseparams = *(";" other-param)
+
+
Figure 11
+
+
+
+
+
+

+5.5.2. Poll-Completion +

+
+
+
Property name
+
+
+

POLL-COMPLETION

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
+
+
Description
+
+
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

+
+
+

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+
+
+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+
+
+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF
+
+pcparam = *(";" other-param)
+
+pcvalue = "SERVER"  ; The server is responsible for both choosing and
+                   ; submitting the winner(s)
+        / "SERVER-SUBMIT" ; The server is responsible for
+                   ; submitting the winner(s). The client chooses.
+        / "SERVER-CHOICE"  ; The server is responsible for
+                   ; choosing the winner(s). The client will submit.
+        / "CLIENT" ; The client is responsible for both choosing and
+                   ; submitting the winner(s)
+        / iana-token
+        / x-name
+        ;Default is CLIENT
+
+
Figure 12
+
+
+
+
Example
+
+
+

The following is an example of this property:

+
+
+
+
+
+
+
+
+
POLL-COMPLETION: SERVER-SUBMIT
+
+
Figure 13
+
+
+
+
+
+

+5.5.3. Poll-Item-Id +

+
+
+
Property name
+
+
+

POLL-ITEM-ID

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL child components as an +identifier.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Property Parameters
+
+
+

Non-standard parameters can be specified on +this property.

+
+
+
+
Conformance
+
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
+
+
Description
+
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+
+
+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollitemid = "POLL-ITEM-ID" pollitemdparams ":"
+                  integer CRLF
+
+pollitemidparams = *(
+                   (";" other-param)
+            )
+
+
Figure 14
+
+
+
+
+
+

+5.5.4. Poll-Mode +

+
+
+
Property name
+
+
+

POLL-MODE

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
+
+
Description
+
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+
+
+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollmode = "POLL-MODE" pollmodeparams ":"
+             ("BASIC" / iana-token / other-token) CRLF
+
+pollmodeparams = *(";" other-param)
+
+
Figure 15
+
+
+
+
+
+

+5.5.5. Poll-properties +

+
+
+
Property name
+
+
+

POLL-PROPERTIES

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollproperties = "POLL-PROPERTIES" pollpropparams ":"
+             text *("," text) CRLF
+
+pollpropparams = *(";" other-param)
+
+
Figure 16
+
+
+
+
+
+

+5.5.6. Poll-Winner +

+
+
+
Property name
+
+
+

POLL-WINNER

+
+
+
+
Purpose
+
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Property Parameters
+
+
+

Non-standard parameters can be specified on +this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollwinner = "POLL-WINNER" pollwinnerparams ":"
+                 integer CRLF
+
+pollwinnerparams = *(";" other-param)
+
+       ; Used with a STATUS:CONFIRMED VPOLL to indicate which
+       ; components have been confirmed
+
+
Figure 17
+
+
+
+
+
+

+5.5.7. Reply-URL +

+
+
+
Property name
+
+
+

REPLY-URL

+
+
+
+
Purpose
+
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
+
+
Property Parameters
+
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF
+
+reply-urlparams = *(
+                  (";" requiredparam) /
+                  (";" other-param)
+                  )
+
+
Figure 18
+
+
+
+
+
+

+5.5.8. Response +

+
+
+
Property name
+
+
+

RESPONSE

+
+
+
+
Purpose
+
+
+

To specify a response vote.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
response = "RESPONSE" response-params ":" integer CRLF
+                 ; integer value 0..100
+
+responseparams = *(";" other-param)
+
+
Figure 19
+
+
+
+
Description
+
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
+
    +
  • +
    +

    0 - 39 A "NO vote"

    +
    +
  • +
  • +
    +

    40 - 79 A "MAYBE" vote

    +
    +
  • +
  • +
    +

    80 - 89 A "YES - but not preferred vote"

    +
    +
  • +
  • +
    +

    90-100 A "YES" vote.

    +
    +
    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
    +
  • +
+
+
+
+
+
+
+
+
+
+
+

+5.6. New Components +

+
+
+

+5.6.1. VPOLL Component +

+
+
+
Component name
+
+
+

VPOLL

+
+
+
+
Purpose
+
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollc    = "BEGIN" ":" "VPOLL" CRLF
+            pollprop
+            *participantc *eventc *todoc *journalc *freebusyc
+            *availabilityc *alarmc *iana-comp *x-comp
+            "END" ":" "VPOLL" CRLF
+
+pollprop = *(
+          ;
+          ; The following are REQUIRED,
+          ; but MUST NOT occur more than once.
+          ;
+          dtstamp / uid / organizer /
+          ;
+          ; The following are OPTIONAL,
+          ; but MUST NOT occur more than once.
+          ;
+          acceptresponse / class / created / completed /
+          description / dtstart / last-mod / pollmode /
+          pollproperties / priority / seq / status /
+          summary / url /
+          ;
+          ; Either 'dtend' or 'duration' MAY appear in
+          ; a 'pollprop', but 'dtend' and 'duration'
+          ; MUST NOT occur in the same 'pollprop'.
+          ; 'duration' MUST only occur when 'dtstart'
+          ; is present
+          ;
+          dtend / duration /
+          ;
+          ; The following are OPTIONAL,
+          ; and MAY occur more than once.
+          ;
+          attach / categories / comment /
+          contact / rstatus / related /
+          resources / x-prop / iana-prop
+          ;
+          ; The following is OPTIONAL, it SHOULD appear
+          ; once for the confirmation of a BASIC mode
+          ; VPOLL. Other modes may define differing
+          ; requirements.
+          ;
+          pollwinner /
+          ;
+          )
+
+
Figure 20
+
+
+
+
Description
+
+
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

+
+
+

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+
+
+

If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+
+
+

If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+
+
+

"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+
+
+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+
+
+
+
+
+
+
+
+

+5.6.2. VOTE Component +

+
+
+
Component name
+
+
+

VOTE

+
+
+
+
Purpose
+
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
+
+
Conformance
+
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
votec     = "BEGIN" ":" "VOTE" CRLF
+            voteprop
+            *eventc *todoc *journalc *freebusyc
+            *availabilityc *alarmc *iana-comp *x-comp
+            "END" ":" "VOTE" CRLF
+
+voteprop = *(
+           ;
+           ; The following are REQUIRED,
+           ; but MUST NOT occur more than once.
+           ;
+           pollitemid / response /
+           ;
+           ; The following are OPTIONAL,
+           ; and MAY occur more than once.
+           ;
+           comment / x-prop / iana-prop
+           ;
+           )
+
+
Figure 21
+
+
+
+
Description
+
+
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

+
+
+

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+
+
+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+
+
+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.

+
+
+
+
+
+
+
+
+
+
+
+
+
+

+6. Poll Modes +

+
+

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+
+
+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see Section 10.3) in a published RFC.

+
+
+
+

+6.1. POLL-MODE:BASIC +

+
+

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+
+
+
+

+6.1.1. Property restrictions +

+
+

This poll mode has the following property requirements:

+
+
+
+
POLL-ITEM-ID
+
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
+
+
POLL-WINNER
+
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+
+
+
+
+
+
+
+

+6.1.2. Outcome reporting +

+
+

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+
+
+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+
+
+
+
+
+
+
+
+
+

+7. iTIP Extensions +

+
+

This specification introduces a number of extensions to [RFC5546]. +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+
+
+

For many of the iTip processing rules the voters take the place of +attendees.

+
+
+
+

+7.1. Methods +

+
+

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1
MethodDescription
+
+

PUBLISH

+
+
+
+

No changes (yet)

+
+
+
+

REQUEST

+
+
+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+
+
+

REPLY

+
+
+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+
+
+

ADD

+
+
+
+

Not supported for VPOLL.

+
+
+
+

CANCEL

+
+
+
+

There MUST be a single VPOLL component with UID

+
+
+
+

matching that of the poll being cancelled.

+
+
+
+

REFRESH

+
+
+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+
+
+

COUNTER

+
+
+
+

Not supported for VPOLL.

+
+
+
+

DECLINECOUNTER

+
+
+
+

Not supported for VPOLL.

+
+
+
+

POLLSTATUS

+
+
+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+
+
+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+
+
+ + + + + + + + + + + + + + + + + + +
Table 2
OriginatorMethods
+
+

Organizer

+
+
+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+
+
+

Voter

+
+
+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+
+
+
+
+
+
+

+7.2. Interoperability Models +

+
+

Most of the standard iTip specification applies with respect to +organizer and voters.

+
+
+
+

+7.2.1. Delegation +

+
+

TBD

+
+
+
+ +
+
+

+7.2.3. Component Revisions +

+
    +
  • +
    +

    Need to talk about what a change in SEQUENCE means

    +
    +
  • +
  • +
    +

    Sequence change forces a revote.

    +
    +
  • +
  • +
    +

    New voter - no sequence change

    +
    +
  • +
  • +
    +

    Add another poll set or change poll item ids or any change to a child

    +
    +
  • +
  • +
    +

    component - bump sequence

    +
    +
  • +
+
+
+
+
+

+7.2.4. Message Sequencing +

+
+

TBD

+
+
+
+
+
+
+
+

+7.3. Application Protocol Elements +

+
+
+

+7.3.1. Methods for VPOLL Calendar Components +

+
+

This section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+
+
+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3
Presence ValueDescription
+
+

1

+
+
+
+

One instance MUST be present.

+
+
+
+

1+

+
+
+
+

At least one instance MUST be present.

+
+
+
+

0

+
+
+
+

Instances of this property MUST NOT be present.

+
+
+
+

0+

+
+
+
+

Multiple instances MAY be present.

+
+
+
+

0 or 1

+
+
+
+

Up to 1 instance of this property MAY be present.

+
+
+
+
+

The following summarizes the methods that are defined for the "VPOLL" +calendar component.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4
MethodDescription
+
+

PUBLISH

+
+
+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+
+
+

REQUEST

+
+
+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+
+
+

REPLY

+
+
+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+
+
+

CANCEL

+
+
+
+

Cancel a poll.

+
+
+
+

REFRESH

+
+
+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+
+
+

POLLSTATUS

+
+
+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+
+
+
+
+
+
+

+7.3.2. Method: PUBLISH +

+
+

The "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component.

+
+
+
+
Note
+
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+
+
+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 5: +Constraints for a METHOD:PUBLISH of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST equal PUBLISH.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0 or 1

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0 or 1

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

PARTICIPANT

+
+
+
+

0+

+
+
+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTODO

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+
+
+
+
+

+7.3.3. Method: REQUEST +

+
+

The "REQUEST" method in a "VPOLL" component provides the following +scheduling functions:

+
+
    +
  • +
    +

    Invite "Voters" to respond to the poll.

    +
    +
  • +
  • +
    +

    Change the items being voted upon.

    +
    +
  • +
  • +
    +

    Complete or confirm the poll.

    +
    +
  • +
  • +
    +

    Response to a "REFRESH" request.

    +
    +
  • +
  • +
    +

    Update the details of an existing vpoll.

    +
    +
  • +
  • +
    +

    Update the status of "Voters".

    +
    +
  • +
  • +
    +

    Forward a "VPOLL" to another uninvited CU.

    +
    +
  • +
  • +
    +

    For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU.

    +
    +
  • +
  • +
    +

    For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU.

    +
    +
  • +
+
+

The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer".

+
+
+

The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component.

+
+
+

For the "REQUEST" method only a single iCalendar object is permitted.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 6: +Constraints for a METHOD:REQUEST of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REQUEST.

+
+
+
+

VPOLL

+
+
+
+

1

+
+
+
+

PARTICIPANT

+
+
+
+

1+

+
+
+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0 or 1

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTODO

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+
+
+
+7.3.3.1. Rescheduling a poll +
+
+

The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll.

+
+
+
+
+
+
+7.3.3.2. Updating or Reconfirmation of a Poll +
+
+

The "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method

+
+
+

describes an update of the poll details, but not a rescheduling of +the POLL.

+
+
+

The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll.

+
+
+

The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.

+
+
+
+
+
+
+7.3.3.3. Confirmation of a Poll +
+
+

The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+
+
+
+
+
+7.3.3.4. Closing a Poll +
+
+

The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+
+
+
+
+
+7.3.3.5. Delegating a Poll to Another CU +
+
+

Some calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU.

+
+
+

The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above.

+
+
+

In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY"

+
+
+

method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address.

+
+
+

The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".

+
+
+
+
+
+
+7.3.3.6. Changing the Organizer +
+
+

The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer".

+
+
+
+
+
+
+7.3.3.7. Sending on Behalf of the Organizer +
+
+

There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer".

+
+
+
+
+
+
+7.3.3.8. Forwarding to an Uninvited CU +
+
+

A "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU.

+
+
+

The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll.

+
+
+

If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added.

+
+
+

When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.

+
+
+
+
+
+
+7.3.3.9. Updating Voter Status +
+
+

The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST".

+
+
+
+
+
+
+
+

+7.3.4. Method: REPLY +

+
+

The "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property.

+
+
+

The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed.

+
+
+

The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter".

+
+
+

A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value.

+
+
+

The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter.

+
+
+

The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 7: +Constraints for a METHOD:REPLY of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REPLY.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

All components MUST have the same

+
+
+
+

UID.

+
+
+
+

PARTICIPANT

+
+
+
+

1

+
+
+
+

Identifies the Voter replying.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID of the original

+
+
+
+

REQUEST.

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

1+

+
+
+
+

One per item being voted on.

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

SUMMARY

+
+
+
+

0 or 1

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0 or 1

+
+
+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+
+
+

VAVAILABILITY

+
+
+
+

0

+
+
+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.5. Method: CANCEL +

+
+

The "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll.

+
+
+

The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each.

+
+
+

When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in Section 7.2.3.

+
+
+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 8: +Constraints for a METHOD:CANCEL of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be CANCEL.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

All must have the same UID.

+
+
+
+

PARTICIPANT

+
+
+
+

0+

+
+
+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID of the original REQUEST.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+
+
+

SUMMARY

+
+
+
+

0 or 1

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.6. Method: REFRESH +

+
+

The "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 9: +Constraints for a METHOD:REFRESH of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REFRESH.

+
+
+
+

VPOLL

+
+
+
+

1

+
+
+
+

PARTICIPANT

+
+
+
+

1

+
+
+
+

MUST identify the requester as a voter.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID associated with original REQUEST.

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

ATTACH

+
+
+
+

0

+
+
+
+

CATEGORIES

+
+
+
+

0

+
+
+
+

CLASS

+
+
+
+

0

+
+
+
+

CONTACT

+
+
+
+

0

+
+
+
+

CREATED

+
+
+
+

0

+
+
+
+

DESCRIPTION

+
+
+
+

0

+
+
+
+

DTEND

+
+
+
+

0

+
+
+
+

DTSTART

+
+
+
+

0

+
+
+
+

DURATION

+
+
+
+

0

+
+
+
+

GEO

+
+
+
+

0

+
+
+
+

LAST-MODIFIED

+
+
+
+

0

+
+
+
+

LOCATION

+
+
+
+

0

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0

+
+
+
+

RELATED-TO

+
+
+
+

0

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

RESOURCES

+
+
+
+

0

+
+
+
+

SEQUENCE

+
+
+
+

0

+
+
+
+

STATUS

+
+
+
+

0

+
+
+
+

SUMMARY

+
+
+
+

0

+
+
+
+

URL

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.7. Method: POLLSTATUS +

+
+

The "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 10: +Constraints for a METHOD:POLLSTATUS of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST equal POLLSTATUS.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

PARTICIPANT

+
+
+
+

1+

+
+
+
+

The voters containing their current vote

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

Only present for a completed poll

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

ATTACH

+
+
+
+

0

+
+
+
+

CATEGORIES

+
+
+
+

0

+
+
+
+

CLASS

+
+
+
+

0

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

CONTACT

+
+
+
+

0

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+
+
+
+
+
+
+
+
+

+8. CalDAV Extensions +

+
+

This specification extends [RFC4791] in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+
+
+

Additionally, it extends [RFC6638] as it a VPOLL component is a +schedulable entity.

+
+
+
+

+8.1. Calendar Collection Properties +

+
+

This section defines new CalDAV properties for calendar collections.

+
+
+
+

+8.1.1. CALDAV:supported-vpoll-component-sets +

+
+
+
Name
+
+
+

supported-vpoll-component-sets

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

+
+
+

It also specifies the combination of allowed component types.

+
+
+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition Section 8.2 being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT supported-vpoll-component-sets
+     (supported-vpoll-component-set*) >
+
+<!ELEMENT supported-vpoll-component-set (comp+)>
+
+
Figure 22
+
+
+
+
+
<C:supported-vpoll-component-sets
+     xmlns:C="urn:ietf:params:xml:ns:caldav">
+
+  <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VEVENT" />
+    <C:comp name="VFREEBUSY" />
+    <C:comp name="VTODO" />
+  </C:supported-vpoll-component-set>
+
+  <!-- VPOLLs with just VEVENT or VFREEBUSY -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VEVENT" />
+    <C:comp name="VFREEBUSY" />
+  </C:supported-vpoll-component-set>
+
+  <!-- VPOLLs with just VEVENT -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VEVENT" />
+  </C:supported-vpoll-component-set>
+
+  <!-- VPOLLs with just VTODO -->
+  <C:supported-vpoll-component-set>
+    <C:comp name="VTODO" />
+  </C:supported-vpoll-component-set>
+</C:supported-vpoll-component-sets>
+
+
Figure 23
+
+
+
+
+
+

+8.1.2. CALDAV:vpoll-max-items +

+
+
+
Name
+
+
+

vpoll-max-items

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition +Section 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT vpoll-max-items (#PCDATA)>
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 24
+
+
+
+
+
<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav"
+>25</C:vpoll-max-items>
+
+
Figure 25
+
+
+
+
+
+

+8.1.3. CALDAV:vpoll-max-active +

+
+
+
Name
+
+
+

vpoll-max-active

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition +Section 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT vpoll-max-active (#PCDATA)>
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 26
+
+
+
+
+
<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav"
+>25</C:vpoll-max-active>
+
+
Figure 27
+
+
+
+
+
+

+8.1.4. CALDAV:vpoll-max-voters +

+
+
+
Name
+
+
+

+vpoll-max-voters

+
+
+
+
Namespace
+
+
+

+urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition Section 8.2 +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
<!ELEMENT vpoll-max-voters (#PCDATA)>
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 28
+
+
+
+
+
<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav"
+>25</C:vpoll-max-voters>
+
+
Figure 29
+
+
+
+ +
+
+

+8.1.6. Extensions to CalDAV scheduling +

+
+

This specification extends [RFC6638].

+
+
+

Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL.

+
+
+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+
+
+
+
+
+
+
+

+8.2. Additional Preconditions for PUT, COPY, and MOVE +

+
+

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+
+
+

The new preconditions are:

+
+
+
+
(CALDAV:supported-vpoll-component-sets)
+
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
+
+
(CALDAV:vpoll-max-items)
+
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value Section 8.1.2 +on the calendar collection where the resource will be stored;

+
+
+
+
(CALDAV:vpoll-max-active)
+
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value +Section 8.1.3 on the calendar collection where the resource will +be stored;

+
+
+
+
(CALDAV:vpoll-max-voters)
+
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value Section 8.1.4 on the +calendar collection where the resource will be stored;

+
+
+
+
+
+
+
+
+
+

+8.3. CalDAV:calendar-query Report +

+
+

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+
+
+
+

+8.3.1. Example: Partial Retrieval of VPOLL +

+
+

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+
+
+
+
+
>> Request <<
+
+REPORT /cyrus/work/ HTTP/1.1
+Host: cal.example.com
+Depth: 1
+Content-Type: application/xml; charset="utf-8"
+Content-Length: xxxx
+
+<?xml version="1.0" encoding="utf-8" ?>
+<C:calendar-query xmlns:D="DAV:"
+              xmlns:C="urn:ietf:params:xml:ns:caldav">
+  <D:prop>
+    <D:getetag/>
+    <C:calendar-data>
+      <C:comp name="VCALENDAR">
+        <C:prop name="VERSION"/>
+        <C:comp name="VPOLL">
+          <C:prop name="SUMMARY"/>
+          <C:prop name="UID"/>
+          <C:prop name="DTSTART"/>
+          <C:prop name="DTEND"/>
+          <C:prop name="DURATION"/>
+        </C:comp>
+
+      </C:comp>
+    </C:calendar-data>
+  </D:prop>
+  <C:filter>
+    <C:comp-filter name="VCALENDAR">
+      <C:comp-filter name="VPOLL">
+        <C:time-range start="20121204T000000Z"
+                      end="20121205T000000Z"/>
+      </C:comp-filter>
+    </C:comp-filter>
+  </C:filter>
+</C:calendar-query>
+
+>> Response <<
+
+HTTP/1.1 207 Multi-Status
+Date: Sat, 11 Nov 2012 09:32:12 GMT
+Content-Type: application/xml; charset="utf-8"
+Content-Length: xxxx
+
+<?xml version="1.0" encoding="utf-8" ?>
+<D:multistatus xmlns:D="DAV:"
+           xmlns:C="urn:ietf:params:xml:ns:caldav">
+  <D:response>
+    <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href>
+    <D:propstat>
+      <D:prop>
+        <D:getetag>"fffff-abcd2"</D:getetag>
+        <C:calendar-data>BEGIN:VCALENDAR
+VERSION:2.0
+BEGIN:VPOLL
+DTSTART;TZID=US/Eastern:20121202T120000
+DURATION:PT4D
+SUMMARY:Poll #2
+UID:00959BC664CA650E933C892C@example.com
+END:VPOLL
+END:VCALENDAR
+</C:calendar-data>
+      </D:prop>
+      <D:status>HTTP/1.1 200 OK</D:status>
+    </D:propstat>
+  </D:response>
+  <D:response>
+    <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href>
+    <D:propstat>
+      <D:prop>
+        <D:getetag>"fffff-abcd3"</D:getetag>
+        <C:calendar-data>BEGIN:VCALENDAR
+
+VERSION:2.0
+PRODID:-//Example Corp.//CalDAV Client//EN
+BEGIN:VPOLL
+DTSTART;TZID=US/Eastern:20121204T100000
+DURATION:PT4D
+SUMMARY:Poll #3
+UID:DC6C50A017428C5216A2F1CD@example.com
+END:VPOLL
+END:VCALENDAR
+</C:calendar-data>
+      </D:prop>
+      <D:status>HTTP/1.1 200 OK</D:status>
+    </D:propstat>
+  </D:response>
+</D:multistatus>
+
+
Figure 30
+
+
+
+
+
+
+
+

+8.4. CalDAV time ranges +

+
+

"CALDAV:time-range XML Element" in [RFC4791] describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends [RFC4791] to +describe the meaning of time ranges for VPOLL

+
+
+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

+
+
+
+
+
+-------------------------------------------------------------------+
+| VPOLL has the DTSTART property?                                   |
+|   +---------------------------------------------------------------+
+|   |   VPOLL has the DURATION property?                            |
+|   |   +-----------------------------------------------------------+
+|   |   | VPOLL has the DTEND property?                             |
+|   |   |   +-------------------------------------------------------+
+|   |   |   | VPOLL has the COMPLETED property?                     |
+|   |   |   |   +---------------------------------------------------+
+|   |   |   |   | VPOLL has the CREATED property?                   |
+|   |   |   |   |   +-----------------------------------------------+
+|   |   |   |   |   | Condition to evaluate                         |
++---+---+---+---+---+-----------------------------------------------+
+| Y | Y | N | * | * | (start  <= DTSTART+DURATION)  AND             |
+|   |   |   |   |   | ((end   >  DTSTART)  OR                       |
+|   |   |   |   |   |  (end   >= DTSTART+DURATION))                 |
++---+---+---+---+---+-----------------------------------------------+
+| Y | N | Y | * | * | ((start <  DTEND)    OR  (start <= DTSTART))  |
+|   |   |   |   |   | AND                                           |
+|   |   |   |   |   | ((end   >  DTSTART)  OR  (end   >= DTEND))    |
++---+---+---+---+---+-----------------------------------------------+
+| Y | N | N | * | * | (start  <= DTSTART)  AND (end >  DTSTART)     |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | Y | * | * | (start  <  DTEND)    AND (end >= DTEND)       |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | Y | Y | ((start <= CREATED)  OR  (start <= COMPLETED))|
+|   |   |   |   |   | AND                                           |
+|   |   |   |   |   | ((end   >= CREATED)  OR  (end   >= COMPLETED))|
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | Y | N | (start  <= COMPLETED) AND (end  >= COMPLETED) |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | N | Y | (end    >  CREATED)                           |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | N | N | TRUE                                          |
++---+---+---+---+---+-----------------------------------------------+
+
+
Figure 31
+
+
+
+
+
+
+
+

+9. Security Considerations +

+
+

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See [RFC3986] for a +discussion of the security considerations relating to URIs.

+
+
+
+
+
+

+10. IANA Considerations +

+
+
+

+10.1. Parameter Registrations +

+
+

This document defines the following new iCalendar property parameters +to be added to the registry defined in [RFC5545]:

+
+
+ + + + + + + + + + + + + + + + + + + + + +
Table 11
Property ParameterStatusReference
+
+

REQUIRED

+
+
+
+

Current

+
+
+ +
+
+

STAY-INFORMED

+
+
+
+

Current

+
+
+ +
+
+
+
+
+
+

+10.2. Property Registrations +

+
+

This document defines the following new iCalendar properties to be +added to the registry defined in [RFC5545]:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12
PropertyStatusReference
+
+

ACCEPT-RESPONSE

+
+
+
+

Current

+
+
+ +
+
+

POLL-ITEM-ID

+
+
+
+

Current

+
+
+ +
+
+

POLL-MODE

+
+
+
+

Current

+
+
+ +
+
+

POLL-PROPERTIES

+
+
+
+

Current

+
+
+ +
+
+

POLL-WINNER

+
+
+
+

Current

+
+
+ +
+
+

RESPONSE

+
+
+
+

Current

+
+
+ +
+
+
+
+
+
+

+10.3. POLL-MODE Registration Template +

+
+

A poll mode is defined by completing the following template.

+
+
+
+
Poll mode name
+
+
+

The name of the poll mode.

+
+
+
+
Purpose
+
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
+
+
Reference
+
+
+

A reference to the RFC in which the poll mode is defined

+
+
+
+
+
+
+
+
+
+

+10.4. POLL-MODE Registrations +

+
+

This document defines the following registered poll modes.

+
+
+ + + + + + + + + + + + + + + + +
Table 13
Poll mode namePurposeReference
+
+

BASIC

+
+
+
+

To provide simple voting for a single outcome from a number of candidates.

+
+
+
+

Current

+
+
+
+
+
+
+
+
+
+

+11. Normative references +

+
+
[RFC2518]
+
+Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D. Jensen, "HTTP Extensions for Distributed Authoring - WEBDAV", IETF RFC 2518, IETF RFC 2518, DOI 10.17487/RFC2518, , <https://www.rfc-editor.org/info/rfc2518>.
+
+
[RFC3986]
+
+Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", IETF RFC 3986, IETF RFC 3986, DOI 10.17487/RFC3986, , <https://www.rfc-editor.org/info/rfc3986>.
+
+
[RFC4791]
+
+Daboo, C., Desruisseaux, B., and L. Dusseault, "Calendaring Extensions to WebDAV (CalDAV)", IETF RFC 4791, IETF RFC 4791, DOI 10.17487/RFC4791, , <https://www.rfc-editor.org/info/rfc4791>.
+
+
[RFC5545]
+
+Desruisseaux, B., Ed., "Internet Calendaring and Scheduling Core Object Specification (iCalendar)", IETF RFC 5545, IETF RFC 5545, DOI 10.17487/RFC5545, , <https://www.rfc-editor.org/info/rfc5545>.
+
+
[RFC5546]
+
+Daboo, C., Ed., "iCalendar Transport-Independent Interoperability Protocol (iTIP)", IETF RFC 5546, IETF RFC 5546, DOI 10.17487/RFC5546, , <https://www.rfc-editor.org/info/rfc5546>.
+
+
[RFC6047]
+
+Melnikov, A., Ed., "iCalendar Message-Based Interoperability Protocol (iMIP)", IETF RFC 6047, IETF RFC 6047, DOI 10.17487/RFC6047, , <https://www.rfc-editor.org/info/rfc6047>.
+
+
[RFC6638]
+
+Daboo, C. and B. Desruisseaux, "Scheduling Extensions to CalDAV", IETF RFC 6638, IETF RFC 6638, DOI 10.17487/RFC6638, , <https://www.rfc-editor.org/info/rfc6638>.
+
+
[I-D.ietf-calext-eventpub-extensions]
+
+Douglass, M., "Event Publishing Extensions to iCalendar", IETF I-D.ietf-calext-eventpub-extensions, IETF I-D.ietf-calext-eventpub-extensions, .
+
+
+
+
+
+
+

+12. Bibliography +

+
+
+
+
+

+Appendix A. Open issues +

+
+

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+
+
+

Notifications: Need to do a section on what Notifications to + support. + A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user?

+
+
+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote

+
+
+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+
+
+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+
+
+

Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event.

+
+
+

Need to write down what isn't valid in a VPOLL + a. Can't change POLL-MODE

+
+
+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+
+
+

? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER

+
+
+

Need to add example of freebusy in response

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest
+METHOD: REPLY
+BEGIN:VPOLL
+ORGANIZER:mailto:douglm@mysite.edu
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T010000Z
+SEQUENCE:0
+SUMMARY:What to do this week
+BEGIN:VFREEBUSY
+.......
+END:VFREEBUSY
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 32
+
+
+
+
+
+

+Appendix B. Change log +

+
+
+
Calext V01: 2019-10-17 MD
+
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
+
+
Calext V00: 2019-05-17 MD
+
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
+
+
V03: 2014-10-28 MD
+
+
    +
  • +
    +

    Add VVOTER and VOTE components.

    +
    +
  • +
  • +
    +

    Add RESPONSE property.

    +
    +
  • +
  • +
    +

    Remove RESPONSE parameter from VOTER.

    +
    +
  • +
+
+
+
V03: 2014-05-12 MD
+
+
    +
  • +
    +

    Add reply-url property and required parameter.

    +
    +
  • +
  • +
    +

    Fix ACCEPT-RESPONSE definition.

    +
    +
  • +
+
+
+
V02: 2014-05-12 MD
+
+
    +
  • +
    +

    Typos fixed, clarifications made.

    +
    +
  • +
  • +
    +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
    +
  • +
  • +
    +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
    +
  • +
  • +
    +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
    +
  • +
  • +
    +

    iTip: fix broken table cells

    +
    +
  • +
  • +
    +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
    +
  • +
  • +
    +

    Added Caldav scheduling section

    +
    +
  • +
+
+
+
V01: 2013-08-07 MD
+
+
    +
  • +
    +

    Removed method CONFIRM

    +
    +
  • +
  • +
    +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
    +
  • +
  • +
    +

    Added POLL-WINNER and verbiage

    +
    +
  • +
  • +
    +

    Added STATUS values

    +
    +
  • +
  • +
    +

    Added RELTYPE=POLL

    +
    +
  • +
  • +
    +

    Added supported-vpoll-component-sets

    +
    +
  • +
  • +
    +

    Added CalDAV related parameters to VOTER

    +
    +
  • +
  • +
    +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
    +
  • +
+
+
+
Initial version: 2012-11-02 MD
+
+
+
+
+
+
+
+
+

+Authors' Addresses +

+
+
Eric York
+ +
+
+
Cyrus Daboo
+ +
+
+
Michael Douglass
+ +
+
+
+ + + diff --git a/documents/draft-york-vpoll.rfc.xml b/documents/draft-york-vpoll.rfc.xml new file mode 100644 index 0000000..059498e --- /dev/null +++ b/documents/draft-york-vpoll.rfc.xml @@ -0,0 +1,3140 @@ + + + + + + + + + + VPOLL: Consensus Scheduling Component for iCalendar + + + +
+ + eyork@apple.com + +
+
+ +
+ + cyrus@daboo.name + +
+
+ +
+ + mikeadouglass@gmail.com + +
+
+ Internet + + +This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives. + +
+ +
+ Acknowledgements + The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support. +
+
+ Introduction + The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing. + Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities. + A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time. + Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice. + The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact. + These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process. +
+
+ Terms and definitions + For the purposes of this document, + the following terms and definitions apply. +
+consensus scheduling +The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task. +
+
+active Vpoll +A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period +
+
+voter +A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented. +
+
+
+ Simple Consensus Scheduling + This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees. + This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives. +
The VPOLL Component: An OverviewThe VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate: +
DTSTAMP
+The usual property. +
SEQUENCE
+The usual property. See below for SEQUENCE +behavior. +
UID
+The usual property. +
ORGANIZER
+The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same. +
SUMMARY
+The usual property. This optional but +recommended property provides the a short title to the poll. +
DESCRIPTION
+The usual property. This optional property +provides more details. +
DTEND
+The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active. +
POLL-MODE
+A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives. +
POLL-COMPLETION
+A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice. +
POLL-PROPERTIES
+A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process. +
PARTICIPANT
+There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on. +
VOTE
+A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration. +
VEVENT
+In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting. +
+EXAMPLEVPOLL with 3 voters and 3 alternative meetings:
+As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.
+
The VPOLL Alternative Choices: An OverviewWithin the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL. +
POLL-ITEM-ID
+This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer. +
+
VPOLL responsesUpon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components: +
DTSTAMP
+The usual property. +
SEQUENCE
+The usual property. See below for SEQUENCE +behavior. +
UID
+Same as the request. +
ORGANIZER
+Same as the request. +
SUMMARY
+Same as the request. +
PARTICIPANT
+One only with a CALENDAR-ADDRESS identifying the voter replying. +
VOTE
+One per item being voted on. +
POLL-ITEM-ID
+One inside each VOTE component to identify the choice. +
RESPONSE
+One inside each VOTE component to specify the vote. +
+Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3. +
NOTE
+This is poll-mode specific behavior? +
+EXAMPLEREPLY VPOLL from Cyrus:
+
VPOLL updatesWhen the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components. +EXAMPLE
+
VPOLL CompletionAfter a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED. +The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED". +EXAMPLEVPOLL confirmation:
+
Other ResponsesA voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care. +An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices. +This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.
+
+
+ iCalendar Extensions +
Updated Participant Type ValueParticipant type property values are defined in section 11.2.1. of +. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL. +
+
Updated Relation Type ValueRelationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component. +
+
Updated Status ValueStatus property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+These values allow clients and servers to handle the +choosing and submission of winning choices. +
+ +
+
+
New Property Parameters
Required
Parameter name
+REQUIRED +
Purpose
+To specify whether the associated property is required in +the current context. +
Format Definition
+This parameter is defined by the following notation: +
+
+ +
Description
+This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies. +
+
Stay-Informed
Parameter name
+STAY-INFORMED +
Purpose
+To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed. +
Format Definition
+This parameter is defined by the following notation: +
+
+ +
Description
+This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant. +
+
New Properties
Accept-Response
Property name
+ACCEPT-RESPONSE +
Purpose
+This property is used in VPOLL to indicate the types of +component that may be supplied in a response. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives. +If this property is not present voters are only allowed to respond +to the choices in the request. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Completion
Property name
+POLL-COMPLETION +
Purpose
+This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s). +
Description
When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action. +Server initiated submission requires that the submitted choice +MUST be a valid calendaring component. +POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.
Format Definition
+This property is defined by the following notation: +
+
+ +
Example
+The following is an example of this property: +
+
+
+
Poll-Item-Id
Property name
+POLL-ITEM-ID +
Purpose
+This property is used in VPOLL child components as an +identifier. +
Value type
+INTEGER +
Property Parameters
+Non-standard parameters can be specified on +this property. +
Conformance
+This property MUST be specified in a VOTE component and +in VPOLL choice items. +
Description
+In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on. +POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Mode
Property name
+POLL-MODE +
Purpose
+This property is used in VPOLL to indicate what voting mode +is to be applied. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component or +its sub-components. +
Description
+The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID. +Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-properties
Property name
+POLL-PROPERTIES +
Purpose
+This property is used in VPOLL to define which icalendar +properties are being voted on. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Winner
Property name
+POLL-WINNER +
Purpose
+This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won. +
Value type
+INTEGER +
Property Parameters
+Non-standard parameters can be specified on +this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Reply-URL
Property name
+REPLY-URL +
Purpose
+This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service. +
Property Parameters
+Non-standard, required or iana parameters can +be specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Response
Property name
+RESPONSE +
Purpose
+To specify a response vote. +
Value type
+INTEGER +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
+This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention: +
    +
  • +0 - 39 A "NO vote" +
  • +
  • +40 - 79 A "MAYBE" vote +
  • +
  • +80 - 89 A "YES - but not preferred vote" +
  • +
  • +90-100 A "YES" vote. +Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe). +
  • +
+
+
New Components
VPOLL Component
Component name
+VPOLL +
Purpose
+This component provides a mechanism by which voters can +vote on provided choices. +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components. +If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created. +If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration. +"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property. +If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.
+
VOTE Component
Component name
+VOTE +
Purpose
+This component provides a mechanism by which voters can +vote on provided choices. +
Conformance
+This component may be specified zero or more times in a PARTICIPANT component which identifies the voter. +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.The required and optional properties and their meanings will depend +upon the POLL-MODE in effect. +For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice. +If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.
+
+
+ Poll Modes + The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property. + New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC. +
POLL-MODE:BASICBASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected. +
Property restrictionsThis poll mode has the following property requirements: +
POLL-ITEM-ID
+Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll. +
POLL-WINNER
+On confirmation of the poll this property MUST be +present and identifies the winning component. +
+
Outcome reportingTo confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED. +When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.
+
+
+ iTIP Extensions + This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters. + For many of the iTip processing rules the voters take the place of +attendees. +
MethodsThere are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined. +
MethodDescription
+PUBLISH + +No changes (yet) +
+REQUEST + +Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on. +
+REPLY + +There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only. +
+ADD + +Not supported for VPOLL. +
+CANCEL + +There MUST be a single VPOLL component with UID +
+matching that of the poll being cancelled. +
+REFRESH + +The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found. +
+COUNTER + +Not supported for VPOLL. +
+DECLINECOUNTER + +Not supported for VPOLL. +
+POLLSTATUS + +Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS. +
+The following table shows the above methods broken down by who can +send them with VPOLL components. +
OriginatorMethods
+Organizer + +CANCEL, PUBLISH, REQUEST, POLLSTATUS +
+Voter + +REPLY, REFRESH, REQUEST (only when delegating) +
+
Interoperability ModelsMost of the standard iTip specification applies with respect to +organizer and voters. +
Delegation + +TBD +
+
Acting on Behalf of Other Calendar Users + +TBD +
+
Component Revisions + +
    +
  • +Need to talk about what a change in SEQUENCE means +
  • +
  • +Sequence change forces a revote. +
  • +
  • +New voter - no sequence change +
  • +
  • +Add another poll set or change poll item ids or any change to a child +
  • +
  • +component - bump sequence +
  • +
+
+
Message Sequencing + +TBD +
+
Application Protocol Elements
Methods for VPOLL Calendar ComponentsThis section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method. +The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object. +
Presence ValueDescription
+1 + +One instance MUST be present. +
+1+ + +At least one instance MUST be present. +
+0 + +Instances of this property MUST NOT be present. +
+0+ + +Multiple instances MAY be present. +
+0 or 1 + +Up to 1 instance of this property MAY be present. +
+The following summarizes the methods that are defined for the "VPOLL" +calendar component. +
MethodDescription
+PUBLISH + +Post notification of an poll. Used primarily as a +method of advertising the existence of a poll. +
+REQUEST + +To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach. +
+REPLY + +Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100. +
+CANCEL + +Cancel a poll. +
+REFRESH + +A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester. +
+POLLSTATUS + +Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT. +
+
Method: PUBLISHThe "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component. +
Note
+Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification. +
+This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:PUBLISH of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST equal PUBLISH. +
+VPOLL + +1+ +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 + +If present defines the start of the poll. Otherwise the poll starts when it is created and distributed. +
+ORGANIZER + +1 +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0 or 1 +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+LAST-MODIFIED + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 or 1 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of COMPLETED/CONFIRMED/CANCELLED. +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+PARTICIPANT + +0+ + +Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters +
+REQUEST-STATUS + +0 +
+VALARM + +0+ +
+VEVENT + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VFREEBUSY + +0 +
+VJOURNAL + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTODO + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+
Method: REQUESTThe "REQUEST" method in a "VPOLL" component provides the following +scheduling functions: +
    +
  • +Invite "Voters" to respond to the poll. +
  • +
  • +Change the items being voted upon. +
  • +
  • +Complete or confirm the poll. +
  • +
  • +Response to a "REFRESH" request. +
  • +
  • +Update the details of an existing vpoll. +
  • +
  • +Update the status of "Voters". +
  • +
  • +Forward a "VPOLL" to another uninvited CU. +
  • +
  • +For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU. +
  • +
  • +For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU. +
  • +
+The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer". +The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component. +For the "REQUEST" method only a single iCalendar object is permitted. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REQUEST of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REQUEST. +
+VPOLL + +1 +
+PARTICIPANT + +1+ + +Identified as voters with the PARTICIPANT-TYPE=VOTER +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 + +If present defines the start of the poll. Otherwise the poll starts when it is created and distributed. +
+ORGANIZER + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 or 1 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+REQUEST-STATUS + +0 +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of COMPLETED/CONFIRMED/CANCELLED. +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+VALARM + +0+ +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VEVENT + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VFREEBUSY + +0 +
+VJOURNAL + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTODO + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+
Rescheduling a poll + +The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll. +
+
Updating or Reconfirmation of a PollThe "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method +describes an update of the poll details, but not a rescheduling of +the POLL. +The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll. +The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.
+
Confirmation of a Poll + +The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component. +
+
Closing a Poll + +The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED. +
+
Delegating a Poll to Another CUSome calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU. +The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above. +In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY" +method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address. +The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".
+
Changing the Organizer + +The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer". +
+
Sending on Behalf of the Organizer + +There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer". +
+
Forwarding to an Uninvited CUA "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU. +The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll. +If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added. +When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.
+
Updating Voter Status + +The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST". +
+
Method: REPLYThe "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property. +The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed. +The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter". +A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value. +The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter. +The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY) +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REPLY of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REPLY. +
+VPOLL + +1+ + +All components MUST have the same +
+UID. +
+PARTICIPANT + +1 + +Identifies the Voter replying. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+UID + +1 + +MUST be the UID of the original +
+REQUEST. +
+SEQUENCE + +0 or 1 + +If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0. +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DTSTART + +0 or 1 +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +1+ + +One per item being voted on. +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+REQUEST-STATUS + +0+ +
+STATUS + +0 or 1 +
+SUMMARY + +0 or 1 +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+VALARM + +0 +
+VTIMEZONE + +0 or 1 + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VEVENT + +0 +
+VFREEBUSY + +0 or 1 + +A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy. +
+VAVAILABILITY + +0 + +A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available. +
+VJOURNAL + +0 +
+VTODO + +0 +
+
Method: CANCELThe "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll. +The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each. +When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in . +Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:CANCEL of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be CANCEL. +
+VPOLL + +1+ + +All must have the same UID. +
+PARTICIPANT + +0+ + +MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled. +
+UID + +1 + +MUST be the UID of the original REQUEST. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+SEQUENCE + +1 +
+ATTACH + +0+ +
+ACCEPT-RESPONSE + +0 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DTSTART + +0 or 1 +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included. +
+SUMMARY + +0 or 1 +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+REQUEST-STATUS + +0 +
+VALARM + +0 +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VTODO + +0 +
+VJOURNAL + +0 +
+VEVENT + +0 +
+VFREEBUSY + +0 +
+
Method: REFRESHThe "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REFRESH of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REFRESH. +
+VPOLL + +1 +
+PARTICIPANT + +1 + +MUST identify the requester as a voter. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+UID + +1 + +MUST be the UID associated with original REQUEST. +
+COMMENT + +0+ +
+COMPLETED + +0 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+ACCEPT-RESPONSE + +0 +
+ATTACH + +0 +
+CATEGORIES + +0 +
+CLASS + +0 +
+CONTACT + +0 +
+CREATED + +0 +
+DESCRIPTION + +0 +
+DTEND + +0 +
+DTSTART + +0 +
+DURATION + +0 +
+GEO + +0 +
+LAST-MODIFIED + +0 +
+LOCATION + +0 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 +
+RELATED-TO + +0 +
+REQUEST-STATUS + +0 +
+RESOURCES + +0 +
+SEQUENCE + +0 +
+STATUS + +0 +
+SUMMARY + +0 +
+URL + +0 +
+VALARM + +0 +
+VTIMEZONE + +0+ +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VTODO + +0 +
+VJOURNAL + +0 +
+VEVENT + +0 +
+VFREEBUSY + +0 +
+
Method: POLLSTATUSThe "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:POLLSTATUS of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST equal POLLSTATUS. +
+VPOLL + +1+ +
+PARTICIPANT + +1+ + +The voters containing their current vote +
+COMPLETED + +0 or 1 + +Only present for a completed poll +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 +
+ORGANIZER + +1 +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+ACCEPT-RESPONSE + +0 +
+ATTACH + +0 +
+CATEGORIES + +0 +
+CLASS + +0 +
+COMMENT + +0+ +
+CONTACT + +0 +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+LAST-MODIFIED + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of TENTATIVE/CONFIRMED/CANCELLED. +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+REQUEST-STATUS + +0 +
+VALARM + +0+ +
+VEVENT + +0 + +All candidate components SHOULD NOT be present. +
+VFREEBUSY + +0 +
+VJOURNAL + +0 + +All candidate components SHOULD NOT be present. +
+VTODO + +0 + +All candidate components SHOULD NOT be present. +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+
+
+ CalDAV Extensions + This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports. + Additionally, it extends as it a VPOLL component is a +schedulable entity. +
Calendar Collection PropertiesThis section defines new CalDAV properties for calendar collections. +
CALDAV:supported-vpoll-component-sets
Name
+supported-vpoll-component-sets +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.It also specifies the combination of allowed component types. +Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.
Definition
+
+ +]]>
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +]]>
+
+
CALDAV:vpoll-max-items
Name
+vpoll-max-items +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component. +
Definition
+
+PCDATA value: a numeric value (integer greater than zero)]]>
+ +
25]]>
+
+
CALDAV:vpoll-max-active
Name
+vpoll-max-active +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Provides a numeric value indicating the maximum number of +active vpolls at any one time. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs. +
Definition
+
+PCDATA value: a numeric value (integer greater than zero)]]>
+ +
25]]>
+
+
CALDAV:vpoll-max-voters
Name
+ +vpoll-max-voters + +
Namespace
+ +urn:ietf:params:xml:ns:caldav + +
Purpose
+Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component. +
Definition
+
+PCDATA value: a numeric value (integer greater than zero)]]>
+ +
25]]>
+
+
CalDAV:even-more-properties + +
+
Extensions to CalDAV schedulingThis specification extends . +Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL. +Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.
+
Additional Preconditions for PUT, COPY, and MOVEThis specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection. +The new preconditions are: +
(CALDAV:supported-vpoll-component-sets)
+The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection; +
(CALDAV:vpoll-max-items)
+The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored; +
(CALDAV:vpoll-max-active)
+The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored; +
(CALDAV:vpoll-max-voters)
+The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored; +
+
CalDAV:calendar-query ReportThis allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself. +
Example: Partial Retrieval of VPOLLIn this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION. +
> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + + + + + + + + + + + + + + + + + + + + + + + + + + + + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + + + + + http://cal.example.com/cyrus/work/poll2.ics + + + "fffff-abcd2" + BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR + + + HTTP/1.1 200 OK + + + + http://cal.example.com/cyrus/work/poll3.ics + + + "fffff-abcd3" + BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR + + + HTTP/1.1 200 OK + + +]]>
+
+
CalDAV time ranges"CALDAV:time-range XML Element" in describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL +A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified. +
DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+]]>
+
+
+
+ Security Considerations + Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs. +
+
+ IANA Considerations +
Parameter RegistrationsThis document defines the following new iCalendar property parameters +to be added to the registry defined in : +
Property ParameterStatusReference
+REQUIRED + +Current + + + + +
+STAY-INFORMED + +Current + + + + +
+
Property RegistrationsThis document defines the following new iCalendar properties to be +added to the registry defined in : +
PropertyStatusReference
+ACCEPT-RESPONSE + +Current + + + + +
+POLL-ITEM-ID + +Current + + + + +
+POLL-MODE + +Current + + + + +
+POLL-PROPERTIES + +Current + + + + +
+POLL-WINNER + +Current + + + + +
+RESPONSE + +Current + + + + +
+
POLL-MODE Registration TemplateA poll mode is defined by completing the following template. +
Poll mode name
+The name of the poll mode. +
Purpose
+The purpose of the poll mode. Give a short but clear +description. +
Reference
+A reference to the RFC in which the poll mode is defined +
+
POLL-MODE RegistrationsThis document defines the following registered poll modes. +
Poll mode namePurposeReference
+BASIC + +To provide simple voting for a single outcome from a number of candidates. + +Current +
+
+
+ + + Normative references + + + HTTP Extensions for Distributed Authoring — WEBDAV + + + + + + + + This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] + + + + + IETF RFC 2518 + + + + + + Uniform Resource Identifier (URI): Generic Syntax + + + + + + A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] + + + + + IETF RFC 3986 + + + + + + Calendaring Extensions to WebDAV (CalDAV) + + + + + + This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the "calendar-access" feature of CalDAV. [STANDARDS-TRACK] + + + + + IETF RFC 4791 + + + + + + Internet Calendaring and Scheduling Core Object Specification (iCalendar) + + + + This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] + + + + + IETF RFC 5545 + + + + + + iCalendar Transport-Independent Interoperability Protocol (iTIP) + + + + This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] + + + + + IETF RFC 5546 + + + + + + iCalendar Message-Based Interoperability Protocol (iMIP) + + + + This document, "iCalendar Message-Based Interoperability Protocol (iMIP)", specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] + + + + + IETF RFC 6047 + + + + + + Scheduling Extensions to CalDAV + + + + + This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) "calendar-access" feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the "calendar-auto-schedule" feature of CalDAV. [STANDARDS-TRACK] + + + + + IETF RFC 6638 + + + + + + Event Publishing Extensions to iCalendar + + + + This specification updates RFC5545 by introducing a number of new iCalendar properties and components which are of particular use for event publishers and in social networking. This specification also defines a new STRUCTURED-DATA property for iCalendar RFC5545 to allow for data that is directly pertinent to an event or task to be included with the calendar data. + + + + + + IETF I-D.ietf-calext-eventpub-extensions + + + + + Bibliography + +
+ Open issues + public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property + Notifications: Need to do a section on what Notifications to + support. + A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user? + Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote + Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status + ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration + Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event. + Need to write down what isn't valid in a VPOLL + a. Can't change POLL-MODE + Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc + ? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER + Need to add example of freebusy in response +
+ +
+
+
+ Change log +
+
Calext V01: 2019-10-17 MD
+
+Replace VVOTER and VOTER with PARTICIPANT. +
+
Calext V00: 2019-05-17 MD
+
+First calext version. Moved source to metanorma. No changes to specification. +
+
V03: 2014-10-28 MD
+
+
    +
  • +Add VVOTER and VOTE components. +
  • +
  • +Add RESPONSE property. +
  • +
  • +Remove RESPONSE parameter from VOTER. +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +Add reply-url property and required parameter. +
  • +
  • +Fix ACCEPT-RESPONSE definition. +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +Typos fixed, clarifications made. +
  • +
  • +Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT +
  • +
  • +Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values. +
  • +
  • +iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent +
  • +
  • +iTip: fix broken table cells +
  • +
  • +Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table +
  • +
  • +Added Caldav scheduling section +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +Removed method CONFIRM +
  • +
  • +Removed pollitemid from VPOLL abnf. Added text for pollwinner +
  • +
  • +Added POLL-WINNER and verbiage +
  • +
  • +Added STATUS values +
  • +
  • +Added RELTYPE=POLL +
  • +
  • +Added supported-vpoll-component-sets +
  • +
  • +Added CalDAV related parameters to VOTER +
  • +
  • +Removed bad CalDAV query example. State that queries cannot +target the sub-components. +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
+
+
diff --git a/documents/draft-york-vpoll.rxl b/documents/draft-york-vpoll.rxl new file mode 100644 index 0000000..5db2c9a --- /dev/null +++ b/documents/draft-york-vpoll.rxl @@ -0,0 +1,73 @@ + +VPOLL: Consensus Scheduling Component for iCalendar +VPOLL +https://www.apple.com +draft-york-vpoll-05 +draft-york-vpoll-05 + + + + +Eric York + +eyork@apple.com + + + + + + +Cyrus Daboo + +cyrus@daboo.name + + + + + + +Michael Douglass + +mikeadouglass@gmail.com + + + + + +Internet Engineering Task Force +IETF + + + +2019-05-15 + +en + + +standard + + +2020 + + +Internet Engineering Task Force +IETF + + + + +IETF + + +standard + + +internet-draft +Internet +trust200902 +true + +yes + + + \ No newline at end of file diff --git a/documents/draft-york-vpoll.txt b/documents/draft-york-vpoll.txt new file mode 100644 index 0000000..3339cc0 --- /dev/null +++ b/documents/draft-york-vpoll.txt @@ -0,0 +1,3472 @@ + + + + +Network Working Group E. York +Internet-Draft +Intended status: Standards Track C. Daboo +Expires: 31 January 2021 + M. Douglass + 30 July 2020 + + + VPOLL: Consensus Scheduling Component for iCalendar + draft-york-vpoll-05 + +Abstract + + This specification introduces a new iCalendar component which allows + for consensus scheduling, that is, voting on a number of alternative + meeting or task alternatives. + +Status of This Memo + + This Internet-Draft is submitted in full conformance with the + provisions of BCP 78 and BCP 79. + + Internet-Drafts are working documents of the Internet Engineering + Task Force (IETF). Note that other groups may also distribute + working documents as Internet-Drafts. The list of current Internet- + Drafts is at https://datatracker.ietf.org/drafts/current/. + + Internet-Drafts are draft documents valid for a maximum of six months + and may be updated, replaced, or obsoleted by other documents at any + time. It is inappropriate to use Internet-Drafts as reference + material or to cite them other than as "work in progress." + + This Internet-Draft will expire on 31 January 2021. + +Copyright Notice + + Copyright (c) 2020 IETF Trust and the persons identified as the + document authors. All rights reserved. + + This document is subject to BCP 78 and the IETF Trust's Legal + Provisions Relating to IETF Documents (https://trustee.ietf.org/ + license-info) in effect on the date of publication of this document. + Please review these documents carefully, as they describe your rights + and restrictions with respect to this document. Code Components + extracted from this document must include Simplified BSD License text + as described in Section 4.e of the Trust Legal Provisions and are + provided without warranty as described in the Simplified BSD License. + + + + +York, et al. Expires 31 January 2021 [Page 1] + +Internet-Draft VPOLL July 2020 + + +Table of Contents + + 1. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 3 + 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 + 3. Terms and definitions . . . . . . . . . . . . . . . . . . . . 4 + 3.1. consensus scheduling . . . . . . . . . . . . . . . . . . 4 + 3.2. active Vpoll . . . . . . . . . . . . . . . . . . . . . . 4 + 3.3. voter . . . . . . . . . . . . . . . . . . . . . . . . . . 4 + 4. Simple Consensus Scheduling . . . . . . . . . . . . . . . . . 5 + 4.1. The VPOLL Component: An Overview . . . . . . . . . . . . 5 + 4.2. The VPOLL Alternative Choices: An Overview . . . . . . . 7 + 4.3. VPOLL responses . . . . . . . . . . . . . . . . . . . . . 8 + 4.4. VPOLL updates . . . . . . . . . . . . . . . . . . . . . . 9 + 4.5. VPOLL Completion . . . . . . . . . . . . . . . . . . . . 11 + 4.6. Other Responses . . . . . . . . . . . . . . . . . . . . . 12 + 5. iCalendar Extensions . . . . . . . . . . . . . . . . . . . . 12 + 5.1. Updated Participant Type Value . . . . . . . . . . . . . 12 + 5.2. Updated Relation Type Value . . . . . . . . . . . . . . . 12 + 5.3. Updated Status Value . . . . . . . . . . . . . . . . . . 13 + 5.4. New Property Parameters . . . . . . . . . . . . . . . . . 13 + 5.4.1. Required . . . . . . . . . . . . . . . . . . . . . . 13 + 5.4.2. Stay-Informed . . . . . . . . . . . . . . . . . . . . 14 + 5.5. New Properties . . . . . . . . . . . . . . . . . . . . . 14 + 5.5.1. Accept-Response . . . . . . . . . . . . . . . . . . . 14 + 5.5.2. Poll-Completion . . . . . . . . . . . . . . . . . . . 15 + 5.5.3. Poll-Item-Id . . . . . . . . . . . . . . . . . . . . 16 + 5.5.4. Poll-Mode . . . . . . . . . . . . . . . . . . . . . . 17 + 5.5.5. Poll-properties . . . . . . . . . . . . . . . . . . . 17 + 5.5.6. Poll-Winner . . . . . . . . . . . . . . . . . . . . . 18 + 5.5.7. Reply-URL . . . . . . . . . . . . . . . . . . . . . . 19 + 5.5.8. Response . . . . . . . . . . . . . . . . . . . . . . 19 + 5.6. New Components . . . . . . . . . . . . . . . . . . . . . 20 + 5.6.1. VPOLL Component . . . . . . . . . . . . . . . . . . . 20 + 5.6.2. VOTE Component . . . . . . . . . . . . . . . . . . . 22 + 6. Poll Modes . . . . . . . . . . . . . . . . . . . . . . . . . 23 + 6.1. POLL-MODE:BASIC . . . . . . . . . . . . . . . . . . . . . 24 + 6.1.1. Property restrictions . . . . . . . . . . . . . . . . 24 + 6.1.2. Outcome reporting . . . . . . . . . . . . . . . . . . 24 + 7. iTIP Extensions . . . . . . . . . . . . . . . . . . . . . . . 24 + 7.1. Methods . . . . . . . . . . . . . . . . . . . . . . . . . 24 + 7.2. Interoperability Models . . . . . . . . . . . . . . . . . 26 + 7.2.1. Delegation . . . . . . . . . . . . . . . . . . . . . 26 + 7.2.2. Acting on Behalf of Other Calendar Users . . . . . . 26 + 7.2.3. Component Revisions . . . . . . . . . . . . . . . . . 26 + 7.2.4. Message Sequencing . . . . . . . . . . . . . . . . . 26 + 7.3. Application Protocol Elements . . . . . . . . . . . . . . 26 + 7.3.1. Methods for VPOLL Calendar Components . . . . . . . . 26 + 7.3.2. Method: PUBLISH . . . . . . . . . . . . . . . . . . . 28 + + + +York, et al. Expires 31 January 2021 [Page 2] + +Internet-Draft VPOLL July 2020 + + + 7.3.3. Method: REQUEST . . . . . . . . . . . . . . . . . . . 31 + 7.3.4. Method: REPLY . . . . . . . . . . . . . . . . . . . . 37 + 7.3.5. Method: CANCEL . . . . . . . . . . . . . . . . . . . 40 + 7.3.6. Method: REFRESH . . . . . . . . . . . . . . . . . . . 43 + 7.3.7. Method: POLLSTATUS . . . . . . . . . . . . . . . . . 45 + 8. CalDAV Extensions . . . . . . . . . . . . . . . . . . . . . . 47 + 8.1. Calendar Collection Properties . . . . . . . . . . . . . 47 + 8.1.1. CALDAV:supported-vpoll-component-sets . . . . . . . . 47 + 8.1.2. CALDAV:vpoll-max-items . . . . . . . . . . . . . . . 49 + 8.1.3. CALDAV:vpoll-max-active . . . . . . . . . . . . . . . 50 + 8.1.4. CALDAV:vpoll-max-voters . . . . . . . . . . . . . . . 51 + 8.1.5. CalDAV:even-more-properties . . . . . . . . . . . . . 51 + 8.1.6. Extensions to CalDAV scheduling . . . . . . . . . . . 51 + 8.2. Additional Preconditions for PUT, COPY, and MOVE . . . . 52 + 8.3. CalDAV:calendar-query Report . . . . . . . . . . . . . . 52 + 8.3.1. Example: Partial Retrieval of VPOLL . . . . . . . . . 53 + 8.4. CalDAV time ranges . . . . . . . . . . . . . . . . . . . 55 + 9. Security Considerations . . . . . . . . . . . . . . . . . . . 56 + 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 56 + 10.1. Parameter Registrations . . . . . . . . . . . . . . . . 57 + 10.2. Property Registrations . . . . . . . . . . . . . . . . . 57 + 10.3. POLL-MODE Registration Template . . . . . . . . . . . . 57 + 10.4. POLL-MODE Registrations . . . . . . . . . . . . . . . . 58 + 11. Normative references . . . . . . . . . . . . . . . . . . . . 58 + 12. Bibliography . . . . . . . . . . . . . . . . . . . . . . . . 59 + Appendix A. Open issues . . . . . . . . . . . . . . . . . . . . 59 + Appendix B. Change log . . . . . . . . . . . . . . . . . . . . . 60 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 61 + +1. Acknowledgements + + The authors would like to thank the members of the Calendaring and + Scheduling Consortium (CalConnect) for contributing their ideas and + support. + +2. Introduction + + The currently existing approach to agreeing on meeting times using + iTip [RFC5546] and/or iMip [RFC6047] has some significant failings. + There is no useful bargaining or suggestion mechanism in iTip, only + the ability for a potential attendee to accept or refuse or to + counter with a time of their own choosing. + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 3] + +Internet-Draft VPOLL July 2020 + + + Part of the problem is that for many potential attendees, their + freebusy is not an accurate representation of their availability. In + fact, when trying to schedule conference calls across different + organizations, attendees may not be allowed to provide freebusy + information or availability as this may reveal something of the + organizations internal activities. + + A number of studies have shown that large amounts of time are spent + trying to come to an agreement - up to and beyond 20 working hours + per meeting. Many organizers fall back on other approaches such as + phone calls and email to determine a suitable time. + + Online services have appeared as a result and these allow + participants to vote on a number of alternatives without revealing or + using freebusy or availability. When agreement is reached a + conventional scheduling message may be sent to the attendees. This + approach appears to reach consensus fairly rapidly. Peer pressure + may have some bearing on this as all voters are usually able to see + the current state of the voting and may adjust their own meeting + schedules to make themselves available for a popular choice. + + The component and properties defined in this specification provide a + standardized structure for this process and allow calendar clients + and servers and web based services to interact. + + These structures also have uses beyond the relatively simple needs of + most meeting organizers. The process of coming to consensus can also + be viewed as a bidding process. + +3. Terms and definitions + + For the purposes of this document, the following terms and + definitions apply. + +3.1. consensus scheduling + + The process whereby users come to some agreement on meeting or task + alternatives and then book that meeting or task. + +3.2. active Vpoll + + A VPoll may have a DTSTART, DTEND and DURATION which may define the + start and end of the active voting period + +3.3. voter + + A participant who votes on the alternatives. A voter need not be an + attendee of any of the alternatives presented. + + + +York, et al. Expires 31 January 2021 [Page 4] + +Internet-Draft VPOLL July 2020 + + +4. Simple Consensus Scheduling + + This specification defines components and properties which can be + used for simple consensus scheduling but also have the generality to + handle more complex cases. To provide an easy (and for many - + sufficient) introduction to consensus scheduling and VPOLL we will + outline the flow of information for the simple case of voting on a + number of meeting alternatives which differ only in time. In + addition the voters will all be potential attendees. + + This specification not only defines data structures but adds a new + iTip method used when consensus has been reached. This document will + show how a VPOLL object is used to inform voters of the state of a + simple vote on some alternatives. + +4.1. The VPOLL Component: An Overview + + The VPOLL component acts as a wrapper for a number of alternatives to + be voted on, together with some properties and a new component used + to maintain the state of the voting. For our simple example the + following VPOLL properties and sub-components are either required or + appropriate: + + DTSTAMP The usual [RFC5545] property. + + SEQUENCE The usual [RFC5545] property. See below for SEQUENCE + behavior. + + UID The usual [RFC5545] property. + + ORGANIZER The usual [RFC5545] property. In general this need not be + an organizer of any of the alternatives. In this simple outline + we assume it is the same. + + SUMMARY The usual [RFC5545] property. This optional but recommended + property provides the a short title to the poll. + + DESCRIPTION The usual [RFC5545] property. This optional property + provides more details. + + DTEND The usual [RFC5545] property. This optional property provides + a poll closing time and date after which the VPOLL is no longer + active. + + POLL-MODE A new property which defines how the votes are used to + obtain a result. For our use case it will take the value "BASIC" + meaning one event will be chosen from the alternatives. + + + + +York, et al. Expires 31 January 2021 [Page 5] + +Internet-Draft VPOLL July 2020 + + + POLL-COMPLETION A new property which defines who (server or client) + chooses and/or submits the winning choice. In our example the + value is "SERVER-SUBMIT" which means the client chooses the winner + but the server will submit the winning choice. + + POLL-PROPERTIES A new property which defines which icalendar + properties are being voted on. For our use case it will take the + value "DTSTART, LOCATION" meaning only those properties are + significant for voting. Other properties in the events may differ + but are not considered significant for the voting process. + + PARTICIPANT There is one of these components for each voter with the + PARTICIPANT-TYPE set to "VOTER". The CALENDAR-ADDRESS property + identifies the voter and this component will contain one VOTE + component for each item being voted on. + + VOTE A new component. There is one of these for each voter and + choice. It usually contains at least a POLL-ITEM-ID property to + identify the choice and a RESPONSE property to provide a vote. + For more complex poll modes it may contain other information such + as cost or estimated duration. + + VEVENT In our simple use case there will be multiple VEVENT sub- + components defining the alternatives. Each will have a different + date and or time for the meeting. + + EXAMPLE + + VPOLL with 3 voters and 3 alternative meetings: + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 6] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD:REQUEST + BEGIN:VPOLL + POLL-MODE:BASIC + POLL-COMPLETION:SERVER-SUBMIT + POLL-PROPERTIES:DTSTART,LOCATION + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T000000Z + SUMMARY:What to do this week + DTEND:20120101T000000Z + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + END PARTICIPANT + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + END PARTICIPANT + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:mike@example.com + END PARTICIPANT + BEGIN:VEVENT.......(with a poll-item-id=1) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=2) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=3) + END:VEVENT + END:VPOLL + END:VCALENDAR + + Figure 1 + + As can be seen in the example above, there is an iTip METHOD property + with the value REQUEST. The VPOLL object will be distributed to all + the voters, either through iMip or through some VPOLL enabled + service. + +4.2. The VPOLL Alternative Choices: An Overview + + Within the VPOLL component we have the alternatives to vote on. In + many respects these are standard [RFC5545] components. For our + simple use case they are all VEVENT components. In addition to the + usual [RFC5545] properties some extra properties are used for a + VPOLL. + + + +York, et al. Expires 31 January 2021 [Page 7] + +Internet-Draft VPOLL July 2020 + + + POLL-ITEM-ID This provides a unique reference to the sub-component + within the VPOLL. It's value SHOULD be a small integer. + +4.3. VPOLL responses + + Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL + component containing their vote. In our simple case it will have the + following properties and components: + + DTSTAMP The usual [RFC5545] property. + + SEQUENCE The usual [RFC5545] property. See below for SEQUENCE + behavior. + + UID Same as the request. + + ORGANIZER Same as the request. + + SUMMARY Same as the request. + + PARTICIPANT One only with a CALENDAR-ADDRESS identifying the voter + replying. + + VOTE One per item being voted on. + + POLL-ITEM-ID One inside each VOTE component to identify the choice. + + RESPONSE One inside each VOTE component to specify the vote. + + Note that a voter can send a number of REPLYs for each REQUEST sent + by the organizer. Each REPLY completely replaces the voting record + for that voter for all components being voted on. In our example, if + Eric responds and votes for items 1 and 2 and then responds again + with a vote for only item 3, the final outcome is one vote on item 3. + + NOTE This is poll-mode specific behavior? + + EXAMPLE + + REPLY VPOLL from Cyrus: + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 8] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: REPLY + BEGIN:VPOLL + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T010000Z + SUMMARY:What to do this week + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + BEGIN:VOTE + POLL-ITEM-ID:1 + RESPONSE:50 + COMMENT:Work on iTIP + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + COMMENT:Work on WebDAV + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 2 + +4.4. VPOLL updates + + When the organizer receives a response from one or more voters the + current state of the poll is sent to all voters. The new iTip method + POLLSTATUS is used. The VPOLL can contain a reduced set of + properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, + ORGANIZER and one or more PARTICIPANT components each populated with + zero or more VOTE components. + + EXAMPLE + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 9] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: POLLSTATUS + BEGIN:VPOLL + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T020000Z + SEQUENCE:0 + SUMMARY:What to do this week + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + BEGIN: VOTE + POLL-ITEM-ID:1 + RESPONSE:50 + COMMENT:Work on iTIP + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + COMMENT:Work on WebDAV + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + BEGIN:VOTE + POLL-ITEM-ID:1 + RESPONSE:100 + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 3 + + + +York, et al. Expires 31 January 2021 [Page 10] + +Internet-Draft VPOLL July 2020 + + +4.5. VPOLL Completion + + After a number of REPLY messages have been received the poll will be + considered complete. If there is a DTEND on the poll the system may + automatically close the poll, or the organizer may, at any time, + consider the poll complete. A VPOLL can be completed (and + effectively closed for voting) by sending an iTip REQUEST message + with the VPOLL STATUS property set to COMPLETED. + + The poll winner is confirmed by sending a final iTip REQUEST message + with the VPOLL STATUS property set to CONFIRMED. In this case the + VPOLL component contains all the events being voted on along with a + POLL-WINNER property to identify the winning event. As the POLL- + COMPLETION property is set to SERVER-SUBMIT the server will submit + the winning choice and when it has done so set the STATUS to + "SUBMITTED". + + EXAMPLE + + VPOLL confirmation: + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: REQUEST + BEGIN:VPOLL + ORGANIZER:mailto:douglm@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T030000Z + COMPLETED:20120101T030000Z + POLL-COMPLETION:SERVER-SUBMIT + SEQUENCE:0 + SUMMARY:What to do this week + STATUS:CONFIRMED + POLL-WINNER:3 + BEGIN:VEVENT.......(with a poll-item-id=1) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=2) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=3) + END:VEVENT + END:VPOLL + END:VCALENDAR + + Figure 4 + + + + + + +York, et al. Expires 31 January 2021 [Page 11] + +Internet-Draft VPOLL July 2020 + + +4.6. Other Responses + + A voter being asked to choose between a number of ORGANIZER supplied + alternatives may find none of them acceptable or may simply not care. + + An alternative response, which may be disallowed by the ORGANIZER, is + to send back the respondees availability or freebusy or even one or + more new, alternative choices. + + This is accomplished by responding with a VOTE component which has no + POLL-ITEM-ID property. In this case it MUST contain some alternative + information. What form this takes depends on the poll mode in + effect. + +5. iCalendar Extensions + +5.1. Updated Participant Type Value + + Participant type property values are defined in section 11.2.1. of + [I-D.ietf-calext-eventpub-extensions]. This specification updates + that type to include the new participant type VOTER to provide + information about the voter and to contain their votes. + + Format Definition This property parameter is redefined by the + following notation: + + partvalue /= "VOTER" + + Figure 5 + + Description The new property value indicates that the associated + PARTICIPANT component identifies a voter in a VPOLL. + +5.2. Updated Relation Type Value + + Relationship parameter type values are defined in section 3.2.15. of + [RFC5545]. This specification updates that type to include the new + relationship value POLL to provide a link to the VPOLL component in + which the current component appears. + + Format Definition This property parameter is redefined by the + following notation: + + reltypeparam /= "RELTYPE" "=" "POLL" + ; Property value is a VPOLL uid + + Figure 6 + + + + +York, et al. Expires 31 January 2021 [Page 12] + +Internet-Draft VPOLL July 2020 + + + Description This parameter can be specified on a property that + references another related calendar component. The new parameter + value indicates that the associated property references a VPOLL + component which contains the current component. + +5.3. Updated Status Value + + Status property values are defined in section 3.8.1.11. of [RFC5545]. + This specification updates that type to define valid VPOLL status + values. + + Format Definition This property parameter is redefined by the + following notation: + + statvalue /= statvalue-poll + ; Status values for "VPOLL". + statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + + Figure 7 + + Description These values allow clients and servers to handle the + choosing and submission of winning choices. + + If the client is choosing and the server submitting then the + client should set the POLL-WINNER property, set the status to + CONFIRMED and save the poll. When the server submits the winning + choice it will set the status to SUBMITTED. + + Figure 8 + +5.4. New Property Parameters + +5.4.1. Required + + Parameter name REQUIRED + + Purpose To specify whether the associated property is required in + the current context. + + Format Definition This parameter is defined by the following + notation: + + + +York, et al. Expires 31 January 2021 [Page 13] + +Internet-Draft VPOLL July 2020 + + + requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + + Figure 9 + + Description This parameter MAY be specified on REPLY-URL and, if the + value is TRUE, indicates the organizer requires all replies to be + made via the specified service rather than iTip replies. + +5.4.2. Stay-Informed + + Parameter name STAY-INFORMED + + Purpose To specify the voter also wants to be added as an ATTENDEE + when the poll is confirmed. + + Format Definition This parameter is defined by the following + notation: + + stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + + Figure 10 + + Description This parameter MAY be specified on the CALENDAR-ADDRESS + property in the PARTICIPANT component and, if the value is TRUE, + indicates the voter wishes to be added to the final choice as a + non participant. + +5.5. New Properties + +5.5.1. Accept-Response + + Property name ACCEPT-RESPONSE + + Purpose This property is used in VPOLL to indicate the types of + component that may be supplied in a response. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description When used in a VPOLL this property indicates what + allowable component types may be returned in a reply. Typically + this would allow a voter to respond with their freebusy or + availability rather than choosing one of the presented + alternatives. + + + +York, et al. Expires 31 January 2021 [Page 14] + +Internet-Draft VPOLL July 2020 + + + If this property is not present voters are only allowed to respond + to the choices in the request. + + Format Definition This property is defined by the following + notation: + + acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + + acceptresponseparams = *(";" other-param) + + Figure 11 + +5.5.2. Poll-Completion + + Property name POLL-COMPLETION + + Purpose This property is used in VPOLL to indicate whether the + client or server is responsible for choosing and/or submitting the + winner(s). + + Description When a VPOLL is stored on a server which is capable of + handling choosing and submission of winning choices a value of + SERVER indicates that the server should close the poll, choose the + winner and submit whenever it is appropriate to do so. + + For example, in BASIC poll-mode, reaching the DTEND of the poll + could trigger this server side action. + + Server initiated submission requires that the submitted choice + MUST be a valid calendaring component. + + POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- + winner, set the status to CONFIRMED and then store the poll on the + server. The server will then submit the winning choice and set + the status to SUBMITTED. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 15] + +Internet-Draft VPOLL July 2020 + + + poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + + pcparam = *(";" other-param) + + pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + + Figure 12 + + Example The following is an example of this property: + + POLL-COMPLETION: SERVER-SUBMIT + + Figure 13 + +5.5.3. Poll-Item-Id + + Property name POLL-ITEM-ID + + Purpose This property is used in VPOLL child components as an + identifier. + + Value type INTEGER + + Property Parameters Non-standard parameters can be specified on this + property. + + Conformance This property MUST be specified in a VOTE component and + in VPOLL choice items. + + Description In a METHOD:REQUEST each choice component MUST have a + POLL-ITEM-ID property. Each set of components with the same POLL- + ITEM-ID value represents one overall set of items to be voted on. + + POLL-ITEM-ID SHOULD be a unique small integer for each component + or set of components. If it remains the same between REQUESTs + then the previous response for that component MAY be re-used. To + force a re-vote on a component due to a significant change, the + POLL-ITEM-ID MUST change. + + + +York, et al. Expires 31 January 2021 [Page 16] + +Internet-Draft VPOLL July 2020 + + + Format Definition This property is defined by the following + notation: + + pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + + pollitemidparams = *( + (";" other-param) + ) + + Figure 14 + +5.5.4. Poll-Mode + + Property name POLL-MODE + + Purpose This property is used in VPOLL to indicate what voting mode + is to be applied. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component or + its sub-components. + + Description The poll mode defines how the votes are applied to + obtain a result. BASIC mode, the default, means that the voters + are selecting one component (or group of components) with a given + POLL=ITEM-ID. + + Other polling modes may be defined in updates to this + specification. These may allow for such modes as ranking or task + assignment. + + Format Definition This property is defined by the following + notation: + + pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + + pollmodeparams = *(";" other-param) + + Figure 15 + +5.5.5. Poll-properties + + Property name POLL-PROPERTIES + + + + +York, et al. Expires 31 January 2021 [Page 17] + +Internet-Draft VPOLL July 2020 + + + Purpose This property is used in VPOLL to define which icalendar + properties are being voted on. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description This property defines which icalendar properties are + significant in the voting process. It may not be clear to voters + which properties are varying in a significant manner. Clients may + use this property to highlight those listed properties. + + Format Definition This property is defined by the following + notation: + + pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + + pollpropparams = *(";" other-param) + + Figure 16 + +5.5.6. Poll-Winner + + Property name POLL-WINNER + + Purpose This property is used in a basic mode VPOLL to indicate + which of the VPOLL sub-components won. + + Value type INTEGER + + Property Parameters Non-standard parameters can be specified on this + property. + + Conformance This property MAY be specified in a VPOLL component. + + Description For poll confirmation each child component MUST have a + POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD + have a POLL-WINNER property which MUST correspond to one of the + POLL-ITEM-ID properties and indicates which sub-component was the + winner. + + Format Definition This property is defined by the following + notation: + + + + + + +York, et al. Expires 31 January 2021 [Page 18] + +Internet-Draft VPOLL July 2020 + + + pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + + pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed + + Figure 17 + +5.5.7. Reply-URL + + Property name REPLY-URL + + Purpose This property may be used in scheduling messages to indicate + additional reply methods, for example a web-service. + + Property Parameters Non-standard, required or iana parameters can be + specified on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description When used in a scheduling message this property + indicates additional or required services that can be used to + reply. Typically this would be a web service of some form. + + Format Definition This property is defined by the following + notation: + + reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + + reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) + + Figure 18 + +5.5.8. Response + + Property name RESPONSE + + Purpose To specify a response vote. + + Value type INTEGER + + Format Definition This property is defined by the following + notation: + + + +York, et al. Expires 31 January 2021 [Page 19] + +Internet-Draft VPOLL July 2020 + + + response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + + responseparams = *(";" other-param) + + Figure 19 + + Description This parameter can be specified on the POLL-ITEM-ID + property to provide the value of the voters response. This + parameter allows for fine grained responses which are appropriate + to some applications. For the case of individuals voting for a + choice of events, client applications SHOULD conform to the + following convention: + + * 0 - 39 A "NO vote" + + * 40 - 79 A "MAYBE" vote + + * 80 - 89 A "YES - but not preferred vote" + + * 90-100 A "YES" vote. + + Clients MUST preserve the response value when there is no + change from the user even if they have a UI with fixed states + (e.g. yes/no/maybe). + +5.6. New Components + +5.6.1. VPOLL Component + + Component name VPOLL + + Purpose This component provides a mechanism by which voters can vote + on provided choices. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 20] + +Internet-Draft VPOLL July 2020 + + + pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + + pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + + Figure 20 + + Description This component provides a mechanism by which voters can + + + +York, et al. Expires 31 January 2021 [Page 21] + +Internet-Draft VPOLL July 2020 + + + vote on provided choices. The outcome depends upon the POLL-MODE + in effect. + + The PARTICIPANT components in VPOLL requests provide information + on each recipient who will be voting - both their identity through + the CALENDAR-ADDRESS property and their votes through the VOTE + components. + + If specified, the "DTSTART" property defines the start or opening + of the poll active period. If absent the poll is presumed to have + started when created. + + If "DTSTART" is present "DURATION" MAY be specified and indicates + the duration, and hence the ending, of the poll. The value of the + property MUST be a positive duration. + + "DTEND" MAY be specified with or without "DTSTART" and indicates + the ending of the poll. If DTEND is specified it MUST be later + than the DTSTART or CREATED property. + + If one or more VALARM components are included in the VPOLL they + are not components to be voted on and MUST NOT contain a POLL- + ITEM-ID property. VALARM sub-components may be used to provide + warnings to the user when polls are due to start or end. + +5.6.2. VOTE Component + + Component name VOTE + + Purpose This component provides a mechanism by which voters can vote + on provided choices. + + Conformance This component may be specified zero or more times in a + PARTICIPANT component which identifies the voter. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 22] + +Internet-Draft VPOLL July 2020 + + + votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + + voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + + Figure 21 + + Description This component appears inside the PARTICIPANT component + with a PARTICIPANT-TYPE of VOTER to identify the voter. This + component contains that participants responses. + + The required and optional properties and their meanings will + depend upon the POLL-MODE in effect. + + For any POLL-MODE, POLL-ITEM-ID is used to associate the + information to a choice supplied by the organizer. This means + that each VOTE component only provides information about that + choice. + + If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- + ID may be provided in a REPLY to indicate a possible new choice or + to provide information to the ORGANIZER - such as the respondees + availability. + +6. Poll Modes + + The VPOLL component is intended to allow for various forms of + polling. The particular form in efffect is indicated by the POLL- + MODE property. + + New poll modes can be registered by including a completed POLL-MODE + Registration Template (see Section 10.3) in a published RFC. + + + + +York, et al. Expires 31 January 2021 [Page 23] + +Internet-Draft VPOLL July 2020 + + +6.1. POLL-MODE:BASIC + + BASIC poll mode is the form of voting in which one possible outcome + is chosen from a set of possibilities. Usually this will be + represented as a number of possible event objects one of which will + be selected. + +6.1.1. Property restrictions + + This poll mode has the following property requirements: + + POLL-ITEM-ID Each contained sub-component that is being voted upon + MUST contain a POLL-ITEM_ID property which is unique within the + context of the POLL. The value MUST NOT be reused when events are + removed and/or added to the poll. + + POLL-WINNER On confirmation of the poll this property MUST be + present and identifies the winning component. + +6.1.2. Outcome reporting + + To confirm the winner the POLL-WINNER property MUST be present and + the STATUS MUST be set to CONFIRMED. + + When the winning VEVENT or VTODO is not a scheduled entity, that is, + it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER + property and a list of non-participating ATTENDEEs. This allows the + winning entity to be distributed to the participants through iTip or + some other protocol. + +7. iTIP Extensions + + This specification introduces a number of extensions to [RFC5546]. + In group scheduling the parties involved are organizer and attendees. + In VPOLL the parties are organizer and voters. + + For many of the iTip processing rules the voters take the place of + attendees. + +7.1. Methods + + There are some extensions to the behavior of iTip methods for a VPOLL + object and two new methods are defined. + + + + + + + + +York, et al. Expires 31 January 2021 [Page 24] + +Internet-Draft VPOLL July 2020 + + + +----------------+------------------------------------------------+ + | Method | Description | + +================+================================================+ + | PUBLISH | No changes (yet) | + +----------------+------------------------------------------------+ + | REQUEST | Each child component MUST have a POLL-ITEM-ID | + | | property. Each set of components with the | + | | same POLL-ITEM-ID value represents one overall | + | | set of items to be voted on. | + +----------------+------------------------------------------------+ + | REPLY | There MUST be a single VPOLL component which | + | | MUST have: either one or more POLL-ITEM-ID | + | | properties with a RESPONSE param matching that | + | | from a REQUEST or a VFREEBUSY or VAVAILABILITY | + | | child component showing overall busy/available | + | | time. The VPOLL MUST have one voter only. | + +----------------+------------------------------------------------+ + | ADD | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | CANCEL | There MUST be a single VPOLL component with | + | | UID | + +----------------+------------------------------------------------+ + | | matching that of the poll being cancelled. | + +----------------+------------------------------------------------+ + | REFRESH | The organizer returns a METHOD:REQUEST with | + | | the current full state, or a METHOD:CANCEL or | + | | an error if no matching poll is found. | + +----------------+------------------------------------------------+ + | COUNTER | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | DECLINECOUNTER | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | POLLSTATUS | Used to send the current state of the poll to | + | | all voters. The VPOLL can contain a reduced | + | | set of properties but MUST contain DTSTAMP, | + | | SEQUENCE (if not 0), UID, ORGANIZER and | + | | PARTICIPANTS. | + +----------------+------------------------------------------------+ + + Table 1 + + The following table shows the above methods broken down by who can + send them with VPOLL components. + + + + + + + + +York, et al. Expires 31 January 2021 [Page 25] + +Internet-Draft VPOLL July 2020 + + + +------------+------------------------------------------------+ + | Originator | Methods | + +============+================================================+ + | Organizer | CANCEL, PUBLISH, REQUEST, POLLSTATUS | + +------------+------------------------------------------------+ + | Voter | REPLY, REFRESH, REQUEST (only when delegating) | + +------------+------------------------------------------------+ + + Table 2 + +7.2. Interoperability Models + + Most of the standard iTip specification applies with respect to + organizer and voters. + +7.2.1. Delegation + + TBD + +7.2.2. Acting on Behalf of Other Calendar Users + + TBD + +7.2.3. Component Revisions + + * Need to talk about what a change in SEQUENCE means + + * Sequence change forces a revote. + + * New voter - no sequence change + + * Add another poll set or change poll item ids or any change to a + child + + * component - bump sequence + +7.2.4. Message Sequencing + + TBD + +7.3. Application Protocol Elements + +7.3.1. Methods for VPOLL Calendar Components + + This section defines the property set restrictions for the method + types that are applicable to the "VPOLL" calendar component. Each + method is defined using a table that clarifies the property + constraints that define the particular method. + + + +York, et al. Expires 31 January 2021 [Page 26] + +Internet-Draft VPOLL July 2020 + + + The presence column uses the following values to assert whether a + property is required or optional, and the number of times it may + appear in the iCalendar object. + + +----------------+-------------------------------------------------+ + | Presence Value | Description | + +================+=================================================+ + | 1 | One instance MUST be present. | + +----------------+-------------------------------------------------+ + | 1+ | At least one instance MUST be present. | + +----------------+-------------------------------------------------+ + | 0 | Instances of this property MUST NOT be present. | + +----------------+-------------------------------------------------+ + | 0+ | Multiple instances MAY be present. | + +----------------+-------------------------------------------------+ + | 0 or 1 | Up to 1 instance of this property MAY be | + | | present. | + +----------------+-------------------------------------------------+ + + Table 3 + + The following summarizes the methods that are defined for the "VPOLL" + calendar component. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 27] + +Internet-Draft VPOLL July 2020 + + + +------------+------------------------------------------------------+ + | Method | Description | + +============+======================================================+ + | PUBLISH | Post notification of an poll. Used primarily | + | | as a method of advertising the existence of a | + | | poll. | + +------------+------------------------------------------------------+ + | REQUEST | To make a request for a poll. This is an | + | | explicit invitation to one or more voters. | + | | Poll requests are also used to update, change | + | | or confirm an existing poll. Clients that | + | | cannot handle REQUEST MAY degrade the poll to | + | | view it as a PUBLISH. REQUEST SHOULD NOT be | + | | used just to set the status of the poll - | + | | POLLSTATUS provides a more compact approach. | + +------------+------------------------------------------------------+ + | REPLY | Reply to a poll request. Voters may set | + | | their RESPONSE parameter to supply the | + | | current vote in the range 0 to 100. | + +------------+------------------------------------------------------+ + | CANCEL | Cancel a poll. | + +------------+------------------------------------------------------+ + | REFRESH | A request is sent to an Organizer by a Voter | + | | asking for the latest version of a poll to be | + | | resent to the requester. | + +------------+------------------------------------------------------+ + | POLLSTATUS | Used to send the current state of the poll to | + | | all voters. The VPOLL can contain a reduced | + | | set of properties but MUST contain DTSTAMP, | + | | SEQUENCE (if not 0), UID, ORGANIZER and | + | | PARTICIPANT. | + +------------+------------------------------------------------------+ + + Table 4 + +7.3.2. Method: PUBLISH + + The "PUBLISH" method in a "VPOLL" calendar component is an + unsolicited posting of an iCalendar object. Any CU may add published + components to their calendar. The "Organizer" MUST be present in a + published iCalendar component. "Voters" MUST NOT be present. Its + expected usage is for encapsulating an arbitrary poll as an iCalendar + object. The "Organizer" may subsequently update (with another + "PUBLISH" method) or cancel (with a "CANCEL" method) a previously + published "VPOLL" calendar component. + + Note Not clear how useful this is but needs some work on + transmitting the current vote without any voter identification. + + + +York, et al. Expires 31 January 2021 [Page 28] + +Internet-Draft VPOLL July 2020 + + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST equal PUBLISH. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | If present defines the start of the | + | | | poll. Otherwise the poll starts | + | | | when it is created and distributed. | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + + + +York, et al. Expires 31 January 2021 [Page 29] + +Internet-Draft VPOLL July 2020 + + + | | | present. | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of COMPLETED/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 0+ | Only PARTICIPANT components with | + | | | PARTICIPANT-TYPE not equal to | + | | | "VOTER" - that is, no voters | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + + + +York, et al. Expires 31 January 2021 [Page 30] + +Internet-Draft VPOLL July 2020 + + + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + + Table 5: Constraints for a METHOD:PUBLISH of a VPOLL + +7.3.3. Method: REQUEST + + The "REQUEST" method in a "VPOLL" component provides the following + scheduling functions: + + * Invite "Voters" to respond to the poll. + + * Change the items being voted upon. + + * Complete or confirm the poll. + + * Response to a "REFRESH" request. + + * Update the details of an existing vpoll. + + * Update the status of "Voters". + + * Forward a "VPOLL" to another uninvited CU. + + * For an existing "VPOLL" calendar component, delegate the role of + "Voter" to another CU. + + * For an existing "VPOLL" calendar component, change the role of + "Organizer" to another CU. + + The "Organizer" originates the "REQUEST". The recipients of the + "REQUEST" method are the CUs voting in the poll, the "Voters". + "Voters" use the "REPLY" method to convey votes to the "Organizer". + + The "UID" and "SEQUENCE" properties are used to distinguish the + various uses of the "REQUEST" method. If the "UID" property value in + the "REQUEST" is not found on the recipient's calendar, then the + "REQUEST" is for a new "VPOLL" calendar component. If the "UID" + property value is found on the recipient's calendar, then the + "REQUEST" is for an update, or a reconfirmation of the "VPOLL" + calendar component. + + + +York, et al. Expires 31 January 2021 [Page 31] + +Internet-Draft VPOLL July 2020 + + + For the "REQUEST" method only a single iCalendar object is permitted. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST be REQUEST. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1 | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1+ | Identified as voters with the | + | | | PARTICIPANT-TYPE=VOTER | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | If present defines the start of the | + | | | poll. Otherwise the poll starts | + | | | when it is created and distributed. | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + + + +York, et al. Expires 31 January 2021 [Page 32] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of COMPLETED/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0+ | Depending upon the poll mode in | + + + +York, et al. Expires 31 January 2021 [Page 33] + +Internet-Draft VPOLL July 2020 + + + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + + Table 6: Constraints for a METHOD:REQUEST of a VPOLL + +7.3.3.1. Rescheduling a poll + + The "REQUEST" method may be used to reschedule a poll, that is force + a revote. A rescheduled poll involves a change to the existing poll + in terms of its time the components being voted on may have changed. + If the recipient CUA of a "REQUEST" method finds that the "UID" + property value already exists on the calendar but that the "SEQUENCE" + (or "DTSTAMP") property value in the "REQUEST" method is greater than + the value for the existing poll, then the "REQUEST" method describes + a rescheduling of the poll. + +7.3.3.2. Updating or Reconfirmation of a Poll + + The "REQUEST" method may be used to update or reconfirm a poll. An + update to an existing poll does not involve changes to the time or + candidates, and might not involve a change to the location or + description for the poll. If the recipient CUA of a "REQUEST" method + finds that the "UID" property value already exists on the calendar + and that the "SEQUENCE" property value in the "REQUEST" is the same + as the value for the existing poll, then the "REQUEST" method + + describes an update of the poll details, but not a rescheduling of + the POLL. + + The update "REQUEST" method is the appropriate response to a + "REFRESH" method sent from a "Voter" to the "Organizer" of a poll. + + + + + + +York, et al. Expires 31 January 2021 [Page 34] + +Internet-Draft VPOLL July 2020 + + + The "Organizer" of a poll may also send unsolicited "REQUEST" + methods. The unsolicited "REQUEST" methods may be used to update the + details of the poll without rescheduling it, to update the "RESPONSE" + parameter of "Voters", or to reconfirm the poll. + +7.3.3.3. Confirmation of a Poll + + The "REQUEST" method may be used to confirm a poll, that is announce + the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and + for BASIC mode a VPOLL POLL-WINNER property must be provided with the + poll-id of the winning component. + +7.3.3.4. Closing a Poll + + The "REQUEST" method may be used to close a poll, that is indicate + voting is completed. The STATUS MUST be set to COMPLETED. + +7.3.3.5. Delegating a Poll to Another CU + + Some calendar and scheduling systems allow "Voters" to delegate the + vote to another "Calendar User". iTIP supports this concept using the + following workflow. Any "Voter" may delegate their right to vote in + a poll to another CU. The implication is that the delegate + participates in lieu of the original "Voter", NOT in addition to the + "Voter". The delegator MUST notify the "Organizer" of this action + using the steps outlined below. Implementations may support or + restrict delegation as they see fit. For instance, some + implementations may restrict a delegate from delegating a "REQUEST" + to another CU. + + The "Delegator" of a poll forwards the existing "REQUEST" to the + "Delegate". The "REQUEST" method MUST include a "Voter" property + with the calendar address of the "Delegate". The "Delegator" MUST + also send a "REPLY" method to the "Organizer" with the "Delegator's" + "Voter" property "DELEGATED-TO" parameter set to the calendar address + of the "Delegate". Also, a new "Voter" property for the "Delegate" + MUST be included and must specify the calendar user address set in + the "DELEGATED-TO" parameter, as above. + + In response to the request, the "Delegate" MUST send a "REPLY" method + to the "Organizer", and optionally to the "Delegator". The "REPLY" + + method SHOULD include the "Voter" property with the "DELEGATED-FROM" + parameter value of the "Delegator's" calendar address. + + + + + + + +York, et al. Expires 31 January 2021 [Page 35] + +Internet-Draft VPOLL July 2020 + + + The "Delegator" may continue to receive updates to the poll even + though they will not be attending. This is accomplished by the + "Delegator" setting their "role" attribute to "NON-PARTICIPANT" in + the "REPLY" to the "Organizer". + +7.3.3.6. Changing the Organizer + + The situation may arise where the "Organizer" of a "VPOLL" is no + longer able to perform the "Organizer" role and abdicates without + passing on the "Organizer" role to someone else. When this occurs, + the "Voters" of the "VPOLL" may use out-of-band mechanisms to + communicate the situation and agree upon a new "Organizer". The new + "Organizer" should then send out a new "REQUEST" with a modified + version of the "VPOLL" in which the "SEQUENCE" number has been + incremented and the "ORGANIZER" property has been changed to the new + "Organizer". + +7.3.3.7. Sending on Behalf of the Organizer + + There are a number of scenarios that support the need for a "Calendar + User" to act on behalf of the "Organizer" without explicit role + changing. This might be the case if the CU designated as "Organizer" + is sick or unable to perform duties associated with that function. + In these cases, iTIP supports the notion of one CU acting on behalf + of another. Using the "SENT-BY" parameter, a "Calendar User" could + send an updated "VPOLL" "REQUEST". In the case where one CU sends on + behalf of another CU, the "Voter" responses are still directed back + towards the CU designated as "Organizer". + +7.3.3.8. Forwarding to an Uninvited CU + + A "Voter" invited to a "VPOLL" calendar component may send the + "VPOLL" calendar component to another new CU not previously + associated with the "VPOLL" calendar component. The current "Voter" + participating in the "VPOLL" calendar component does this by + forwarding the original "REQUEST" method to the new CU. The new CU + can send a "REPLY" to the "Organizer" of the "VPOLL" calendar + component. The reply contains a "Voter" property for the new CU. + + The "Organizer" ultimately decides whether or not the new CU becomes + part of the poll and is not obligated to do anything with a "REPLY" + from a new (uninvited) CU. If the "Organizer" does not want the new + CU to be part of the poll, the new "Voter" property is not added to + the "VPOLL" calendar component. The "Organizer" MAY send the CU a + "CANCEL" message to indicate that they will not be added to the poll. + + + + + + +York, et al. Expires 31 January 2021 [Page 36] + +Internet-Draft VPOLL July 2020 + + + If the "Organizer" decides to add the new CU, the new "Voter" + property is added to the "VPOLL" calendar component. Furthermore, + the "Organizer" is free to change any "Voter" property parameter from + the values supplied by the new CU to something the "Organizer" + considers appropriate. The "Organizer" SHOULD send the new CU a + "REQUEST" message to inform them that they have been added. + + When forwarding a "REQUEST" to another CU, the forwarding "Voter" + MUST NOT make changes to the original message. + +7.3.3.9. Updating Voter Status + + The "Organizer" of an poll may also request updated status from one + or more "Voters". The "Organizer" sends a "REQUEST" method to the + "Voter" and sets the "RSVP=TRUE" property parameter on the + PARTICIPANT CALENDAR-ADDRESS. The "SEQUENCE" property for the poll + is not changed from its previous value. A recipient will determine + that the only change in the "REQUEST" is that their "RSVP" property + parameter indicates a request for updated status. The recipient + SHOULD respond with a "REPLY" method indicating their current vote + with respect to the "REQUEST". + +7.3.4. Method: REPLY + + The "REPLY" method in a "VPOLL" calendar component is used to respond + (e.g., accept or decline) to a "REQUEST" or to reply to a delegation + "REQUEST". When used to provide a delegation response, the + "Delegator" SHOULD include the calendar address of the "Delegate" on + the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR- + ADDRESS" property. The "Delegate" SHOULD include the calendar + address of the "Delegator" on the "DELEGATED-FROM" property parameter + of the "Delegate's" "CALENDAR-ADDRESS" property. + + The "REPLY" method is also used when processing of a "REQUEST" fails. + Depending on the value of the "REQUEST-STATUS" property, no action + may have been performed. + + The "Organizer" of a poll may receive the "REPLY" method from a CU + not in the original "REQUEST". For example, a "REPLY" may be + received from a "Delegate" to a poll. In addition, the "REPLY" + method may be received from an unknown CU (a "Party Crasher"). This + uninvited "Voter" may be accepted, or the "Organizer" may cancel the + poll for the uninvited "Voter" by sending a "CANCEL" method to the + uninvited "Voter". + + + + + + + +York, et al. Expires 31 January 2021 [Page 37] + +Internet-Draft VPOLL July 2020 + + + A "Voter" MAY include a message to the "Organizer" using the + "COMMENT" property. For example, if the user indicates a low + interest and wants to let the "Organizer" know why, the reason can be + expressed in the "COMMENT" property value. + + The "Organizer" may also receive a "REPLY" from one CU on behalf of + another. Like the scenario enumerated above for the "Organizer", + "Voters" may have another CU respond on their behalf. This is done + using the "SENT-BY" parameter. + + The optional properties listed in the table below (those listed as + "0+" or "0 or 1") MUST NOT be changed from those of the original + request. (But see comments on VFREEBUSY and VAVAILABILITY) + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST be REPLY. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | All components MUST have the same | + +-----------------+----------+-------------------------------------+ + | | | UID. | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1 | Identifies the Voter replying. | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | UID | 1 | MUST be the UID of the original | + +-----------------+----------+-------------------------------------+ + | | | REQUEST. | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | If non-zero, MUST be the sequence | + | | | number of the original REQUEST. | + | | | MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + + + +York, et al. Expires 31 January 2021 [Page 38] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 1+ | One per item being voted on. | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + + + +York, et al. Expires 31 January 2021 [Page 39] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0 | | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0 or 1 | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0 | | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 or 1 | A voter may respond with a | + | | | VFREEBUSY component indicating that | + | | | the ORGANIZER may select some other | + | | | time which is not marked as busy. | + +-----------------+----------+-------------------------------------+ + | VAVAILABILITY | 0 | A voter may respond with a | + | | | VAVAILABILITY component indicating | + | | | that the ORGANIZER may select some | + | | | other time which is shown as | + | | | available. | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0 | | + +-----------------+----------+-------------------------------------+ + | VTODO | 0 | | + +-----------------+----------+-------------------------------------+ + + Table 7: Constraints for a METHOD:REPLY of a VPOLL + +7.3.5. Method: CANCEL + + The "CANCEL" method in a "VPOLL" calendar component is used to send a + cancellation notice of an existing poll request to the affected + "Voters". The message is sent by the "Organizer" of the poll. + + The "Organizer" MUST send a "CANCEL" message to each "Voter" affected + by the cancellation. This can be done using a single "CANCEL" + message for all "Voters" or by using multiple messages with different + subsets of the affected "Voters" in each. + + When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be + incremented as described in Section 7.2.3. + + Once a CANCEL message has been sent to all voters no further voting + may take place. The poll is considered closed. + + + +York, et al. Expires 31 January 2021 [Page 40] + +Internet-Draft VPOLL July 2020 + + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+----------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+==================================+ + | METHOD | 1 | MUST be CANCEL. | + +-----------------+----------+----------------------------------+ + | VPOLL | 1+ | All must have the same UID. | + +-----------------+----------+----------------------------------+ + | PARTICIPANT | 0+ | MUST include some or all Voters | + | | | being removed from the poll. | + | | | MUST include some or all Voters | + | | | if the entire poll is cancelled. | + +-----------------+----------+----------------------------------+ + | UID | 1 | MUST be the UID of the original | + | | | REQUEST. | + +-----------------+----------+----------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+----------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+----------------------------------+ + | SEQUENCE | 1 | | + +-----------------+----------+----------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+----------------------------------+ + | ACCEPT-RESPONSE | 0 | | + +-----------------+----------+----------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+----------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+----------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+----------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | DESCRIPTION | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+----------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+----------------------------------+ + + + +York, et al. Expires 31 January 2021 [Page 41] + +Internet-Draft VPOLL July 2020 + + + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+----------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+----------------------------------+ + | POLL-MODE | 0 | | + +-----------------+----------+----------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+----------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+----------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+----------------------------------+ + | STATUS | 0 or 1 | MUST be set to CANCELLED to | + | | | cancel the entire event. If | + | | | uninviting specific Attendees, | + | | | then MUST NOT be included. | + +-----------------+----------+----------------------------------+ + | SUMMARY | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+----------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+----------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+----------------------------------+ + | VALARM | 0 | | + +-----------------+----------+----------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+----------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+----------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+----------------------------------+ + | VTODO | 0 | | + + + +York, et al. Expires 31 January 2021 [Page 42] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+----------------------------------+ + | VJOURNAL | 0 | | + +-----------------+----------+----------------------------------+ + | VEVENT | 0 | | + +-----------------+----------+----------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+----------------------------------+ + + Table 8: Constraints for a METHOD:CANCEL of a VPOLL + +7.3.6. Method: REFRESH + + The "REFRESH" method in a "VPOLL" calendar component is used by + "Voters" of an existing event to request an updated description from + the poll "Organizer". The "REFRESH" method must specify the "UID" + property of the poll to update. The "Organizer" responds with the + latest description and version of the poll. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +--------------------+----------+----------------------------+ + | Component/Property | Presence | Comment | + +====================+==========+============================+ + | METHOD | 1 | MUST be REFRESH. | + +--------------------+----------+----------------------------+ + | VPOLL | 1 | | + +--------------------+----------+----------------------------+ + | PARTICIPANT | 1 | MUST identify the | + | | | requester as a voter. | + +--------------------+----------+----------------------------+ + | DTSTAMP | 1 | | + +--------------------+----------+----------------------------+ + | ORGANIZER | 1 | | + +--------------------+----------+----------------------------+ + | UID | 1 | MUST be the UID associated | + | | | with original REQUEST. | + +--------------------+----------+----------------------------+ + | COMMENT | 0+ | | + +--------------------+----------+----------------------------+ + | COMPLETED | 0 | | + +--------------------+----------+----------------------------+ + | IANA-PROPERTY | 0+ | | + +--------------------+----------+----------------------------+ + | X-PROPERTY | 0+ | | + +--------------------+----------+----------------------------+ + | ACCEPT-RESPONSE | 0 | | + +--------------------+----------+----------------------------+ + + + +York, et al. Expires 31 January 2021 [Page 43] + +Internet-Draft VPOLL July 2020 + + + | ATTACH | 0 | | + +--------------------+----------+----------------------------+ + | CATEGORIES | 0 | | + +--------------------+----------+----------------------------+ + | CLASS | 0 | | + +--------------------+----------+----------------------------+ + | CONTACT | 0 | | + +--------------------+----------+----------------------------+ + | CREATED | 0 | | + +--------------------+----------+----------------------------+ + | DESCRIPTION | 0 | | + +--------------------+----------+----------------------------+ + | DTEND | 0 | | + +--------------------+----------+----------------------------+ + | DTSTART | 0 | | + +--------------------+----------+----------------------------+ + | DURATION | 0 | | + +--------------------+----------+----------------------------+ + | GEO | 0 | | + +--------------------+----------+----------------------------+ + | LAST-MODIFIED | 0 | | + +--------------------+----------+----------------------------+ + | LOCATION | 0 | | + +--------------------+----------+----------------------------+ + | POLL-ITEM-ID | 0 | | + +--------------------+----------+----------------------------+ + | POLL-MODE | 0 | | + +--------------------+----------+----------------------------+ + | POLL-PROPERTIES | 0 | | + +--------------------+----------+----------------------------+ + | PRIORITY | 0 | | + +--------------------+----------+----------------------------+ + | RELATED-TO | 0 | | + +--------------------+----------+----------------------------+ + | REQUEST-STATUS | 0 | | + +--------------------+----------+----------------------------+ + | RESOURCES | 0 | | + +--------------------+----------+----------------------------+ + | SEQUENCE | 0 | | + +--------------------+----------+----------------------------+ + | STATUS | 0 | | + +--------------------+----------+----------------------------+ + | SUMMARY | 0 | | + +--------------------+----------+----------------------------+ + | URL | 0 | | + +--------------------+----------+----------------------------+ + | VALARM | 0 | | + +--------------------+----------+----------------------------+ + + + +York, et al. Expires 31 January 2021 [Page 44] + +Internet-Draft VPOLL July 2020 + + + | VTIMEZONE | 0+ | | + +--------------------+----------+----------------------------+ + | IANA-COMPONENT | 0+ | | + +--------------------+----------+----------------------------+ + | X-COMPONENT | 0+ | | + +--------------------+----------+----------------------------+ + | VTODO | 0 | | + +--------------------+----------+----------------------------+ + | VJOURNAL | 0 | | + +--------------------+----------+----------------------------+ + | VEVENT | 0 | | + +--------------------+----------+----------------------------+ + | VFREEBUSY | 0 | | + +--------------------+----------+----------------------------+ + + Table 9: Constraints for a METHOD:REFRESH of a VPOLL + +7.3.7. Method: POLLSTATUS + + The "POLLSTATUS" method in a "VPOLL" calendar component is used to + inform recipients of the current status of the poll in a compact + manner. The "Organizer" MUST be present in the confirmed poll + component. All "Voters" MUST be present. The selected component(s) + according to the poll mode SHOULD NOT be present in the poll + component. Clients receiving this message may store the confirmed + items in their calendars. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST equal POLLSTATUS. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1+ | The voters containing their current | + | | | vote | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | Only present for a completed poll | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + + + +York, et al. Expires 31 January 2021 [Page 45] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0 | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0 | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0 | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of TENTATIVE/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + + + +York, et al. Expires 31 January 2021 [Page 46] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + + Table 10: Constraints for a METHOD:POLLSTATUS of a VPOLL + +8. CalDAV Extensions + + This specification extends [RFC4791] in that it defines a new + component and new iCalendar properties to be supported and requires + extra definitions related to time-ranges and reports. + + Additionally, it extends [RFC6638] as it a VPOLL component is a + schedulable entity. + +8.1. Calendar Collection Properties + + This section defines new CalDAV properties for calendar collections. + +8.1.1. CALDAV:supported-vpoll-component-sets + + Name supported-vpoll-component-sets + + Namespace urn:ietf:params:xml:ns:caldav + + + +York, et al. Expires 31 January 2021 [Page 47] + +Internet-Draft VPOLL July 2020 + + + Purpose Specifies the calendar component types (e.g., VEVENT, VTODO, + etc.) and combination of types that may be included in a VPOLL + component. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:supported-vpoll-component-sets property is + used to specify restrictions on the calendar component types that + VPOLL components may contain in a calendar collection. + + It also specifies the combination of allowed component types. + + Any attempt by the client to store VPOLL components with component + types or combinations of types not listed in this property, if it + exists, MUST result in an error, with the "CALDAV:supported-vpoll- + component-sets" precondition Section 8.2 being violated. Since + this property is protected, it cannot be changed by clients using + a PROPPATCH request. However, clients can initialize the value of + this property when creating a new calendar collection with + MKCALENDAR. In the absence of this property, the server MUST + accept all component types, and the client can assume that all + component types are accepted. + + Definition + + + + + + Figure 22 + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 48] + +Internet-Draft VPOLL July 2020 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Figure 23 + +8.1.2. CALDAV:vpoll-max-items + + Name vpoll-max-items + + Namespace urn:ietf:params:xml:ns:caldav + + Purpose Provides a numeric value indicating the maximum number of + items that may be contained in any instance of a VPOLL calendar + object resource stored in the calendar collection. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:vpoll-max-items is used to specify a numeric + value that indicates the maximum number of iCalendar components in + any one instance of a VPOLL calendar object resource stored in a + calendar collection. Any attempt to store a calendar object + resource with more components per instance than this value MUST + + + +York, et al. Expires 31 January 2021 [Page 49] + +Internet-Draft VPOLL July 2020 + + + result in an error, with the CALDAV: vpoll-max-items precondition + Section 8.2 being violated. In the absence of this property, the + client can assume that the server can handle any number of items + in a VPOLL calendar component. + + Definition + + + PCDATA value: a numeric value (integer greater than zero) + + Figure 24 + + 25 + + Figure 25 + +8.1.3. CALDAV:vpoll-max-active + + Name vpoll-max-active + + Namespace urn:ietf:params:xml:ns:caldav + + Purpose Provides a numeric value indicating the maximum number of + active vpolls at any one time. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:vpoll-max-active is used to specify a numeric + value that indicates the maximum number of active VPOLLs at any + one time. Any attempt to store a new active VPOLL calendar object + resource which results in exceeding this limit MUST result in an + error, with the "CALDAV:vpoll-max-active" precondition Section 8.2 + being violated. In the absence of this property, the client can + assume that the server can handle any number of active VPOLLs. + + Definition + + + PCDATA value: a numeric value (integer greater than zero) + + Figure 26 + + 25 + + + + +York, et al. Expires 31 January 2021 [Page 50] + +Internet-Draft VPOLL July 2020 + + + Figure 27 + +8.1.4. CALDAV:vpoll-max-voters + + Name "vpoll-max-voters" + + Namespace "urn:ietf:params:xml:ns:caldav" + + Purpose Provides a numeric value indicating the maximum number of + voters for any instance of a VPOLL calendar object resource stored + in the calendar collection. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND "DAV:allprop" request (as defined in [RFC2518]). + + Description The "CALDAV:vpoll-max-voters" is used to specify a + numeric value that indicates the maximum number of voters for any + one instance of a VPOLL calendar object resource stored in a + calendar collection. Any attempt to store a calendar object + resource with more voters per instance than this value MUST result + in an error, with the CALDAV: "vpoll-max-voters" precondition + Section 8.2 being violated. In the absence of this property, the + client can assume that the server can handle any number of voters + in a VPOLL calendar component. + + Definition + + + PCDATA value: a numeric value (integer greater than zero) + + Figure 28 + + 25 + + Figure 29 + +8.1.5. CalDAV:even-more-properties + +8.1.6. Extensions to CalDAV scheduling + + This specification extends [RFC6638]. + + Each section of Appendix A "Scheduling Privileges Summary" is + extended to include VPOLL. + + + + + +York, et al. Expires 31 January 2021 [Page 51] + +Internet-Draft VPOLL July 2020 + + + Any reference to the ATTENDEE property should be read to include the + CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. + That is, for scheduling purposes the CALENDAR-ADDRESS property is + handled in exactly the same manner as the ATTENDEE property. + +8.2. Additional Preconditions for PUT, COPY, and MOVE + + This specification creates additional Preconditions for PUT, COPY, + and MOVE methods. These preconditions apply when a PUT operation of + a VPOLL calendar object resource into a calendar collection occurs, + or when a COPY or MOVE operation of a calendar object resource into a + calendar collection occurs, or when a COPY or MOVE operation occurs + on a calendar collection. + + The new preconditions are: + + (CALDAV:supported-vpoll-component-sets) The VPOLL resource submitted + in the PUT request, or targeted by a COPY or MOVE request, MUST + contain a type or combination of calendar component that is + supported in the targeted calendar collection; + + (CALDAV:vpoll-max-items) The VPOLL resource submitted in the PUT + request, or targeted by a COPY or MOVE request, MUST have a number + of sub-components (excluding VTIMEZONE) less than or equal to the + value of the "CALDAV:vpoll-max-items" property value Section 8.1.2 + on the calendar collection where the resource will be stored; + + (CALDAV:vpoll-max-active) The PUT request, or COPY or MOVE request, + MUST not result in the number of active VPOLLs being greater than + the value of the "CALDAV:vpoll-max-active" property value + Section 8.1.3 on the calendar collection where the resource will + be stored; + + (CALDAV:vpoll-max-voters) The VPOLL resource submitted in the PUT + request, or targeted by a COPY or MOVE request, MUST have a number + of voters represented by PARTICIPANT components less than or equal + to the value of the "CALDAV:vpoll-max-voters" property value + Section 8.1.4 on the calendar collection where the resource will + be stored; + +8.3. CalDAV:calendar-query Report + + This allows the retrieval of VPOLLs and their included components. + The query specification allows queries to be directed at the + contained sub-components. For VPOLL queries this feature is + disallowed. Time-range queries can only target the vpoll component + itself. + + + + +York, et al. Expires 31 January 2021 [Page 52] + +Internet-Draft VPOLL July 2020 + + +8.3.1. Example: Partial Retrieval of VPOLL + + In this example, the client requests the server to return specific + components and properties of the VPOLL components that overlap the + time range from December 4, 2012, at 00:00:00 A.M. UTC to December + 5, 2012, at 00:00:00 A.M. UTC. In addition, the "DAV:getetag" + property is also requested and returned as part of the response. + Note that due to the CALDAV: calendar-data element restrictions, the + DTSTAMP property in VPOLL components has not been returned, and the + only property returned in the VCALENDAR object is VERSION. + + >> Request << + + REPORT /cyrus/work/ HTTP/1.1 + Host: cal.example.com + Depth: 1 + Content-Type: application/xml; charset="utf-8" + Content-Length: xxxx + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 53] + +Internet-Draft VPOLL July 2020 + + + >> Response << + + HTTP/1.1 207 Multi-Status + Date: Sat, 11 Nov 2012 09:32:12 GMT + Content-Type: application/xml; charset="utf-8" + Content-Length: xxxx + + + + + http://cal.example.com/cyrus/work/poll2.ics + + + "fffff-abcd2" + BEGIN:VCALENDAR + VERSION:2.0 + BEGIN:VPOLL + DTSTART;TZID=US/Eastern:20121202T120000 + DURATION:PT4D + SUMMARY:Poll #2 + UID:00959BC664CA650E933C892C@example.com + END:VPOLL + END:VCALENDAR + + + HTTP/1.1 200 OK + + + + http://cal.example.com/cyrus/work/poll3.ics + + + "fffff-abcd3" + BEGIN:VCALENDAR + + VERSION:2.0 + PRODID:-//Example Corp.//CalDAV Client//EN + BEGIN:VPOLL + DTSTART;TZID=US/Eastern:20121204T100000 + DURATION:PT4D + SUMMARY:Poll #3 + UID:DC6C50A017428C5216A2F1CD@example.com + END:VPOLL + END:VCALENDAR + + + HTTP/1.1 200 OK + + + +York, et al. Expires 31 January 2021 [Page 54] + +Internet-Draft VPOLL July 2020 + + + + + + + Figure 30 + +8.4. CalDAV time ranges + + "CALDAV:time-range XML Element" in [RFC4791] describes how to specify + time ranges to limit the set of calendar components returned by the + server. This specification extends [RFC4791] to describe the meaning + of time ranges for VPOLL + + A VPOLL component is said to overlap a given time range if the + condition for the corresponding component state specified in the + table below is satisfied. The conditions depend on the presence of + the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the + VPOLL component. Note that, as specified above, the DTEND value MUST + be a DATE-TIME value equal to or after the DTSTART value if + specified. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 55] + +Internet-Draft VPOLL July 2020 + + + +-------------------------------------------------------------------+ + | VPOLL has the DTSTART property? | + | +---------------------------------------------------------------+ + | | VPOLL has the DURATION property? | + | | +-----------------------------------------------------------+ + | | | VPOLL has the DTEND property? | + | | | +-------------------------------------------------------+ + | | | | VPOLL has the COMPLETED property? | + | | | | +---------------------------------------------------+ + | | | | | VPOLL has the CREATED property? | + | | | | | +-----------------------------------------------+ + | | | | | | Condition to evaluate | + +---+---+---+---+---+-----------------------------------------------+ + | Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | + | | | | | | ((end > DTSTART) OR | + | | | | | | (end >= DTSTART+DURATION)) | + +---+---+---+---+---+-----------------------------------------------+ + | Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | + | | | | | | AND | + | | | | | | ((end > DTSTART) OR (end >= DTEND)) | + +---+---+---+---+---+-----------------------------------------------+ + | Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| + | | | | | | AND | + | | | | | | ((end >= CREATED) OR (end >= COMPLETED))| + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | N | Y | (end > CREATED) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | N | N | TRUE | + +---+---+---+---+---+-----------------------------------------------+ + + Figure 31 + +9. Security Considerations + + Applications using these property need to be aware of the risks + entailed in using the URIs provided as values. See [RFC3986] for a + discussion of the security considerations relating to URIs. + +10. IANA Considerations + + + + + + +York, et al. Expires 31 January 2021 [Page 56] + +Internet-Draft VPOLL July 2020 + + +10.1. Parameter Registrations + + This document defines the following new iCalendar property parameters + to be added to the registry defined in [RFC5545]: + + +--------------------+---------+---------------+ + | Property Parameter | Status | Reference | + +====================+=========+===============+ + | REQUIRED | Current | Section 5.4.1 | + +--------------------+---------+---------------+ + | STAY-INFORMED | Current | Section 5.4.2 | + +--------------------+---------+---------------+ + + Table 11 + +10.2. Property Registrations + + This document defines the following new iCalendar properties to be + added to the registry defined in [RFC5545]: + + +-----------------+---------+---------------+ + | Property | Status | Reference | + +=================+=========+===============+ + | ACCEPT-RESPONSE | Current | Section 5.5.7 | + +-----------------+---------+---------------+ + | POLL-ITEM-ID | Current | Section 5.5.3 | + +-----------------+---------+---------------+ + | POLL-MODE | Current | Section 5.5.4 | + +-----------------+---------+---------------+ + | POLL-PROPERTIES | Current | Section 5.5.5 | + +-----------------+---------+---------------+ + | POLL-WINNER | Current | Section 5.5.6 | + +-----------------+---------+---------------+ + | RESPONSE | Current | Section 5.5.8 | + +-----------------+---------+---------------+ + + Table 12 + +10.3. POLL-MODE Registration Template + + A poll mode is defined by completing the following template. + + Poll mode name The name of the poll mode. + + Purpose The purpose of the poll mode. Give a short but clear + description. + + Reference A reference to the RFC in which the poll mode is defined + + + +York, et al. Expires 31 January 2021 [Page 57] + +Internet-Draft VPOLL July 2020 + + +10.4. POLL-MODE Registrations + + This document defines the following registered poll modes. + + +-----------+---------------------------------------+-----------+ + | Poll mode | Purpose | Reference | + | name | | | + +===========+=======================================+===========+ + | BASIC | To provide simple voting for a single | Current | + | | outcome from a number of candidates. | | + +-----------+---------------------------------------+-----------+ + + Table 13 + +11. Normative references + + [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D. + Jensen, "HTTP Extensions for Distributed Authoring - + WEBDAV", IETF RFC 2518, IETF RFC 2518, + DOI 10.17487/RFC2518, February 1999, + . + + [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform + Resource Identifier (URI): Generic Syntax", IETF RFC 3986, + IETF RFC 3986, DOI 10.17487/RFC3986, January 2005, + . + + [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, + "Calendaring Extensions to WebDAV (CalDAV)", IETF RFC + 4791, IETF RFC 4791, DOI 10.17487/RFC4791, March 2007, + . + + [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and + Scheduling Core Object Specification (iCalendar)", IETF + RFC 5545, IETF RFC 5545, DOI 10.17487/RFC5545, September + 2009, . + + [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent + Interoperability Protocol (iTIP)", IETF RFC 5546, IETF RFC + 5546, DOI 10.17487/RFC5546, December 2009, + . + + [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based + Interoperability Protocol (iMIP)", IETF RFC 6047, IETF RFC + 6047, DOI 10.17487/RFC6047, December 2010, + . + + + + + +York, et al. Expires 31 January 2021 [Page 58] + +Internet-Draft VPOLL July 2020 + + + [RFC6638] Daboo, C. and B. Desruisseaux, "Scheduling Extensions to + CalDAV", IETF RFC 6638, IETF RFC 6638, + DOI 10.17487/RFC6638, June 2012, + . + + [I-D.ietf-calext-eventpub-extensions] + Douglass, M., "Event Publishing Extensions to iCalendar", + IETF I-D.ietf-calext-eventpub-extensions, IETF I-D.ietf- + calext-eventpub-extensions, October 2019. + +12. Bibliography + +Appendix A. Open issues + + public-comment: Not documented and was a parameter on something. + Really sounds like a PARTICIPANT or VOTE property + + Notifications: Need to do a section on what Notifications to support. + A. VPOLL is about to end and you haven't voted on it yet. Instead + reuse VALARMS to notify the user? + + Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any events + booked as a result of confirmation. MUST winning event be cancelled + for POLL-MODE basic? No - voter has indicated now unable to attend - + want to revote + + Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. Requires + retention of VPOLL retention period Removed status + + ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create a + poll with a set of events where I am just the attendee of the events. + Are there any other restrictions for components in a VPOLL? Add to + security consideration + + Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event. + + Need to write down what isn't valid in a VPOLL a. Can't change POLL- + MODE + + Guide for ATTENDEE roles chair, NON-PARTICIPANT etc + + + +York, et al. Expires 31 January 2021 [Page 59] + +Internet-Draft VPOLL July 2020 + + + ? - some iTip notes On confirm - send itip if appropriate (PUBLISH) - + all non-participating - shared - feeds Organizer can specify where + result is? Confirm can specify that itip is sent - ITIP / NONE - + parameter ? on POLL-WINNER + + Need to add example of freebusy in response + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest + METHOD: REPLY + BEGIN:VPOLL + ORGANIZER:mailto:douglm@mysite.edu + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T010000Z + SEQUENCE:0 + SUMMARY:What to do this week + BEGIN:VFREEBUSY + ....... + END:VFREEBUSY + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 32 + +Appendix B. Change log + + Calext V01: 2019-10-17 MD Replace VVOTER and VOTER with PARTICIPANT. + + Calext V00: 2019-05-17 MD First calext version. Moved source to + metanorma. No changes to specification. + + V03: 2014-10-28 MD * Add VVOTER and VOTE components. + + * Add RESPONSE property. + + * Remove RESPONSE parameter from VOTER. + + V03: 2014-05-12 MD * Add reply-url property and required parameter. + + * Fix ACCEPT-RESPONSE definition. + + V02: 2014-05-12 MD * Typos fixed, clarifications made. + + + + +York, et al. Expires 31 January 2021 [Page 60] + +Internet-Draft VPOLL July 2020 + + + * Removed spurious COMMENT param. Switched some + to PUBLIC-COMMENT + + * Changed STAY-INFORMED to remove boolean value + type and state explicit TRUE/FALSE values. + + * iTip: Allow VPOLL DTSTART to be optional and + allow VAVAILABILITY as subcomponent + + * iTip: fix broken table cells + + * Add POLL-PROPERTIES, POLL-WINNER to 5545 + extensions table + + * Added Caldav scheduling section + + V01: 2013-08-07 MD * Removed method CONFIRM + + * Removed pollitemid from VPOLL abnf. Added + text for pollwinner + + * Added POLL-WINNER and verbiage + + * Added STATUS values + + * Added RELTYPE=POLL + + * Added supported-vpoll-component-sets + + * Added CalDAV related parameters to VOTER + + * Removed bad CalDAV query example. State that + queries cannot target the sub-components. + + Initial version: 2012-11-02 MD + +Authors' Addresses + + Eric York + + Email: eyork@apple.com + + + Cyrus Daboo + + Email: cyrus@daboo.name + + + + + +York, et al. Expires 31 January 2021 [Page 61] + +Internet-Draft VPOLL July 2020 + + + Michael Douglass + + Email: mikeadouglass@gmail.com + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 31 January 2021 [Page 62] diff --git a/documents/draft-york-vpoll.xml b/documents/draft-york-vpoll.xml new file mode 100644 index 0000000..300a709 --- /dev/null +++ b/documents/draft-york-vpoll.xml @@ -0,0 +1,4859 @@ + + + +VPOLL: Consensus Scheduling Component for iCalendar +VPOLL +https://www.apple.com +draft-york-vpoll-05 +draft-york-vpoll-05 + + + + +Eric York + +eyork@apple.com + + + + + + +Cyrus Daboo + +cyrus@daboo.name + + + + + + +Michael Douglass + +mikeadouglass@gmail.com + + + + + +Internet Engineering Task Force +IETF + + + +2019-05-15 + +en + + +standard + + +2020 + + +Internet Engineering Task Force +IETF + + + + +IETF + + +standard + + +internet-draft +Internet +trust200902 +true + +yes + + + + +Foreword +

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+
+Acknowledgements +

The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support.

+
+Introduction

The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

+ + + +consensus scheduling +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+ +active Vpoll +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+ +voter +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+Simple Consensus Scheduling

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

The usual property.

+
+
ORGANIZER
+
+

The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
SUMMARY
+
+

The usual property. This optional but +recommended property provides the a short title to the poll.

+
+
DESCRIPTION
+
+

The usual property. This optional property +provides more details.

+
+
DTEND
+
+

The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
POLL-MODE
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives.

+
+
POLL-COMPLETION
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice.

+
+
POLL-PROPERTIES
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
PARTICIPANT
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
VOTE
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
VEVENT
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD:REQUEST +BEGIN:VPOLL +POLL-MODE:BASIC +POLL-COMPLETION:SERVER-SUBMIT +POLL-PROPERTIES:DTSTART,LOCATION +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T000000Z +SUMMARY:What to do this week +DTEND:20120101T000000Z +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:mike@example.com +END PARTICIPANT +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL.

+
+
POLL-ITEM-ID
+
+

This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer.

+
+
+VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

Same as the request.

+
+
ORGANIZER
+
+

Same as the request.

+
+
SUMMARY
+
+

Same as the request.

+
+
PARTICIPANT
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
VOTE
+
+

One per item being voted on.

+
+
POLL-ITEM-ID
+
+

One inside each VOTE component to identify the choice.

+
+
RESPONSE
+
+

One inside each VOTE component to specify the vote.

+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
NOTE
+
+

This is poll-mode specific behavior?

+
+
+

REPLY VPOLL from Cyrus:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: POLLSTATUS +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T020000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN: VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED".

+

VPOLL confirmation:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REQUEST +BEGIN:VPOLL +ORGANIZER:mailto:douglm@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T030000Z +COMPLETED:20120101T030000Z +POLL-COMPLETION:SERVER-SUBMIT +SEQUENCE:0 +SUMMARY:What to do this week +STATUS:CONFIRMED +POLL-WINNER:3 +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+iCalendar ExtensionsUpdated Participant Type Value

Participant type property values are defined in section 11.2.1. of +. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+partvalue /= "VOTER" + +
+
Description
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+reltypeparam /= "RELTYPE" "=" "POLL" +; Property value is a VPOLL uid + +
+
Description
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+Updated Status Value

Status property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+statvalue /= statvalue-poll + ; Status values for "VPOLL". +statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + +
+
Description
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
+New Property ParametersRequired
+
Parameter name
+
+

REQUIRED

+
+
Purpose
+
+

To specify whether the associated property is required in +the current context.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+Stay-Informed
+
Parameter name
+
+

STAY-INFORMED

+
+
Purpose
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+New PropertiesAccept-Response
+
Property name
+
+

ACCEPT-RESPONSE

+
+
Purpose
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + +acceptresponseparams = *(";" other-param) +
+Poll-Completion
+
Property name
+
+

POLL-COMPLETION

+
+
Purpose
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
Description
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
Format Definition
+
+

This property is defined by the following notation:

+
+
+poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + +pcparam = *(";" other-param) + +pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + +
+
Example
+
+

The following is an example of this property:

+
+
+POLL-COMPLETION: SERVER-SUBMIT +
+Poll-Item-Id
+
Property name
+
+

POLL-ITEM-ID

+
+
Purpose
+
+

This property is used in VPOLL child components as an +identifier.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
Description
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + +pollitemidparams = *( + (";" other-param) + ) +
+Poll-Mode
+
Property name
+
+

POLL-MODE

+
+
Purpose
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
Description
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + +pollmodeparams = *(";" other-param) +
+Poll-properties
+
Property name
+
+

POLL-PROPERTIES

+
+
Purpose
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + +pollpropparams = *(";" other-param) +
+Poll-Winner
+
Property name
+
+

POLL-WINNER

+
+
Purpose
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + +pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed +
+Reply-URL
+
Property name
+
+

REPLY-URL

+
+
Purpose
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
Property Parameters
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + +reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) +
+Response
+
Property name
+
+

RESPONSE

+
+
Purpose
+
+

To specify a response vote.

+
+
Value type
+
+

INTEGER

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + +responseparams = *(";" other-param) + +
+
Description
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 - 39 A "NO vote"

    +
  • +
  • +

    40 - 79 A "MAYBE" vote

    +
  • +
  • +

    80 - 89 A "YES - but not preferred vote"

    +
  • +
  • +

    90-100 A "YES" vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+
+New ComponentsVPOLL Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + +pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + +
+
Description
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+VOTE Component
+
Component name
+
+

VOTE

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Conformance
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + +voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + +
+
Description
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.

+
+Poll Modes

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC.

+POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+Property restrictions

This poll mode has the following property requirements:

+
+
POLL-ITEM-ID
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
POLL-WINNER
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+iTIP Extensions

This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+ +

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+ + + + + + + + + + + + + + + + + +
OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+ +Delegation +

TBD

+
+ +Acting on Behalf of Other Calendar Users +

TBD

+
+ +Component Revisions +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter - no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component - bump sequence

    +
  • +
+
+ +Message Sequencing +

TBD

+
+Application Protocol ElementsMethods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the "VPOLL" +calendar component.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+Method: PUBLISH

The "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component.

+
+
Note
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:PUBLISH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0 or 1

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+Method: REQUEST

The "REQUEST" method in a "VPOLL" component provides the following +scheduling functions:

+
    +
  • +

    Invite "Voters" to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a "REFRESH" request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of "Voters".

    +
  • +
  • +

    Forward a "VPOLL" to another uninvited CU.

    +
  • +
  • +

    For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU.

    +
  • +
  • +

    For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU.

    +
  • +
+

The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer".

+

The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component.

+

For the "REQUEST" method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REQUEST of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0+

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+ +Rescheduling a poll +

The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll.

+
+Updating or Reconfirmation of a Poll

The "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll.

+

The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.

+ +Confirmation of a Poll +

The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+ +Closing a Poll +

The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+Delegating a Poll to Another CU

Some calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU.

+

The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above.

+

In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY"

+

method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address.

+

The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".

+ +Changing the Organizer +

The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer".

+
+ +Sending on Behalf of the Organizer +

There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer".

+
+Forwarding to an Uninvited CU

A "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU.

+

The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll.

+

If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added.

+

When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.

+ +Updating Voter Status +

The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST".

+
+Method: REPLY

The "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property.

+

The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed.

+

The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter".

+

A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value.

+

The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter.

+

The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REPLY of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+ + +

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+ + +

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+
+

VTODO

+
+

0

+
+
+Method: CANCEL

The "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll.

+

The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each.

+

When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in .

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:CANCEL of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

1

+
+
+

ATTACH

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: REFRESH

The "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REFRESH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0

+
+
+

DESCRIPTION

+
+

0

+
+
+

DTEND

+
+

0

+
+
+

DTSTART

+
+

0

+
+
+

DURATION

+
+

0

+
+
+

GEO

+
+

0

+
+
+

LAST-MODIFIED

+
+

0

+
+
+

LOCATION

+
+

0

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0

+
+
+

RELATED-TO

+
+

0

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0

+
+
+

SEQUENCE

+
+

0

+
+
+

STATUS

+
+

0

+
+
+

SUMMARY

+
+

0

+
+
+

URL

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: POLLSTATUS

The "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:POLLSTATUS of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+CalDAV Extensions

This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends as it a VPOLL component is a +schedulable entity.

+Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+CALDAV:supported-vpoll-component-sets
+
Name
+
+

supported-vpoll-component-sets

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
Definition
+
+
+<!ELEMENT supported-vpoll-component-sets + (supported-vpoll-component-set*) > + +<!ELEMENT supported-vpoll-component-set (comp+)> + +<C:supported-vpoll-component-sets + xmlns:C="urn:ietf:params:xml:ns:caldav"> + + <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT or VFREEBUSY --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> +</C:supported-vpoll-component-sets> +
+CALDAV:vpoll-max-items
+
Name
+
+

vpoll-max-items

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-items (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-items> +
+CALDAV:vpoll-max-active
+
Name
+
+

vpoll-max-active

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-active (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-active> +
+CALDAV:vpoll-max-voters
+
Name
+
+

+vpoll-max-voters +

+
+
Namespace
+
+

+urn:ietf:params:xml:ns:caldav +

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-voters (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-voters> +
+ +CalDAV:even-more-properties + +Extensions to CalDAV scheduling

This specification extends .

+

Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+
+
(CALDAV:supported-vpoll-component-sets)
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
(CALDAV:vpoll-max-items)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored;

+
+
(CALDAV:vpoll-max-active)
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored;

+
+
(CALDAV:vpoll-max-voters)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored;

+
+
+CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+>> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<C:calendar-query xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:prop> + <D:getetag/> + <C:calendar-data> + <C:comp name="VCALENDAR"> + <C:prop name="VERSION"/> + <C:comp name="VPOLL"> + <C:prop name="SUMMARY"/> + <C:prop name="UID"/> + <C:prop name="DTSTART"/> + <C:prop name="DTEND"/> + <C:prop name="DURATION"/> + </C:comp> + + </C:comp> + </C:calendar-data> + </D:prop> + <C:filter> + <C:comp-filter name="VCALENDAR"> + <C:comp-filter name="VPOLL"> + <C:time-range start="20121204T000000Z" + end="20121205T000000Z"/> + </C:comp-filter> + </C:comp-filter> + </C:filter> +</C:calendar-query> + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<D:multistatus xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd2"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd3"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> +</D:multistatus> +
+CalDAV time ranges

"CALDAV:time-range XML Element" in 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

++-------------------------------------------------------------------+ +| VPOLL has the DTSTART property? | +| +---------------------------------------------------------------+ +| | VPOLL has the DURATION property? | +| | +-----------------------------------------------------------+ +| | | VPOLL has the DTEND property? | +| | | +-------------------------------------------------------+ +| | | | VPOLL has the COMPLETED property? | +| | | | +---------------------------------------------------+ +| | | | | VPOLL has the CREATED property? | +| | | | | +-----------------------------------------------+ +| | | | | | Condition to evaluate | ++---+---+---+---+---+-----------------------------------------------+ +| Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | +| | | | | | ((end > DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+ +
+ +Security Considerations +

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs.

+
+IANA ConsiderationsParameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in 8.2.4:

+ + + + + + + + + + + + + + + + + + + + +
Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+ +

+
+

STAY-INFORMED

+
+

Current

+
+

+ +

+
+Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in 8.2.3:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+ +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+ +

+
+

POLL-MODE

+
+

Current

+
+

+ +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+ +

+
+

POLL-WINNER

+
+

Current

+
+

+ +

+
+

RESPONSE

+
+

Current

+
+

+ +

+
+POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+
+
Poll mode name
+
+

The name of the poll mode.

+
+
Purpose
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
Reference
+
+

A reference to the RFC in which the poll mode is defined

+
+
+POLL-MODE Registrations

This document defines the following registered poll modes.

+ + + + + + + + + + + + + + + +
Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+ + + + +
Open issues

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event.

+

Need to write down what isn't valid in a VPOLL
+ a. Can't change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:douglm@mysite.edu +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:VFREEBUSY +....... +END:VFREEBUSY +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+Change log +
+
Calext V01: 2019-10-17 MD
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
Calext V00: 2019-05-17 MD
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
V03: 2014-10-28 MD
+
+
    +
  • +

    Add VVOTER and VOTE components.

    +
  • +
  • +

    Add RESPONSE property.

    +
  • +
  • +

    Remove RESPONSE parameter from VOTER.

    +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +

    Add reply-url property and required parameter.

    +
  • +
  • +

    Fix ACCEPT-RESPONSE definition.

    +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +

    Typos fixed, clarifications made.

    +
  • +
  • +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
  • +
  • +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
  • +
  • +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
  • +
  • +

    iTip: fix broken table cells

    +
  • +
  • +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
  • +
  • +

    Added Caldav scheduling section

    +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +

    Removed method CONFIRM

    +
  • +
  • +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
  • +
  • +

    Added POLL-WINNER and verbiage

    +
  • +
  • +

    Added STATUS values

    +
  • +
  • +

    Added RELTYPE=POLL

    +
  • +
  • +

    Added supported-vpoll-component-sets

    +
  • +
  • +

    Added CalDAV related parameters to VOTER

    +
  • +
  • +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
Normative references 2020-07-16 HTTP Extensions for Distributed Authoring — WEBDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2518.xml https://www.rfc-editor.org/info/rfc2518 RFC 2518 RFC2518 10.17487/RFC2518 1999-02 Y. Goland Internet Engineering Task Force IETF E. Whitehead Internet Engineering Task Force IETF A. Faizi Internet Engineering Task Force IETF S. Carter Internet Engineering Task Force IETF D. Jensen Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] RFC 2518 Fremont, CA 2020-07-16 Uniform Resource Identifier (URI): Generic Syntax https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.3986.xml https://www.rfc-editor.org/info/rfc3986 RFC 3986 RFC3986 10.17487/RFC3986 2005-01 T. Berners-Lee Internet Engineering Task Force IETF R. Fielding Internet Engineering Task Force IETF L. Masinter Internet Engineering Task Force IETF Internet Engineering Task Force IETF en A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] STD 66 RFC 3986 Fremont, CA 2020-07-16 Calendaring Extensions to WebDAV (CalDAV) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.4791.xml https://www.rfc-editor.org/info/rfc4791 RFC 4791 RFC4791 10.17487/RFC4791 2007-03 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF L. Dusseault Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the "calendar-access" feature of CalDAV. [STANDARDS-TRACK] RFC 4791 Fremont, CA 2020-07-16 Internet Calendaring and Scheduling Core Object Specification (iCalendar) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5545.xml https://www.rfc-editor.org/info/rfc5545 RFC 5545 RFC5545 10.17487/RFC5545 2009-09 B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] RFC 5545 Fremont, CA 2020-07-16 iCalendar Transport-Independent Interoperability Protocol (iTIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5546.xml https://www.rfc-editor.org/info/rfc5546 RFC 5546 RFC5546 10.17487/RFC5546 2009-12 C. Daboo Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] RFC 5546 Fremont, CA 2020-07-16 iCalendar Message-Based Interoperability Protocol (iMIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6047.xml https://www.rfc-editor.org/info/rfc6047 RFC 6047 RFC6047 10.17487/RFC6047 2010-12 A. Melnikov Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document, "iCalendar Message-Based Interoperability Protocol (iMIP)", specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] RFC 6047 Fremont, CA 2020-07-16 Scheduling Extensions to CalDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6638.xml https://www.rfc-editor.org/info/rfc6638 RFC 6638 RFC6638 10.17487/RFC6638 2012-06 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) "calendar-access" feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the "calendar-auto-schedule" feature of CalDAV. [STANDARDS-TRACK] RFC 6638 Fremont, CA 2020-07-30 Event Publishing Extensions to iCalendar https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-calext-eventpub-extensions.xml http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.txt http://www.ietf.org/internet-drafts/draft-ietf-calext-eventpub-extensions-15.pdf I-D.ietf-calext-eventpub-extensions I-D.ietf-calext-eventpub-extensions draft-ietf-calext-eventpub-extensions-15 2019-10 Michael Douglass Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This specification updates RFC5545 by introducing a number of new iCalendar properties and components which are of particular use for event publishers and in social networking. This specification also defines a new STRUCTURED-DATA property for iCalendar RFC5545 to allow for data that is directly pertinent to an event or task to be included with the calendar data. Internet-Draft draft-ietf-calext-eventpub-extensions-15 Fremont, CA +Bibliography + +
diff --git a/documents/metadata.min.js b/documents/metadata.min.js new file mode 100644 index 0000000..e07b59f --- /dev/null +++ b/documents/metadata.min.js @@ -0,0 +1 @@ +async function addMetadata(){try{const e=document.styleSheets[0].cssRules;for(let t=0;t=0?document.URL.replace(/html$/,"json"):document.URL+".json";const o=await fetch(t);a=await o.json()}}if(!a)return;e.style.display="block";const s="",d="https://datatracker.ietf.org/doc",n="https://datatracker.ietf.org/ipr/search",c="https://www.rfc-editor.org/info",l=a.doc_id.toLowerCase(),i=a.doc_id.slice(0,3).toLowerCase(),f=a.doc_id.slice(3).replace(/^0+/,""),u={status:"Status",obsoletes:"Obsoletes",obsoleted_by:"Obsoleted By",updates:"Updates",updated_by:"Updated By",see_also:"See Also",errata_url:"Errata"};let h="
";["status","obsoletes","obsoleted_by","updates","updated_by","see_also","errata_url"].forEach(e=>{if("status"==e){a[e]=a[e].toLowerCase();var t=a[e].split(" "),o=t.length,w="",p=1;for(let e=0;e"+a[e][t].slice(3)+", ":m+""+a[e][t].slice(3)+"",b++);a[e]=m}else if("see_also"==e){var y,L="",C=1;y=a[e].length;for(let t=0;t"+_+" "+v+", ":L+""+v+", ":"RFC"!=_?L+""+_+" "+v+"":L+""+v+"",C++}a[e]=L}else if("errata_url"==e){var R="";R=a[e]?R+"Errata exist | Datatracker| IPR | Info page":"Datatracker | IPR | Info page",a[e]=R}""!=a[e]?"Errata"==u[e]?h+=`
More info:
${a[e]}
`:h+=`
${u[e]}:
${a[e]}
`:"Errata"==u[e]&&(h+=`
More info:
${a[e]}
`)}),h+="
",e.innerHTML=h}catch(e){console.log(e)}else console.log("Could not locate metadata
element");function r(e){return e.charAt(0).toUpperCase()+e.slice(1)}}window.removeEventListener("load",addMetadata),window.addEventListener("load",addMetadata); \ No newline at end of file diff --git a/metanorma.release.yml b/metanorma.release.yml new file mode 100644 index 0000000..8148f4d --- /dev/null +++ b/metanorma.release.yml @@ -0,0 +1,4 @@ +documents: + - source: sources/cc-51006.adoc + - source: sources/draft-ietf-calext-vpoll.adoc + - source: sources/draft-york-vpoll.adoc diff --git a/sources/cc-51006.html b/sources/cc-51006.html new file mode 100644 index 0000000..a51bc8b --- /dev/null +++ b/sources/cc-51006.html @@ -0,0 +1,3560 @@ + + + + Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component + + + + + + + + + + + + + + + + +
+

Committee Draft

+
+ +
+

CalConnect Standard

+
+ +
+ +
+ + +
+
+ +
+
+ CC/CD 51006:2018 + +
+ +
+ Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component + +
+
+ + + +
+ TC FREEBUSY +
+ + + + + +
+ +
+ + + Eric YorkAuthor + + Cyrus DabooAuthor + + Michael DouglassAuthor + +
+ +
+ + +
+
+ +
+
+ CalConnect Standard +
+ +
+ Committee Draft +
+ + +
+
+

Warning for Drafts

+ +

This document is not a CalConnect Standard. It is distributed for review and + comment, and is subject to change without notice and may not be referred to as + a Standard. Recipients of this draft are invited to submit, with their + comments, notification of any relevant patent rights of which they are aware + and to provide supporting documentation. +

+
+
+
+ + + + +
+
+
+
+ +

 

+
+
+ +
+
+
+ + + + + + + + + +
+
+
+

Foreword

+

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+

The Calendaring and Scheduling Consortium (“CalConnect”) is a global +non-profit organization with the aim to facilitate interoperability of +collaborative technologies and tools through open standards.

+

CalConnect works closely with international and regional partners, +of which the full list is available on our website +(https://www.calconnect.org/about/liaisons-and-relationships).

+

The procedures used to develop this document and those intended for its +further maintenance are described in the CalConnect Directives.

+

In particular the different approval criteria needed for the different +types of CalConnect documents should be noted. This document was drafted in +accordance with the editorial rules of the CalConnect Directives.

+

Attention is drawn to the possibility that some of the elements of this +document may be the subject of patent rights. CalConnect shall not be +held responsible for identifying any or all such patent rights. Details +of any patent rights identified during the development of the document +will be provided in the Introduction.

+

Any trade name used in this document is information given for the +convenience of users and does not constitute an endorsement.

+

This document was prepared by Technical Committee +FREEBUSY.

+
+
+
+

Introduction

+

The currently existing approach to agreeing on meeting times using +iTip RFC 5546 and/or iMip RFC 6047 has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement — up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+
+

Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component

+
+

1.  Scope

+

This document provides a mechanism in iCalendar for consensus scheduling.

+
+

2.  Normative references

The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

IETF RFC 2518, HTTP Extensions for Distributed Authoring — WEBDAV

IETF RFC 3986, Uniform Resource Identifier (URI): Generic Syntax

IETF RFC 4791, Calendaring Extensions to WebDAV (CalDAV)

IETF RFC 5545, Internet Calendaring and Scheduling Core Object Specification (iCalendar)

IETF RFC 5546, iCalendar Transport-Independent Interoperability Protocol (iTIP)

IETF RFC 6047, iCalendar Message-Based Interoperability Protocol (iMIP)

IETF RFC 6638, Scheduling Extensions to CalDAV

IETF IETF I-D.draft-ietf-calext-eventpub-extensions, AUTOFILL

+

3.  Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

3.1. 

consensus scheduling

+ +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+

3.2. 

active Vpoll

+ +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+

3.3. 

voter

+ +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+
+

4.  Simple Consensus Scheduling

+

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+

4.1.  The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+

DTSTAMP

+

The usual RFC 5545 property.

+

SEQUENCE

+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+

UID

+

The usual RFC 5545 property.

+

ORGANIZER

+

The usual RFC 5545 property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+

SUMMARY

+

The usual RFC 5545 property. This optional but +recommended property provides the a short title to the poll.

+

DESCRIPTION

+

The usual RFC 5545 property. This optional property +provides more details.

+

DTEND

+

The usual RFC 5545 property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+

POLL-MODE

+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value “BASIC” +meaning one event will be chosen from the alternatives.

+

POLL-COMPLETION

+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is “SERVER-SUBMIT” which means the client chooses the winner +but the server will submit the winning choice.

+

POLL-PROPERTIES

+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value “DTSTART, LOCATION” meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+

PARTICIPANT

+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to “VOTER”. The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+

VOTE

+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+

VEVENT

+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+

EXAMPLE

VPOLL with 3 voters and 3 alternative meetings:

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD:REQUEST
BEGIN:VPOLL
POLL-MODE:BASIC
POLL-COMPLETION:SERVER-SUBMIT
POLL-PROPERTIES:DTSTART,LOCATION
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T000000Z
SUMMARY:What to do this week
DTEND:20120101T000000Z
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
END PARTICIPANT
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
END PARTICIPANT
BEGIN: PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:mike@example.com
END PARTICIPANT
BEGIN:VEVENT.......(with a poll-item-id=1)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=2)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=3)
END:VEVENT
END:VPOLL
END:VCALENDAR
+
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+

4.2.  The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard RFC 5545 components. For our +simple use case they are all VEVENT components. In addition to the +usual RFC 5545 properties some extra properties are used for a +VPOLL.

+

POLL-ITEM-ID

+

This provides a unique reference to the sub-component +within the VPOLL. It’s value SHOULD be a small integer.

+
+

4.3.  VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+

DTSTAMP

+

The usual RFC 5545 property.

+

SEQUENCE

+

The usual RFC 5545 property. See below for SEQUENCE +behavior.

+

UID

+

Same as the request.

+

ORGANIZER

+

Same as the request.

+

SUMMARY

+

Same as the request.

+

PARTICIPANT

+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+

VOTE

+

One per item being voted on.

+

POLL-ITEM-ID

+

One inside each VOTE component to identify the choice.

+

RESPONSE

+

One inside each VOTE component to specify the vote.

+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+

NOTE

+

This is poll-mode specific behavior?

+
+

EXAMPLE

REPLY VPOLL from Cyrus:

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: REPLY
BEGIN:VPOLL
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T010000Z
SUMMARY:What to do this week
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
BEGIN:VOTE
POLL-ITEM-ID:1
RESPONSE:50
COMMENT:Work on iTIP
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
COMMENT:Work on WebDAV
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
END:VPOLL
END:VCALENDAR
+
+

4.4.  VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+

EXAMPLE

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: POLLSTATUS
BEGIN:VPOLL
ORGANIZER:mailto:mike@example.com
UID:sched01-1234567890
DTSTAMP:20120101T020000Z
SEQUENCE:0
SUMMARY:What to do this week
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:cyrus@example.com
BEGIN: VOTE
POLL-ITEM-ID:1
RESPONSE:50
COMMENT:Work on iTIP
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
COMMENT:Work on WebDAV
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
BEGIN:VOTE
POLL-ITEM-ID:1
RESPONSE:100
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:2
RESPONSE:100
END:VOTE
BEGIN:VOTE
POLL-ITEM-ID:3
RESPONSE:0
END:VOTE
END:PARTICIPANT
END:VPOLL
END:VCALENDAR
+
+

4.5.  VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +“SUBMITTED”.

+

EXAMPLE

VPOLL confirmation:

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Example
METHOD: REQUEST
BEGIN:VPOLL
ORGANIZER:mailto:douglm@example.com
UID:sched01-1234567890
DTSTAMP:20120101T030000Z
COMPLETED:20120101T030000Z
POLL-COMPLETION:SERVER-SUBMIT
SEQUENCE:0
SUMMARY:What to do this week
STATUS:CONFIRMED
POLL-WINNER:3
BEGIN:VEVENT.......(with a poll-item-id=1)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=2)
END:VEVENT
BEGIN:VEVENT.......(with a poll-item-id=3)
END:VEVENT
END:VPOLL
END:VCALENDAR
+
+

4.6.  Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+
+
+

5.  iCalendar Extensions

+

5.1.  Updated Participant Type Value

Participant type property values are defined in section 11.2.1. of +IETF I-D.draft-ietf-calext-eventpub-extensions. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+
partvalue       /= "VOTER"

Figure 1

+ +

Description

+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+

5.2.  Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +RFC 5545. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+
reltypeparam       /= "RELTYPE" "=" "POLL"
; Property value is a VPOLL uid

Figure 2

+ +

Description

+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+

5.3.  Updated Status Value

Status property values are defined in section 3.8.1.11. of RFC 5545. +This specification updates that type to define valid VPOLL status +values.

+

Format Definition

+

This property parameter is redefined by the following notation:

+
+
statvalue /= statvalue-poll
   ; Status values for "VPOLL".
statvalue-poll = "IN-PROCESS"
          / "COMPLETED"  ; Poll has closed,
                         ; nothing has been chosen yet
          / "CONFIRMED"  ; Poll has closed and
                         ; winning items confirmed
          / "SUBMITTED"  ; The winning item has been
                         ; submitted
          / "CANCELLED"

Figure 3

+ +

Description

+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+

Figure 4

+
+

5.4.  New Property Parameters

5.4.1.  Required

Parameter name

+

REQUIRED

+

Purpose

+

To specify whether the associated property is required in +the current context.

+

Format Definition

+

This parameter is defined by the following notation:

+
+
requirededparam = "REQUIRED"  "=" ("TRUE" / "FALSE")
  ; Default is FALSE

Figure 5

+ +

Description

+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+

5.4.2.  Stay-Informed

Parameter name

+

STAY-INFORMED

+

Purpose

+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+

Format Definition

+

This parameter is defined by the following notation:

+
+
stayinformedparam = "STAY-INFORMED"  "=" ("TRUE" / "FALSE")
                  ; Default is FALSE

Figure 6

+ +

Description

+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+

5.5.  New Properties

5.5.1.  Accept-Response

Property name

+

ACCEPT-RESPONSE

+

Purpose

+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+

Format Definition

+

This property is defined by the following notation:

+
+
acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":"
                    iana-token ("," iana-token) CRLF

acceptresponseparams = *(";" other-param)

Figure 7

+
+

5.5.2.  Poll-Completion

Property name

+

POLL-COMPLETION

+

Purpose

+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+

Description

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

Format Definition

+

This property is defined by the following notation:

+
+
poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF

pcparam = *(";" other-param)

pcvalue = "SERVER"  ; The server is responsible for both choosing and
                   ; submitting the winner(s)
        / "SERVER-SUBMIT" ; The server is responsible for
                   ; submitting the winner(s). The client chooses.
        / "SERVER-CHOICE"  ; The server is responsible for
                   ; choosing the winner(s). The client will submit.
        / "CLIENT" ; The client is responsible for both choosing and
                   ; submitting the winner(s)
        / iana-token
        / x-name
        ;Default is CLIENT

Figure 8

+ +

Example

+

The following is an example of this property:

+
+
POLL-COMPLETION: SERVER-SUBMIT

Figure 9

+
+

5.5.3.  Poll-Item-Id

Property name

+

POLL-ITEM-ID

+

Purpose

+

This property is used in VPOLL child components as an +identifier.

+

Value type

+

INTEGER

+

Property Parameters

+

Non-standard parameters can be specified on +this property.

+

Conformance

+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+

Description

+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollitemid = "POLL-ITEM-ID" pollitemdparams ":"
                  integer CRLF

pollitemidparams = *(
                   (";" other-param)
            )

Figure 10

+
+

5.5.4.  Poll-Mode

Property name

+

POLL-MODE

+

Purpose

+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component or +its sub-components.

+

Description

+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollmode = "POLL-MODE" pollmodeparams ":"
             ("BASIC" / iana-token / other-token) CRLF

pollmodeparams = *(";" other-param)

Figure 11

+
+

5.5.5.  Poll-properties

Property name

+

POLL-PROPERTIES

+

Purpose

+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+

Property Parameters

+

Non-standard or iana parameters can be +specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollproperties = "POLL-PROPERTIES" pollpropparams ":"
             text *("," text) CRLF

pollpropparams = *(";" other-param)

Figure 12

+
+

5.5.6.  Poll-Winner

Property name

+

POLL-WINNER

+

Purpose

+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+

Value type

+

INTEGER

+

Property Parameters

+

Non-standard parameters can be specified on +this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollwinner = "POLL-WINNER" pollwinnerparams ":"
                 integer CRLF

pollwinnerparams = *(";" other-param)

       ; Used with a STATUS:CONFIRMED VPOLL to indicate which
       ; components have been confirmed

Figure 13

+
+

5.5.7.  Reply-URL

Property name

+

REPLY-URL

+

Purpose

+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+

Property Parameters

+

Non-standard, required or iana parameters can +be specified on this property.

+

Conformance

+

This property MAY be specified in a VPOLL component.

+

Description

+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+

Format Definition

+

This property is defined by the following notation:

+
+
reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF

reply-urlparams = *(
                  (";" requiredparam) /
                  (";" other-param)
                  )

Figure 14

+
+

5.5.8.  Response

Property name

+

RESPONSE

+

Purpose

+

To specify a response vote.

+

Value type

+

INTEGER

+

Format Definition

+

This property is defined by the following notation:

+
+
response = "RESPONSE" response-params ":" integer CRLF
                 ; integer value 0..100

responseparams = *(";" other-param)

Figure 15

+ +

Description

+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 — 39 A “NO vote”

    +
  • +
  • +

    40 — 79 A “MAYBE” vote

    +
  • +
  • +

    80 — 89 A “YES — but not preferred vote”

    +
  • +
  • +

    90-100 A “YES” vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+

5.6.  New Components

5.6.1.  VPOLL Component

Component name

+

VPOLL

+

Purpose

+

This component provides a mechanism by which voters can +vote on provided choices.

+

Format Definition

+

This property is defined by the following notation:

+
+
pollc    = "BEGIN" ":" "VPOLL" CRLF
            pollprop
            *participantc *eventc *todoc *journalc *freebusyc
            *availabilityc *alarmc *iana-comp *x-comp
            "END" ":" "VPOLL" CRLF

pollprop = *(
          ;
          ; The following are REQUIRED,
          ; but MUST NOT occur more than once.
          ;
          dtstamp / uid / organizer /
          ;
          ; The following are OPTIONAL,
          ; but MUST NOT occur more than once.
          ;
          acceptresponse / class / created / completed /
          description / dtstart / last-mod / pollmode /
          pollproperties / priority / seq / status /
          summary / url /
          ;
          ; Either 'dtend' or 'duration' MAY appear in
          ; a 'pollprop', but 'dtend' and 'duration'
          ; MUST NOT occur in the same 'pollprop'.
          ; 'duration' MUST only occur when 'dtstart'
          ; is present
          ;
          dtend / duration /
          ;
          ; The following are OPTIONAL,
          ; and MAY occur more than once.
          ;
          attach / categories / comment /
          contact / rstatus / related /
          resources / x-prop / iana-prop
          ;
          ; The following is OPTIONAL, it SHOULD appear
          ; once for the confirmation of a BASIC mode
          ; VPOLL. Other modes may define differing
          ; requirements.
          ;
          pollwinner /
          ;
          )

Figure 16

+ +

Description

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting — both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the “DTSTART” property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If “DTSTART” is present “DURATION” MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

“DTEND” MAY be specified with or without “DTSTART” and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+

5.6.2.  VOTE Component

Component name

+

VOTE

+

Purpose

+

This component provides a mechanism by which voters can +vote on provided choices.

+

Conformance

+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+

Format Definition

+

This property is defined by the following notation:

+
+
votec     = "BEGIN" ":" "VOTE" CRLF
            voteprop
            *eventc *todoc *journalc *freebusyc
            *availabilityc *alarmc *iana-comp *x-comp
            "END" ":" "VOTE" CRLF

voteprop = *(
           ;
           ; The following are REQUIRED,
           ; but MUST NOT occur more than once.
           ;
           pollitemid / response /
           ;
           ; The following are OPTIONAL,
           ; and MAY occur more than once.
           ;
           comment / x-prop / iana-prop
           ;
           )

Figure 17

+ +

Description

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER — such as the respondees +availability.

+
+
+

6.  Poll Modes

+

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see Clause 10.3) in a published RFC.

+

6.1.  POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+

6.1.1.  Property restrictions

This poll mode has the following property requirements:

+

POLL-ITEM-ID

+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+

POLL-WINNER

+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+

6.1.2.  Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+
+
+

7.  iTIP Extensions

+

This specification introduces a number of extensions to RFC 5546. +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+

7.1.  Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+

Table 1

MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+

Table 2

OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+

7.2.  Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+

7.2.1.  Delegation

+ +

TBD

+
+

7.2.2.  Acting on Behalf of Other Calendar Users

+ +

TBD

+
+

7.2.3.  Component Revisions

+ +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter — no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component — bump sequence

    +
  • +
+
+

7.2.4.  Message Sequencing

+ +

TBD

+
+

7.3.  Application Protocol Elements

7.3.1.  Methods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the “VPOLL” calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+

Table 3

Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the “VPOLL” +calendar component.

+

Table 4

MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+

7.3.2.  Method: PUBLISH

The “PUBLISH” method in a “VPOLL” calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The “Organizer” MUST be present in a +published iCalendar component. “Voters” MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The “Organizer” may subsequently update (with another +“PUBLISH” method) or cancel (with a “CANCEL” method) a previously +published “VPOLL” calendar component.

+

Note

+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 5 — Constraints for a METHOD:PUBLISH of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0 or 1

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0 or 1

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to “VOTER” — that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0+

+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

7.3.3.  Method: REQUEST

The “REQUEST” method in a “VPOLL” component provides the following +scheduling functions:

+
    +
  • +

    Invite “Voters” to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a “REFRESH” request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of “Voters”.

    +
  • +
  • +

    Forward a “VPOLL” to another uninvited CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, delegate the role of +“Voter” to another CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, change the role of +“Organizer” to another CU.

    +
  • +
+

The “Organizer” originates the “REQUEST”. The recipients of the +“REQUEST” method are the CUs voting in the poll, the “Voters”. +“Voters” use the “REPLY” method to convey votes to the “Organizer”.

+

The “UID” and “SEQUENCE” properties are used to distinguish the +various uses of the “REQUEST” method. If the “UID” property value in +the “REQUEST” is not found on the recipient’s calendar, then the +“REQUEST” is for a new “VPOLL” calendar component. If the “UID” +property value is found on the recipient’s calendar, then the +“REQUEST” is for an update, or a reconfirmation of the “VPOLL” +calendar component.

+

For the “REQUEST” method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 6 — Constraints for a METHOD:REQUEST of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0 or 1

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

VALARM

+
+

0+

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

7.3.3.1.  Rescheduling a poll

+ +

The “REQUEST” method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a “REQUEST” method finds that the “UID” +property value already exists on the calendar but that the “SEQUENCE” +(or “DTSTAMP”) property value in the “REQUEST” method is greater than +the value for the existing poll, then the “REQUEST” method describes +a rescheduling of the poll.

+
+

7.3.3.2.  Updating or Reconfirmation of a Poll

The “REQUEST” method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a “REQUEST” method +finds that the “UID” property value already exists on the calendar +and that the “SEQUENCE” property value in the “REQUEST” is the same +as the value for the existing poll, then the “REQUEST” method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update “REQUEST” method is the appropriate response to a +“REFRESH” method sent from a “Voter” to the “Organizer” of a poll.

+

The “Organizer” of a poll may also send unsolicited “REQUEST” +methods. The unsolicited “REQUEST” methods may be used to update the +details of the poll without rescheduling it, to update the “RESPONSE” +parameter of “Voters”, or to reconfirm the poll.

+

7.3.3.3.  Confirmation of a Poll

+ +

The “REQUEST” method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+

7.3.3.4.  Closing a Poll

+ +

The “REQUEST” method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+

7.3.3.5.  Delegating a Poll to Another CU

Some calendar and scheduling systems allow “Voters” to delegate the +vote to another “Calendar User”. iTIP supports this concept using the +following workflow. Any “Voter” may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original “Voter”, NOT in addition to the +“Voter”. The delegator MUST notify the “Organizer” of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a “REQUEST” +to another CU.

+

The “Delegator” of a poll forwards the existing “REQUEST” to the +“Delegate”. The “REQUEST” method MUST include a “Voter” property +with the calendar address of the “Delegate”. The “Delegator” MUST +also send a “REPLY” method to the “Organizer” with the “Delegator’s” +“Voter” property “DELEGATED-TO” parameter set to the calendar address +of the “Delegate”. Also, a new “Voter” property for the “Delegate” +MUST be included and must specify the calendar user address set in +the “DELEGATED-TO” parameter, as above.

+

In response to the request, the “Delegate” MUST send a “REPLY” method +to the “Organizer”, and optionally to the “Delegator”. The “REPLY”

+

method SHOULD include the “Voter” property with the “DELEGATED-FROM” +parameter value of the “Delegator’s” calendar address.

+

The “Delegator” may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +“Delegator” setting their “role” attribute to “NON-PARTICIPANT” in +the “REPLY” to the “Organizer”.

+

7.3.3.6.  Changing the Organizer

+ +

The situation may arise where the “Organizer” of a “VPOLL” is no +longer able to perform the “Organizer” role and abdicates without +passing on the “Organizer” role to someone else. When this occurs, +the “Voters” of the “VPOLL” may use out-of-band mechanisms to +communicate the situation and agree upon a new “Organizer”. The new +“Organizer” should then send out a new “REQUEST” with a modified +version of the “VPOLL” in which the “SEQUENCE” number has been +incremented and the “ORGANIZER” property has been changed to the new +“Organizer”.

+
+

7.3.3.7.  Sending on Behalf of the Organizer

+ +

There are a number of scenarios that support the need for a “Calendar +User” to act on behalf of the “Organizer” without explicit role +changing. This might be the case if the CU designated as “Organizer” +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the “SENT-BY” parameter, a “Calendar User” could +send an updated “VPOLL” “REQUEST”. In the case where one CU sends on +behalf of another CU, the “Voter” responses are still directed back +towards the CU designated as “Organizer”.

+
+

7.3.3.8.  Forwarding to an Uninvited CU

A “Voter” invited to a “VPOLL” calendar component may send the +“VPOLL” calendar component to another new CU not previously +associated with the “VPOLL” calendar component. The current “Voter” +participating in the “VPOLL” calendar component does this by +forwarding the original “REQUEST” method to the new CU. The new CU +can send a “REPLY” to the “Organizer” of the “VPOLL” calendar +component. The reply contains a “Voter” property for the new CU.

+

The “Organizer” ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a “REPLY” +from a new (uninvited) CU. If the “Organizer” does not want the new +CU to be part of the poll, the new “Voter” property is not added to +the “VPOLL” calendar component. The “Organizer” MAY send the CU a +“CANCEL” message to indicate that they will not be added to the poll.

+

If the “Organizer” decides to add the new CU, the new “Voter” +property is added to the “VPOLL” calendar component. Furthermore, +the “Organizer” is free to change any “Voter” property parameter from +the values supplied by the new CU to something the “Organizer” +considers appropriate. The “Organizer” SHOULD send the new CU a +“REQUEST” message to inform them that they have been added.

+

When forwarding a “REQUEST” to another CU, the forwarding “Voter” +MUST NOT make changes to the original message.

+

7.3.3.9.  Updating Voter Status

+ +

The “Organizer” of an poll may also request updated status from one +or more “Voters”. The “Organizer” sends a “REQUEST” method to the +“Voter” and sets the “RSVP=TRUE” property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +“SEQUENCE” property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +“REQUEST” is that their “RSVP” property parameter indicates a request +for updated status. The recipient SHOULD respond with a “REPLY” +method indicating their current vote with respect to the “REQUEST”.

+
+

7.3.4.  Method: REPLY

The “REPLY” method in a “VPOLL” calendar component is used to respond +(e.g., accept or decline) to a “REQUEST” or to reply to a delegation +“REQUEST”. When used to provide a delegation response, the +“Delegator” SHOULD include the calendar address of the “Delegate” on +the “DELEGATED-TO” property parameter of the “Delegator’s” “CALENDAR-ADDRESS” +property. The “Delegate” SHOULD include the calendar address of the +“Delegator” on the “DELEGATED-FROM” property parameter of the +“Delegate’s” “CALENDAR-ADDRESS” property.

+

The “REPLY” method is also used when processing of a “REQUEST” fails. +Depending on the value of the “REQUEST-STATUS” property, no action +may have been performed.

+

The “Organizer” of a poll may receive the “REPLY” method from a CU +not in the original “REQUEST”. For example, a “REPLY” may be +received from a “Delegate” to a poll. In addition, the “REPLY” +method may be received from an unknown CU (a “Party Crasher”). This +uninvited “Voter” may be accepted, or the “Organizer” may cancel the +poll for the uninvited “Voter” by sending a “CANCEL” method to the +uninvited “Voter”.

+

A “Voter” MAY include a message to the “Organizer” using the +“COMMENT” property. For example, if the user indicates a low +interest and wants to let the “Organizer” know why, the reason can be +expressed in the “COMMENT” property value.

+

The “Organizer” may also receive a “REPLY” from one CU on behalf of +another. Like the scenario enumerated above for the “Organizer”, +“Voters” may have another CU respond on their behalf. This is done +using the “SENT-BY” parameter.

+

The optional properties listed in the table below (those listed as +“0+” or “0 or 1”) MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 7 — Constraints for a METHOD:REPLY of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+

ATTACH

+
+

0+

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

REQUEST-STATUS

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

SUMMARY

+
+

0 or 1

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+

VTODO

+
+

0

+
+

7.3.5.  Method: CANCEL

The “CANCEL” method in a “VPOLL” calendar component is used to send a +cancellation notice of an existing poll request to the affected +“Voters”. The message is sent by the “Organizer” of the poll.

+

The “Organizer” MUST send a “CANCEL” message to each “Voter” affected +by the cancellation. This can be done using a single “CANCEL” +message for all “Voters” or by using multiple messages with different +subsets of the affected “Voters” in each.

+

When a “VPOLL” is cancelled, the “SEQUENCE” property value MUST be +incremented as described in Clause 7.2.3.

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 8 — Constraints for a METHOD:CANCEL of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

SEQUENCE

+
+

1

+
+

ATTACH

+
+

0+

+
+

ACCEPT-RESPONSE

+
+

0

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0 or 1

+
+

CATEGORIES

+
+

0+

+
+

CLASS

+
+

0 or 1

+
+

CONTACT

+
+

0+

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

LOCATION

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+

TRANSP

+
+

0 or 1

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VTODO

+
+

0

+
+

VJOURNAL

+
+

0

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0

+
+

7.3.6.  Method: REFRESH

The “REFRESH” method in a “VPOLL” calendar component is used by +“Voters” of an existing event to request an updated description from +the poll “Organizer”. The “REFRESH” method must specify the “UID” +property of the poll to update. The “Organizer” responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 9 — Constraints for a METHOD:REFRESH of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+

ORGANIZER

+
+

1

+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+

COMPLETED

+
+

0

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

ACCEPT-RESPONSE

+
+

0

+
+

ATTACH

+
+

0

+
+

CATEGORIES

+
+

0

+
+

CLASS

+
+

0

+
+

CONTACT

+
+

0

+
+

CREATED

+
+

0

+
+

DESCRIPTION

+
+

0

+
+

DTEND

+
+

0

+
+

DTSTART

+
+

0

+
+

DURATION

+
+

0

+
+

GEO

+
+

0

+
+

LAST-MODIFIED

+
+

0

+
+

LOCATION

+
+

0

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0

+
+

RELATED-TO

+
+

0

+
+

REQUEST-STATUS

+
+

0

+
+

RESOURCES

+
+

0

+
+

SEQUENCE

+
+

0

+
+

STATUS

+
+

0

+
+

SUMMARY

+
+

0

+
+

URL

+
+

0

+
+

VALARM

+
+

0

+
+

VTIMEZONE

+
+

0+

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+

VTODO

+
+

0

+
+

VJOURNAL

+
+

0

+
+

VEVENT

+
+

0

+
+

VFREEBUSY

+
+

0

+
+

7.3.7.  Method: POLLSTATUS

The “POLLSTATUS” method in a “VPOLL” calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The “Organizer” MUST be present in the confirmed poll +component. All “Voters” MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+

Table 10 — Constraints for a METHOD:POLLSTATUS of a VPOLL

Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+

DTSTART

+
+

0 or 1

+
+

ORGANIZER

+
+

1

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+

ATTACH

+
+

0

+
+

CATEGORIES

+
+

0

+
+

CLASS

+
+

0

+
+

COMMENT

+
+

0+

+
+

CONTACT

+
+

0

+
+

CREATED

+
+

0 or 1

+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+

POLL-ITEM-ID

+
+

0

+
+

POLL-MODE

+
+

0 or 1

+
+

POLL-PROPERTIES

+
+

0

+
+

PRIORITY

+
+

0 or 1

+
+

RELATED-TO

+
+

0+

+
+

RESOURCES

+
+

0+

+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+

IANA-PROPERTY

+
+

0+

+
+

X-PROPERTY

+
+

0+

+
+

REQUEST-STATUS

+
+

0

+
+

VALARM

+
+

0+

+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+

X-COMPONENT

+
+

0+

+
+
+
+

8.  CalDAV Extensions

+

This specification extends RFC 4791 in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends RFC 6638 as it a VPOLL component is a +schedulable entity.

+

8.1.  Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+

8.1.1.  CALDAV:supported-vpoll-component-sets

Name

+

supported-vpoll-component-sets

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition Clause 8.2 being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

Definition

+
<!ELEMENT supported-vpoll-component-sets
     (supported-vpoll-component-set*) >

<!ELEMENT supported-vpoll-component-set (comp+)>

Figure 18

+ +
<C:supported-vpoll-component-sets
     xmlns:C="urn:ietf:params:xml:ns:caldav">

  <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
    <C:comp name="VFREEBUSY" />
    <C:comp name="VTODO" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VEVENT or VFREEBUSY -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
    <C:comp name="VFREEBUSY" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VEVENT -->
  <C:supported-vpoll-component-set>
    <C:comp name="VEVENT" />
  </C:supported-vpoll-component-set>

  <!-- VPOLLs with just VTODO -->
  <C:supported-vpoll-component-set>
    <C:comp name="VTODO" />
  </C:supported-vpoll-component-set>
</C:supported-vpoll-component-sets>

Figure 19

+
+

8.1.2.  CALDAV:vpoll-max-items

Name

+

vpoll-max-items

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+

Definition

+
<!ELEMENT vpoll-max-items (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 20

+ +
<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-items>

Figure 21

+
+

8.1.3.  CALDAV:vpoll-max-active

Name

+

vpoll-max-active

+

Namespace

+

urn:ietf:params:xml:ns:caldav

+

Purpose

+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition +Clause 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+

Definition

+
<!ELEMENT vpoll-max-active (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 22

+ +
<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-active>

Figure 23

+
+

8.1.4.  CALDAV:vpoll-max-voters

Name

+

+vpoll-max-voters +

+

Namespace

+

+urn:ietf:params:xml:ns:caldav +

+

Purpose

+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+

Conformance

+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +RFC 2518, Section 12.14.1).

+

Description

+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition Clause 8.2 +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+

Definition

+
<!ELEMENT vpoll-max-voters (#PCDATA)>
PCDATA value: a numeric value (integer greater than zero)

Figure 24

+ +
<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav"
>25</C:vpoll-max-voters>

Figure 25

+
+

8.1.5.  CalDAV:even-more-properties

+ +
+

8.1.6.  Extensions to CalDAV scheduling

This specification extends RFC 6638.

+

Each section of Appendix A “Scheduling Privileges Summary” is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+

8.2.  Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+

(CALDAV:supported-vpoll-component-sets)

+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+

(CALDAV:vpoll-max-items)

+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value Clause 8.1.2 +on the calendar collection where the resource will be stored;

+

(CALDAV:vpoll-max-active)

+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value +Clause 8.1.3 on the calendar collection where the resource will +be stored;

+

(CALDAV:vpoll-max-voters)

+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value Clause 8.1.4 on the +calendar collection where the resource will be stored;

+
+

8.3.  CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+

8.3.1.  Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+
>> Request <<

REPORT /cyrus/work/ HTTP/1.1
Host: cal.example.com
Depth: 1
Content-Type: application/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<C:calendar-query xmlns:D="DAV:"
              xmlns:C="urn:ietf:params:xml:ns:caldav">
  <D:prop>
    <D:getetag/>
    <C:calendar-data>
      <C:comp name="VCALENDAR">
        <C:prop name="VERSION"/>
        <C:comp name="VPOLL">
          <C:prop name="SUMMARY"/>
          <C:prop name="UID"/>
          <C:prop name="DTSTART"/>
          <C:prop name="DTEND"/>
          <C:prop name="DURATION"/>
        </C:comp>

      </C:comp>
    </C:calendar-data>
  </D:prop>
  <C:filter>
    <C:comp-filter name="VCALENDAR">
      <C:comp-filter name="VPOLL">
        <C:time-range start="20121204T000000Z"
                      end="20121205T000000Z"/>
      </C:comp-filter>
    </C:comp-filter>
  </C:filter>
</C:calendar-query>

>> Response <<

HTTP/1.1 207 Multi-Status
Date: Sat, 11 Nov 2012 09:32:12 GMT
Content-Type: application/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:"
           xmlns:C="urn:ietf:params:xml:ns:caldav">
  <D:response>
    <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href>
    <D:propstat>
      <D:prop>
        <D:getetag>"fffff-abcd2"</D:getetag>
        <C:calendar-data>BEGIN:VCALENDAR
VERSION:2.0
BEGIN:VPOLL
DTSTART;TZID=US/Eastern:20121202T120000
DURATION:PT4D
SUMMARY:Poll #2
UID:00959BC664CA650E933C892C@example.com
END:VPOLL
END:VCALENDAR
</C:calendar-data>
      </D:prop>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
  <D:response>
    <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href>
    <D:propstat>
      <D:prop>
        <D:getetag>"fffff-abcd3"</D:getetag>
        <C:calendar-data>BEGIN:VCALENDAR

VERSION:2.0
PRODID:-//Example Corp.//CalDAV Client//EN
BEGIN:VPOLL
DTSTART;TZID=US/Eastern:20121204T100000
DURATION:PT4D
SUMMARY:Poll #3
UID:DC6C50A017428C5216A2F1CD@example.com
END:VPOLL
END:VCALENDAR
</C:calendar-data>
      </D:prop>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
</D:multistatus>

Figure 26

+
+

8.4.  CalDAV time ranges

“CALDAV:time-range XML Element” in RFC 4791, Section 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends RFC 4791 to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

+
+-------------------------------------------------------------------+
| VPOLL has the DTSTART property?                                   |
|   +---------------------------------------------------------------+
|   |   VPOLL has the DURATION property?                            |
|   |   +-----------------------------------------------------------+
|   |   | VPOLL has the DTEND property?                             |
|   |   |   +-------------------------------------------------------+
|   |   |   | VPOLL has the COMPLETED property?                     |
|   |   |   |   +---------------------------------------------------+
|   |   |   |   | VPOLL has the CREATED property?                   |
|   |   |   |   |   +-----------------------------------------------+
|   |   |   |   |   | Condition to evaluate                         |
+---+---+---+---+---+-----------------------------------------------+
| Y | Y | N | * | * | (start  <= DTSTART+DURATION)  AND             |
|   |   |   |   |   | ((end   >  DTSTART)  OR                       |
|   |   |   |   |   |  (end   >= DTSTART+DURATION))                 |
+---+---+---+---+---+-----------------------------------------------+
| Y | N | Y | * | * | ((start <  DTEND)    OR  (start <= DTSTART))  |
|   |   |   |   |   | AND                                           |
|   |   |   |   |   | ((end   >  DTSTART)  OR  (end   >= DTEND))    |
+---+---+---+---+---+-----------------------------------------------+
| Y | N | N | * | * | (start  <= DTSTART)  AND (end >  DTSTART)     |
+---+---+---+---+---+-----------------------------------------------+
| N | N | Y | * | * | (start  <  DTEND)    AND (end >= DTEND)       |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | Y | Y | ((start <= CREATED)  OR  (start <= COMPLETED))|
|   |   |   |   |   | AND                                           |
|   |   |   |   |   | ((end   >= CREATED)  OR  (end   >= COMPLETED))|
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | Y | N | (start  <= COMPLETED) AND (end  >= COMPLETED) |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | N | Y | (end    >  CREATED)                           |
+---+---+---+---+---+-----------------------------------------------+
| N | N | N | N | N | TRUE                                          |
+---+---+---+---+---+-----------------------------------------------+

Figure 27

+
+
+
+

9.  Security Considerations

+

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See RFC 3986 for a +discussion of the security considerations relating to URIs.

+
+
+

10.  IANA Considerations

+

10.1.  Parameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in RFC 5545, Section 8.2.4:

+

Table 11

Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+Clause 5.4.1 +

+
+

STAY-INFORMED

+
+

Current

+
+

+Clause 5.4.2 +

+
+

10.2.  Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in RFC 5545, Section 8.2.3:

+

Table 12

PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+Clause 5.5.7 +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+Clause 5.5.3 +

+
+

POLL-MODE

+
+

Current

+
+

+Clause 5.5.4 +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+Clause 5.5.5 +

+
+

POLL-WINNER

+
+

Current

+
+

+Clause 5.5.6 +

+
+

RESPONSE

+
+

Current

+
+

+Clause 5.5.8 +

+
+

10.3.  POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+

Poll mode name

+

The name of the poll mode.

+

Purpose

+

The purpose of the poll mode. Give a short but clear +description.

+

Reference

+

A reference to the RFC in which the poll mode is defined

+
+

10.4.  POLL-MODE Registrations

This document defines the following registered poll modes.

+

Table 13

Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+
+
+
+

Appendix A
(informative)
Open issues

+

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven’t voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No — voter + has indicated now unable to attend — want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user’s isn’t the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can’t create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event — winning properties ONLY are merged in to the real event.

+

Need to write down what isn’t valid in a VPOLL
+ a. Can’t change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? — some iTip notes On confirm — send itip if appropriate (PUBLISH) +  — all non-participating — shared — feeds + Organizer can specify where result is? + Confirm can specify that itip is sent — ITIP / NONE — parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest
METHOD: REPLY
BEGIN:VPOLL
ORGANIZER:mailto:douglm@mysite.edu
BEGIN:PARTICIPANT
PARTICIPANT-TYPE: VOTER
CALENDAR-ADDRESS:mailto:eric@example.com
UID:sched01-1234567890
DTSTAMP:20120101T010000Z
SEQUENCE:0
SUMMARY:What to do this week
BEGIN:VFREEBUSY
.......
END:VFREEBUSY
END:PARTICIPANT
END:VPOLL
END:VCALENDAR
+

Figure A.1

+
+
+
+

Appendix B
(informative)
Change log

+
+
+

Calext V01: 2019-10-17 MD

+
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
+

Calext V00: 2019-05-17 MD

+
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
+

V03: 2014-10-28 MD

+
+
+
    +
  • +

    Add VVOTER and VOTE components.

    +
  • +
  • +

    Add RESPONSE property.

    +
  • +
  • +

    Remove RESPONSE parameter from VOTER.

    +
  • +
+
+
+

V03: 2014-05-12 MD

+
+
+
    +
  • +

    Add reply-url property and required parameter.

    +
  • +
  • +

    Fix ACCEPT-RESPONSE definition.

    +
  • +
+
+
+

V02: 2014-05-12 MD

+
+
+
    +
  • +

    Typos fixed, clarifications made.

    +
  • +
  • +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
  • +
  • +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
  • +
  • +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
  • +
  • +

    iTip: fix broken table cells

    +
  • +
  • +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
  • +
  • +

    Added Caldav scheduling section

    +
  • +
+
+
+

V01: 2013-08-07 MD

+
+
+
    +
  • +

    Removed method CONFIRM

    +
  • +
  • +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
  • +
  • +

    Added POLL-WINNER and verbiage

    +
  • +
  • +

    Added STATUS values

    +
  • +
  • +

    Added RELTYPE=POLL

    +
  • +
  • +

    Added supported-vpoll-component-sets

    +
  • +
  • +

    Added CalDAV related parameters to VOTER

    +
  • +
  • +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
  • +
+
+
+

Initial version: 2012-11-02 MD

+
+
+
+
+
+

Bibliography

+ +
+
+ + + + + + + + + + + + + diff --git a/sources/cc-51006.pdf b/sources/cc-51006.pdf new file mode 100644 index 0000000..5dbe849 Binary files /dev/null and b/sources/cc-51006.pdf differ diff --git a/sources/cc-51006.presentation.xml b/sources/cc-51006.presentation.xml new file mode 100644 index 0000000..c24b9f0 --- /dev/null +++ b/sources/cc-51006.presentation.xml @@ -0,0 +1,4916 @@ + + + +Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component +CC/CD 51006:2018 +51006 + +2018-11-19 + + + + +CalConnect + + + + + + +Eric York + + + + + + + +Cyrus Daboo + + + + + + + +Michael Douglass + + + + + + +CalConnect + + +1 + +2018-11-19 + +en + + +committee-draft + + +2018 + + +CalConnect + + + + +standard + +FREEBUSY + + + + + + +

© 2018 The Calendaring and Scheduling Consortium, Inc.

+
+
+ + + + + Warning for Drafts +

This document is not a CalConnect Standard. It is distributed for review and + comment, and is subject to change without notice and may not be referred to as + a Standard. Recipients of this draft are invited to submit, with their + comments, notification of any relevant patent rights of which they are aware + and to provide supporting documentation. +

+
+
+ + + + +

All rights reserved. Unless otherwise specified, no part of this + publication may be reproduced or utilized otherwise in any form or by any + means, electronic or mechanical, including photocopying, or posting on the + internet or an intranet, without prior written permission. Permission can + be requested from the address below.

+
+
+ + + +

The Calendaring and Scheduling Consortium, Inc.

+

4390 Chaffin Lane
+ McKinleyville
+ California 95519
+ United States of America
+
+ copyright@calconnect.org
+ www.calconnect.org +

+
+
+
+ +Abstract

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+

The Calendaring and Scheduling Consortium (“CalConnect”) is a global +non-profit organization with the aim to facilitate interoperability of +collaborative technologies and tools through open standards.

+

CalConnect works closely with international and regional partners, +of which the full list is available on our website +().

+

The procedures used to develop this document and those intended for its +further maintenance are described in the CalConnect Directives.

+

In particular the different approval criteria needed for the different +types of CalConnect documents should be noted. This document was drafted in +accordance with the editorial rules of the CalConnect Directives.

+

Attention is drawn to the possibility that some of the elements of this +document may be the subject of patent rights. CalConnect shall not be +held responsible for identifying any or all such patent rights. Details +of any patent rights identified during the development of the document +will be provided in the Introduction.

+

Any trade name used in this document is information given for the +convenience of users and does not constitute an endorsement.

+

This document was prepared by Technical Committee +FREEBUSY.

Introduction

The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement — up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+ + +Scope +

This document provides a mechanism in iCalendar for consensus scheduling.

+
+ +Terms and definitions

For the purposes of this document, + the following terms and definitions apply.

+ + + +consensus scheduling +

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+ +active Vpoll +

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+ +voter +

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+Simple Consensus Scheduling

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+The VPOLL Component: An Overview

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

The usual property.

+
+
ORGANIZER
+
+

The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
SUMMARY
+
+

The usual property. This optional but +recommended property provides the a short title to the poll.

+
+
DESCRIPTION
+
+

The usual property. This optional property +provides more details.

+
+
DTEND
+
+

The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
POLL-MODE
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value “BASIC” +meaning one event will be chosen from the alternatives.

+
+
POLL-COMPLETION
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is “SERVER-SUBMIT” which means the client chooses the winner +but the server will submit the winning choice.

+
+
POLL-PROPERTIES
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value “DTSTART, LOCATION” meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
PARTICIPANT
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to “VOTER”. The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
VOTE
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
VEVENT
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD:REQUEST +BEGIN:VPOLL +POLL-MODE:BASIC +POLL-COMPLETION:SERVER-SUBMIT +POLL-PROPERTIES:DTSTART,LOCATION +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T000000Z +SUMMARY:What to do this week +DTEND:20120101T000000Z +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +END PARTICIPANT +BEGIN: PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:mike@example.com +END PARTICIPANT +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+The VPOLL Alternative Choices: An Overview

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL.

+
+
POLL-ITEM-ID
+
+

This provides a unique reference to the sub-component +within the VPOLL. It’s value SHOULD be a small integer.

+
+
+VPOLL responses

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
DTSTAMP
+
+

The usual property.

+
+
SEQUENCE
+
+

The usual property. See below for SEQUENCE +behavior.

+
+
UID
+
+

Same as the request.

+
+
ORGANIZER
+
+

Same as the request.

+
+
SUMMARY
+
+

Same as the request.

+
+
PARTICIPANT
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
VOTE
+
+

One per item being voted on.

+
+
POLL-ITEM-ID
+
+

One inside each VOTE component to identify the choice.

+
+
RESPONSE
+
+

One inside each VOTE component to specify the vote.

+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
NOTE
+
+

This is poll-mode specific behavior?

+
+
+

REPLY VPOLL from Cyrus:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL updates

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: POLLSTATUS +BEGIN:VPOLL +ORGANIZER:mailto:mike@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T020000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:cyrus@example.com +BEGIN: VOTE +POLL-ITEM-ID:1 +RESPONSE:50 +COMMENT:Work on iTIP +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +COMMENT:Work on WebDAV +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +BEGIN:VOTE +POLL-ITEM-ID:1 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:2 +RESPONSE:100 +END:VOTE +BEGIN:VOTE +POLL-ITEM-ID:3 +RESPONSE:0 +END:VOTE +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+VPOLL Completion

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +“SUBMITTED”.

+

VPOLL confirmation:

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example//Example +METHOD: REQUEST +BEGIN:VPOLL +ORGANIZER:mailto:douglm@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T030000Z +COMPLETED:20120101T030000Z +POLL-COMPLETION:SERVER-SUBMIT +SEQUENCE:0 +SUMMARY:What to do this week +STATUS:CONFIRMED +POLL-WINNER:3 +BEGIN:VEVENT.......(with a poll-item-id=1) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=2) +END:VEVENT +BEGIN:VEVENT.......(with a poll-item-id=3) +END:VEVENT +END:VPOLL +END:VCALENDAR +
+Other Responses

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+iCalendar ExtensionsUpdated Participant Type Value

Participant type property values are defined in section 11.2.1. of +. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+partvalue /= "VOTER" + +
+
Description
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+Updated Relation Type Value

Relationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+reltypeparam /= "RELTYPE" "=" "POLL" +; Property value is a VPOLL uid + +
+
Description
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+Updated Status Value

Status property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values.

+
+
Format Definition
+
+

This property parameter is redefined by the following notation:

+
+
+statvalue /= statvalue-poll + ; Status values for "VPOLL". +statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + +
+
Description
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
+New Property ParametersRequired
+
Parameter name
+
+

REQUIRED

+
+
Purpose
+
+

To specify whether the associated property is required in +the current context.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+Stay-Informed
+
Parameter name
+
+

STAY-INFORMED

+
+
Purpose
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
Format Definition
+
+

This parameter is defined by the following notation:

+
+
+stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + +
+
Description
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+New PropertiesAccept-Response
+
Property name
+
+

ACCEPT-RESPONSE

+
+
Purpose
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + +acceptresponseparams = *(";" other-param) +
+Poll-Completion
+
Property name
+
+

POLL-COMPLETION

+
+
Purpose
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
Description
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
Format Definition
+
+

This property is defined by the following notation:

+
+
+poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + +pcparam = *(";" other-param) + +pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + +
+
Example
+
+

The following is an example of this property:

+
+
+POLL-COMPLETION: SERVER-SUBMIT +
+Poll-Item-Id
+
Property name
+
+

POLL-ITEM-ID

+
+
Purpose
+
+

This property is used in VPOLL child components as an +identifier.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
Description
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + +pollitemidparams = *( + (";" other-param) + ) +
+Poll-Mode
+
Property name
+
+

POLL-MODE

+
+
Purpose
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
Description
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + +pollmodeparams = *(";" other-param) +
+Poll-properties
+
Property name
+
+

POLL-PROPERTIES

+
+
Purpose
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
Property Parameters
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + +pollpropparams = *(";" other-param) +
+Poll-Winner
+
Property name
+
+

POLL-WINNER

+
+
Purpose
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
Value type
+
+

INTEGER

+
+
Property Parameters
+
+

Non-standard parameters can be specified on +this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + +pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed +
+Reply-URL
+
Property name
+
+

REPLY-URL

+
+
Purpose
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
Property Parameters
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
Conformance
+
+

This property MAY be specified in a VPOLL component.

+
+
Description
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + +reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) +
+Response
+
Property name
+
+

RESPONSE

+
+
Purpose
+
+

To specify a response vote.

+
+
Value type
+
+

INTEGER

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + +responseparams = *(";" other-param) + +
+
Description
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
    +
  • +

    0 — 39 A “NO vote”

    +
  • +
  • +

    40 — 79 A “MAYBE” vote

    +
  • +
  • +

    80 — 89 A “YES — but not preferred vote”

    +
  • +
  • +

    90-100 A “YES” vote.

    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
  • +
+
+
+New ComponentsVPOLL Component
+
Component name
+
+

VPOLL

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + +pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + +
+
Description
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting — both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+

If specified, the “DTSTART” property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+

If “DTSTART” is present “DURATION” MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+

“DTEND” MAY be specified with or without “DTSTART” and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+VOTE Component
+
Component name
+
+

VOTE

+
+
Purpose
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
Conformance
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
Format Definition
+
+

This property is defined by the following notation:

+
+
+votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + +voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + +
+
Description
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER — such as the respondees +availability.

+
+Poll Modes

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC.

+POLL-MODE:BASIC

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+Property restrictions

This poll mode has the following property requirements:

+
+
POLL-ITEM-ID
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
POLL-WINNER
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+Outcome reporting

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+iTIP Extensions

This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+

For many of the iTip processing rules the voters take the place of +attendees.

+Methods

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

No changes (yet)

+
+

REQUEST

+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+

REPLY

+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+

ADD

+
+

Not supported for VPOLL.

+
+

CANCEL

+
+

There MUST be a single VPOLL component with UID

+
+ +

matching that of the poll being cancelled.

+
+

REFRESH

+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+

COUNTER

+
+

Not supported for VPOLL.

+
+

DECLINECOUNTER

+
+

Not supported for VPOLL.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+ + + + + + + + + + + + + + + + + +
OriginatorMethods
+

Organizer

+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+

Voter

+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+Interoperability Models

Most of the standard iTip specification applies with respect to +organizer and voters.

+ +Delegation +

TBD

+
+ +Acting on Behalf of Other Calendar Users +

TBD

+
+ +Component Revisions +
    +
  • +

    Need to talk about what a change in SEQUENCE means

    +
  • +
  • +

    Sequence change forces a revote.

    +
  • +
  • +

    New voter — no sequence change

    +
  • +
  • +

    Add another poll set or change poll item ids or any change to a child

    +
  • +
  • +

    component — bump sequence

    +
  • +
+
+ +Message Sequencing +

TBD

+
+Application Protocol ElementsMethods for VPOLL Calendar Components

This section defines the property set restrictions for the method +types that are applicable to the “VPOLL” calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Presence ValueDescription
+

1

+
+

One instance MUST be present.

+
+

1+

+
+

At least one instance MUST be present.

+
+

0

+
+

Instances of this property MUST NOT be present.

+
+

0+

+
+

Multiple instances MAY be present.

+
+

0 or 1

+
+

Up to 1 instance of this property MAY be present.

+
+

The following summarizes the methods that are defined for the “VPOLL” +calendar component.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescription
+

PUBLISH

+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+

REQUEST

+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+

REPLY

+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+

CANCEL

+
+

Cancel a poll.

+
+

REFRESH

+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+

POLLSTATUS

+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+Method: PUBLISH

The “PUBLISH” method in a “VPOLL” calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The “Organizer” MUST be present in a +published iCalendar component. “Voters” MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The “Organizer” may subsequently update (with another +“PUBLISH” method) or cancel (with a “CANCEL” method) a previously +published “VPOLL” calendar component.

+
+
Note
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:PUBLISH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal PUBLISH.

+
+

VPOLL

+
+

1+

+
+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0 or 1

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

PARTICIPANT

+
+

0+

+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to “VOTER” — that is, no voters

+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+Method: REQUEST

The “REQUEST” method in a “VPOLL” component provides the following +scheduling functions:

+
    +
  • +

    Invite “Voters” to respond to the poll.

    +
  • +
  • +

    Change the items being voted upon.

    +
  • +
  • +

    Complete or confirm the poll.

    +
  • +
  • +

    Response to a “REFRESH” request.

    +
  • +
  • +

    Update the details of an existing vpoll.

    +
  • +
  • +

    Update the status of “Voters”.

    +
  • +
  • +

    Forward a “VPOLL” to another uninvited CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, delegate the role of +“Voter” to another CU.

    +
  • +
  • +

    For an existing “VPOLL” calendar component, change the role of +“Organizer” to another CU.

    +
  • +
+

The “Organizer” originates the “REQUEST”. The recipients of the +“REQUEST” method are the CUs voting in the poll, the “Voters”. +“Voters” use the “REPLY” method to convey votes to the “Organizer”.

+

The “UID” and “SEQUENCE” properties are used to distinguish the +various uses of the “REQUEST” method. If the “UID” property value in +the “REQUEST” is not found on the recipient’s calendar, then the +“REQUEST” is for a new “VPOLL” calendar component. If the “UID” +property value is found on the recipient’s calendar, then the +“REQUEST” is for an update, or a reconfirmation of the “VPOLL” +calendar component.

+

For the “REQUEST” method only a single iCalendar object is permitted.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REQUEST of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REQUEST.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1+

+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0 or 1

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0+

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+

VTODO

+
+

0+

+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+ +Rescheduling a poll +

The “REQUEST” method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a “REQUEST” method finds that the “UID” +property value already exists on the calendar but that the “SEQUENCE” +(or “DTSTAMP”) property value in the “REQUEST” method is greater than +the value for the existing poll, then the “REQUEST” method describes +a rescheduling of the poll.

+
+Updating or Reconfirmation of a Poll

The “REQUEST” method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a “REQUEST” method +finds that the “UID” property value already exists on the calendar +and that the “SEQUENCE” property value in the “REQUEST” is the same +as the value for the existing poll, then the “REQUEST” method

+

describes an update of the poll details, but not a rescheduling of +the POLL.

+

The update “REQUEST” method is the appropriate response to a +“REFRESH” method sent from a “Voter” to the “Organizer” of a poll.

+

The “Organizer” of a poll may also send unsolicited “REQUEST” +methods. The unsolicited “REQUEST” methods may be used to update the +details of the poll without rescheduling it, to update the “RESPONSE” +parameter of “Voters”, or to reconfirm the poll.

+ +Confirmation of a Poll +

The “REQUEST” method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+ +Closing a Poll +

The “REQUEST” method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+Delegating a Poll to Another CU

Some calendar and scheduling systems allow “Voters” to delegate the +vote to another “Calendar User”. iTIP supports this concept using the +following workflow. Any “Voter” may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original “Voter”, NOT in addition to the +“Voter”. The delegator MUST notify the “Organizer” of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a “REQUEST” +to another CU.

+

The “Delegator” of a poll forwards the existing “REQUEST” to the +“Delegate”. The “REQUEST” method MUST include a “Voter” property +with the calendar address of the “Delegate”. The “Delegator” MUST +also send a “REPLY” method to the “Organizer” with the “Delegator’s” +“Voter” property “DELEGATED-TO” parameter set to the calendar address +of the “Delegate”. Also, a new “Voter” property for the “Delegate” +MUST be included and must specify the calendar user address set in +the “DELEGATED-TO” parameter, as above.

+

In response to the request, the “Delegate” MUST send a “REPLY” method +to the “Organizer”, and optionally to the “Delegator”. The “REPLY”

+

method SHOULD include the “Voter” property with the “DELEGATED-FROM” +parameter value of the “Delegator’s” calendar address.

+

The “Delegator” may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +“Delegator” setting their “role” attribute to “NON-PARTICIPANT” in +the “REPLY” to the “Organizer”.

+ +Changing the Organizer +

The situation may arise where the “Organizer” of a “VPOLL” is no +longer able to perform the “Organizer” role and abdicates without +passing on the “Organizer” role to someone else. When this occurs, +the “Voters” of the “VPOLL” may use out-of-band mechanisms to +communicate the situation and agree upon a new “Organizer”. The new +“Organizer” should then send out a new “REQUEST” with a modified +version of the “VPOLL” in which the “SEQUENCE” number has been +incremented and the “ORGANIZER” property has been changed to the new +“Organizer”.

+
+ +Sending on Behalf of the Organizer +

There are a number of scenarios that support the need for a “Calendar +User” to act on behalf of the “Organizer” without explicit role +changing. This might be the case if the CU designated as “Organizer” +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the “SENT-BY” parameter, a “Calendar User” could +send an updated “VPOLL” “REQUEST”. In the case where one CU sends on +behalf of another CU, the “Voter” responses are still directed back +towards the CU designated as “Organizer”.

+
+Forwarding to an Uninvited CU

A “Voter” invited to a “VPOLL” calendar component may send the +“VPOLL” calendar component to another new CU not previously +associated with the “VPOLL” calendar component. The current “Voter” +participating in the “VPOLL” calendar component does this by +forwarding the original “REQUEST” method to the new CU. The new CU +can send a “REPLY” to the “Organizer” of the “VPOLL” calendar +component. The reply contains a “Voter” property for the new CU.

+

The “Organizer” ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a “REPLY” +from a new (uninvited) CU. If the “Organizer” does not want the new +CU to be part of the poll, the new “Voter” property is not added to +the “VPOLL” calendar component. The “Organizer” MAY send the CU a +“CANCEL” message to indicate that they will not be added to the poll.

+

If the “Organizer” decides to add the new CU, the new “Voter” +property is added to the “VPOLL” calendar component. Furthermore, +the “Organizer” is free to change any “Voter” property parameter from +the values supplied by the new CU to something the “Organizer” +considers appropriate. The “Organizer” SHOULD send the new CU a +“REQUEST” message to inform them that they have been added.

+

When forwarding a “REQUEST” to another CU, the forwarding “Voter” +MUST NOT make changes to the original message.

+ +Updating Voter Status +

The “Organizer” of an poll may also request updated status from one +or more “Voters”. The “Organizer” sends a “REQUEST” method to the +“Voter” and sets the “RSVP=TRUE” property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +“SEQUENCE” property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +“REQUEST” is that their “RSVP” property parameter indicates a request +for updated status. The recipient SHOULD respond with a “REPLY” +method indicating their current vote with respect to the “REQUEST”.

+
+Method: REPLY

The “REPLY” method in a “VPOLL” calendar component is used to respond +(e.g., accept or decline) to a “REQUEST” or to reply to a delegation +“REQUEST”. When used to provide a delegation response, the +“Delegator” SHOULD include the calendar address of the “Delegate” on +the “DELEGATED-TO” property parameter of the “Delegator’s” “CALENDAR-ADDRESS” +property. The “Delegate” SHOULD include the calendar address of the +“Delegator” on the “DELEGATED-FROM” property parameter of the +“Delegate’s” “CALENDAR-ADDRESS” property.

+

The “REPLY” method is also used when processing of a “REQUEST” fails. +Depending on the value of the “REQUEST-STATUS” property, no action +may have been performed.

+

The “Organizer” of a poll may receive the “REPLY” method from a CU +not in the original “REQUEST”. For example, a “REPLY” may be +received from a “Delegate” to a poll. In addition, the “REPLY” +method may be received from an unknown CU (a “Party Crasher”). This +uninvited “Voter” may be accepted, or the “Organizer” may cancel the +poll for the uninvited “Voter” by sending a “CANCEL” method to the +uninvited “Voter”.

+

A “Voter” MAY include a message to the “Organizer” using the +“COMMENT” property. For example, if the user indicates a low +interest and wants to let the “Organizer” know why, the reason can be +expressed in the “COMMENT” property value.

+

The “Organizer” may also receive a “REPLY” from one CU on behalf of +another. Like the scenario enumerated above for the “Organizer”, +“Voters” may have another CU respond on their behalf. This is done +using the “SENT-BY” parameter.

+

The optional properties listed in the table below (those listed as +“0+” or “0 or 1”) MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REPLY of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REPLY.

+
+

VPOLL

+
+

1+

+
+

All components MUST have the same

+
+ + +

UID.

+
+

PARTICIPANT

+
+

1

+
+

Identifies the Voter replying.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID of the original

+
+ + +

REQUEST.

+
+

SEQUENCE

+
+

0 or 1

+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0 or 1

+
+
+

ATTACH

+
+

0+

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

1+

+
+

One per item being voted on.

+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0 or 1

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0 or 1

+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+

VAVAILABILITY

+
+

0

+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+

VJOURNAL

+
+

0

+
+
+

VTODO

+
+

0

+
+
+Method: CANCEL

The “CANCEL” method in a “VPOLL” calendar component is used to send a +cancellation notice of an existing poll request to the affected +“Voters”. The message is sent by the “Organizer” of the poll.

+

The “Organizer” MUST send a “CANCEL” message to each “Voter” affected +by the cancellation. This can be done using a single “CANCEL” +message for all “Voters” or by using multiple messages with different +subsets of the affected “Voters” in each.

+

When a “VPOLL” is cancelled, the “SEQUENCE” property value MUST be +incremented as described in .

+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:CANCEL of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be CANCEL.

+
+

VPOLL

+
+

1+

+
+

All must have the same UID.

+
+

PARTICIPANT

+
+

0+

+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+

UID

+
+

1

+
+

MUST be the UID of the original REQUEST.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

SEQUENCE

+
+

1

+
+
+

ATTACH

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0 or 1

+
+
+

CATEGORIES

+
+

0+

+
+
+

CLASS

+
+

0 or 1

+
+
+

CONTACT

+
+

0+

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DTSTART

+
+

0 or 1

+
+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

GEO

+
+

0 or 1

+
+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

LOCATION

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+

SUMMARY

+
+

0 or 1

+
+
+

TRANSP

+
+

0 or 1

+
+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: REFRESH

The “REFRESH” method in a “VPOLL” calendar component is used by +“Voters” of an existing event to request an updated description from +the poll “Organizer”. The “REFRESH” method must specify the “UID” +property of the poll to update. The “Organizer” responds with the +latest description and version of the poll.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:REFRESH of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST be REFRESH.

+
+

VPOLL

+
+

1

+
+
+

PARTICIPANT

+
+

1

+
+

MUST identify the requester as a voter.

+
+

DTSTAMP

+
+

1

+
+
+

ORGANIZER

+
+

1

+
+
+

UID

+
+

1

+
+

MUST be the UID associated with original REQUEST.

+
+

COMMENT

+
+

0+

+
+
+

COMPLETED

+
+

0

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0

+
+
+

DESCRIPTION

+
+

0

+
+
+

DTEND

+
+

0

+
+
+

DTSTART

+
+

0

+
+
+

DURATION

+
+

0

+
+
+

GEO

+
+

0

+
+
+

LAST-MODIFIED

+
+

0

+
+
+

LOCATION

+
+

0

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0

+
+
+

RELATED-TO

+
+

0

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

RESOURCES

+
+

0

+
+
+

SEQUENCE

+
+

0

+
+
+

STATUS

+
+

0

+
+
+

SUMMARY

+
+

0

+
+
+

URL

+
+

0

+
+
+

VALARM

+
+

0

+
+
+

VTIMEZONE

+
+

0+

+
+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+

VTODO

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+
+

VEVENT

+
+

0

+
+
+

VFREEBUSY

+
+

0

+
+
+Method: POLLSTATUS

The “POLLSTATUS” method in a “VPOLL” calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The “Organizer” MUST be present in the confirmed poll +component. All “Voters” MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+

This method type is an iCalendar object that conforms to the +following property constraints:

+ +Constraints for a METHOD:POLLSTATUS of a VPOLL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component/PropertyPresenceComment
+

METHOD

+
+

1

+
+

MUST equal POLLSTATUS.

+
+

VPOLL

+
+

1+

+
+
+

PARTICIPANT

+
+

1+

+
+

The voters containing their current vote

+
+

COMPLETED

+
+

0 or 1

+
+

Only present for a completed poll

+
+

DTSTAMP

+
+

1

+
+
+

DTSTART

+
+

0 or 1

+
+
+

ORGANIZER

+
+

1

+
+
+

SUMMARY

+
+

1

+
+

Can be null.

+
+

UID

+
+

1

+
+
+

SEQUENCE

+
+

0 or 1

+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+

ACCEPT-RESPONSE

+
+

0

+
+
+

ATTACH

+
+

0

+
+
+

CATEGORIES

+
+

0

+
+
+

CLASS

+
+

0

+
+
+

COMMENT

+
+

0+

+
+
+

CONTACT

+
+

0

+
+
+

CREATED

+
+

0 or 1

+
+
+

DESCRIPTION

+
+

0 or 1

+
+

Can be null.

+
+

DTEND

+
+

0 or 1

+
+

If present, DURATION MUST NOT be present.

+
+

DURATION

+
+

0 or 1

+
+

If present, DTEND MUST NOT be present.

+
+

LAST-MODIFIED

+
+

0 or 1

+
+
+

POLL-ITEM-ID

+
+

0

+
+
+

POLL-MODE

+
+

0 or 1

+
+
+

POLL-PROPERTIES

+
+

0

+
+
+

PRIORITY

+
+

0 or 1

+
+
+

RELATED-TO

+
+

0+

+
+
+

RESOURCES

+
+

0+

+
+
+

STATUS

+
+

0 or 1

+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+

URL

+
+

0 or 1

+
+
+

IANA-PROPERTY

+
+

0+

+
+
+

X-PROPERTY

+
+

0+

+
+
+

REQUEST-STATUS

+
+

0

+
+
+

VALARM

+
+

0+

+
+
+

VEVENT

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VFREEBUSY

+
+

0

+
+
+

VJOURNAL

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTODO

+
+

0

+
+

All candidate components SHOULD NOT be present.

+
+

VTIMEZONE

+
+

0+

+
+

MUST be present if any date/time refers to a timezone.

+
+

IANA-COMPONENT

+
+

0+

+
+
+

X-COMPONENT

+
+

0+

+
+
+CalDAV Extensions

This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+

Additionally, it extends as it a VPOLL component is a +schedulable entity.

+Calendar Collection Properties

This section defines new CalDAV properties for calendar collections.

+CALDAV:supported-vpoll-component-sets
+
Name
+
+

supported-vpoll-component-sets

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

It also specifies the combination of allowed component types.

+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
Definition
+
+
+<!ELEMENT supported-vpoll-component-sets + (supported-vpoll-component-set*) > + +<!ELEMENT supported-vpoll-component-set (comp+)> + +<C:supported-vpoll-component-sets + xmlns:C="urn:ietf:params:xml:ns:caldav"> + + <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT or VFREEBUSY --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> +</C:supported-vpoll-component-sets> +
+CALDAV:vpoll-max-items
+
Name
+
+

vpoll-max-items

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-items (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-items> +
+CALDAV:vpoll-max-active
+
Name
+
+

vpoll-max-active

+
+
Namespace
+
+

urn:ietf:params:xml:ns:caldav

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-active (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-active> +
+CALDAV:vpoll-max-voters
+
Name
+
+

+vpoll-max-voters +

+
+
Namespace
+
+

+urn:ietf:params:xml:ns:caldav +

+
+
Purpose
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
Conformance
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +12.14.1).

+
+
Description
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
Definition
+
+
+<!ELEMENT vpoll-max-voters (#PCDATA)> +PCDATA value: a numeric value (integer greater than zero) + +<C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav" +>25</C:vpoll-max-voters> +
+ +CalDAV:even-more-properties + +Extensions to CalDAV scheduling

This specification extends .

+

Each section of Appendix A “Scheduling Privileges Summary” is +extended to include VPOLL.

+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+Additional Preconditions for PUT, COPY, and MOVE

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+

The new preconditions are:

+
+
(CALDAV:supported-vpoll-component-sets)
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
(CALDAV:vpoll-max-items)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored;

+
+
(CALDAV:vpoll-max-active)
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored;

+
+
(CALDAV:vpoll-max-voters)
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored;

+
+
+CalDAV:calendar-query Report

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+Example: Partial Retrieval of VPOLL

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+>> Request << + +REPORT /cyrus/work/ HTTP/1.1 +Host: cal.example.com +Depth: 1 +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<C:calendar-query xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:prop> + <D:getetag/> + <C:calendar-data> + <C:comp name="VCALENDAR"> + <C:prop name="VERSION"/> + <C:comp name="VPOLL"> + <C:prop name="SUMMARY"/> + <C:prop name="UID"/> + <C:prop name="DTSTART"/> + <C:prop name="DTEND"/> + <C:prop name="DURATION"/> + </C:comp> + + </C:comp> + </C:calendar-data> + </D:prop> + <C:filter> + <C:comp-filter name="VCALENDAR"> + <C:comp-filter name="VPOLL"> + <C:time-range start="20121204T000000Z" + end="20121205T000000Z"/> + </C:comp-filter> + </C:comp-filter> + </C:filter> +</C:calendar-query> + +>> Response << + +HTTP/1.1 207 Multi-Status +Date: Sat, 11 Nov 2012 09:32:12 GMT +Content-Type: application/xml; charset="utf-8" +Content-Length: xxxx + +<?xml version="1.0" encoding="utf-8" ?> +<D:multistatus xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd2"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR +VERSION:2.0 +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121202T120000 +DURATION:PT4D +SUMMARY:Poll #2 +UID:00959BC664CA650E933C892C@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd3"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VPOLL +DTSTART;TZID=US/Eastern:20121204T100000 +DURATION:PT4D +SUMMARY:Poll #3 +UID:DC6C50A017428C5216A2F1CD@example.com +END:VPOLL +END:VCALENDAR +</C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> +</D:multistatus> +
+CalDAV time ranges

“CALDAV:time-range XML Element” in 9.9 describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL

+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

++-------------------------------------------------------------------+ +| VPOLL has the DTSTART property? | +| +---------------------------------------------------------------+ +| | VPOLL has the DURATION property? | +| | +-----------------------------------------------------------+ +| | | VPOLL has the DTEND property? | +| | | +-------------------------------------------------------+ +| | | | VPOLL has the COMPLETED property? | +| | | | +---------------------------------------------------+ +| | | | | VPOLL has the CREATED property? | +| | | | | +-----------------------------------------------+ +| | | | | | Condition to evaluate | ++---+---+---+---+---+-----------------------------------------------+ +| Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | +| | | | | | ((end > DTSTART) OR | +| | | | | | (end >= DTSTART+DURATION)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | +| | | | | | AND | +| | | | | | ((end > DTSTART) OR (end >= DTEND)) | ++---+---+---+---+---+-----------------------------------------------+ +| Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| +| | | | | | AND | +| | | | | | ((end >= CREATED) OR (end >= COMPLETED))| ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | Y | (end > CREATED) | ++---+---+---+---+---+-----------------------------------------------+ +| N | N | N | N | N | TRUE | ++---+---+---+---+---+-----------------------------------------------+ +
+ +Security Considerations +

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs.

+
+IANA ConsiderationsParameter Registrations

This document defines the following new iCalendar property parameters +to be added to the registry defined in 8.2.4:

+ + + + + + + + + + + + + + + + + + + + +
Property ParameterStatusReference
+

REQUIRED

+
+

Current

+
+

+ +

+
+

STAY-INFORMED

+
+

Current

+
+

+ +

+
+Property Registrations

This document defines the following new iCalendar properties to be +added to the registry defined in 8.2.3:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyStatusReference
+

ACCEPT-RESPONSE

+
+

Current

+
+

+ +

+
+

POLL-ITEM-ID

+
+

Current

+
+

+ +

+
+

POLL-MODE

+
+

Current

+
+

+ +

+
+

POLL-PROPERTIES

+
+

Current

+
+

+ +

+
+

POLL-WINNER

+
+

Current

+
+

+ +

+
+

RESPONSE

+
+

Current

+
+

+ +

+
+POLL-MODE Registration Template

A poll mode is defined by completing the following template.

+
+
Poll mode name
+
+

The name of the poll mode.

+
+
Purpose
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
Reference
+
+

A reference to the RFC in which the poll mode is defined

+
+
+POLL-MODE Registrations

This document defines the following registered poll modes.

+ + + + + + + + + + + + + + + +
Poll mode namePurposeReference
+

BASIC

+
+

To provide simple voting for a single outcome from a number of candidates.

+
+

Current

+
+ + +
Open issues

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+

Notifications: Need to do a section on what Notifications to + support.
+ A. VPOLL is about to end and you haven’t voted on it yet. + Instead reuse VALARMS to notify the user?

+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No — voter + has indicated now unable to attend — want to revote

+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user’s isn’t the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can’t create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+

Update to existing event after poll confirm When voting on existing + event — winning properties ONLY are merged in to the real event.

+

Need to write down what isn’t valid in a VPOLL
+ a. Can’t change POLL-MODE

+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+

? — some iTip notes On confirm — send itip if appropriate (PUBLISH) +  — all non-participating — shared — feeds + Organizer can specify where result is? + Confirm can specify that itip is sent — ITIP / NONE — parameter ? + on POLL-WINNER

+

Need to add example of freebusy in response

+BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest +METHOD: REPLY +BEGIN:VPOLL +ORGANIZER:mailto:douglm@mysite.edu +BEGIN:PARTICIPANT +PARTICIPANT-TYPE: VOTER +CALENDAR-ADDRESS:mailto:eric@example.com +UID:sched01-1234567890 +DTSTAMP:20120101T010000Z +SEQUENCE:0 +SUMMARY:What to do this week +BEGIN:VFREEBUSY +....... +END:VFREEBUSY +END:PARTICIPANT +END:VPOLL +END:VCALENDAR +
+Change log +
+
Calext V01: 2019-10-17 MD
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
Calext V00: 2019-05-17 MD
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
V03: 2014-10-28 MD
+
+
    +
  • +

    Add VVOTER and VOTE components.

    +
  • +
  • +

    Add RESPONSE property.

    +
  • +
  • +

    Remove RESPONSE parameter from VOTER.

    +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +

    Add reply-url property and required parameter.

    +
  • +
  • +

    Fix ACCEPT-RESPONSE definition.

    +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +

    Typos fixed, clarifications made.

    +
  • +
  • +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
  • +
  • +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
  • +
  • +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
  • +
  • +

    iTip: fix broken table cells

    +
  • +
  • +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
  • +
  • +

    Added Caldav scheduling section

    +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +

    Removed method CONFIRM

    +
  • +
  • +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
  • +
  • +

    Added POLL-WINNER and verbiage

    +
  • +
  • +

    Added STATUS values

    +
  • +
  • +

    Added RELTYPE=POLL

    +
  • +
  • +

    Added supported-vpoll-component-sets

    +
  • +
  • +

    Added CalDAV related parameters to VOTER

    +
  • +
  • +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
Normative References

The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

2020-07-16 HTTP Extensions for Distributed Authoring — WEBDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2518.xml https://www.rfc-editor.org/info/rfc2518 RFC 2518 RFC2518 10.17487/RFC2518 1999-02 Y. Goland Internet Engineering Task Force IETF E. Whitehead Internet Engineering Task Force IETF A. Faizi Internet Engineering Task Force IETF S. Carter Internet Engineering Task Force IETF D. Jensen Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] RFC 2518 Fremont, CA 2020-07-16 Uniform Resource Identifier (URI): Generic Syntax https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.3986.xml https://www.rfc-editor.org/info/rfc3986 RFC 3986 RFC3986 10.17487/RFC3986 2005-01 T. Berners-Lee Internet Engineering Task Force IETF R. Fielding Internet Engineering Task Force IETF L. Masinter Internet Engineering Task Force IETF Internet Engineering Task Force IETF en A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] STD 66 RFC 3986 Fremont, CA 2020-07-16 Calendaring Extensions to WebDAV (CalDAV) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.4791.xml https://www.rfc-editor.org/info/rfc4791 RFC 4791 RFC4791 10.17487/RFC4791 2007-03 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF L. Dusseault Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the “calendar-access” feature of CalDAV. [STANDARDS-TRACK] RFC 4791 Fremont, CA 2020-07-16 Internet Calendaring and Scheduling Core Object Specification (iCalendar) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5545.xml https://www.rfc-editor.org/info/rfc5545 RFC 5545 RFC5545 10.17487/RFC5545 2009-09 B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] RFC 5545 Fremont, CA 2020-07-16 iCalendar Transport-Independent Interoperability Protocol (iTIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.5546.xml https://www.rfc-editor.org/info/rfc5546 RFC 5546 RFC5546 10.17487/RFC5546 2009-12 C. Daboo Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] RFC 5546 Fremont, CA 2020-07-16 iCalendar Message-Based Interoperability Protocol (iMIP) https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6047.xml https://www.rfc-editor.org/info/rfc6047 RFC 6047 RFC6047 10.17487/RFC6047 2010-12 A. Melnikov Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document, “iCalendar Message-Based Interoperability Protocol (iMIP)”, specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] RFC 6047 Fremont, CA 2020-07-16 Scheduling Extensions to CalDAV https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6638.xml https://www.rfc-editor.org/info/rfc6638 RFC 6638 RFC6638 10.17487/RFC6638 2012-06 C. Daboo Internet Engineering Task Force IETF B. Desruisseaux Internet Engineering Task Force IETF Internet Engineering Task Force IETF en This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) “calendar-access” feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the “calendar-auto-schedule” feature of CalDAV. [STANDARDS-TRACK] RFC 6638 Fremont, CAAUTOFILLIETF I-D.draft-ietf-calext-eventpub-extensions
+Bibliography +
+
diff --git a/sources/cc-51006.rxl b/sources/cc-51006.rxl new file mode 100644 index 0000000..5bc1c99 --- /dev/null +++ b/sources/cc-51006.rxl @@ -0,0 +1,67 @@ + +Calendaring and scheduling — Consensus scheduling — iCalendar VPOLL component +CC/CD 51006:2018 +51006 + +2018-11-19 + + + + +CalConnect + + + + + + +Eric York + + + + + + + +Cyrus Daboo + + + + + + + +Michael Douglass + + + + + + +CalConnect + + +1 + +2018-11-19 + +en + + +committee-draft + + +2018 + + +CalConnect + + + + +standard + +FREEBUSY + + + \ No newline at end of file diff --git a/sources/draft-ietf-calext-vpoll.html b/sources/draft-ietf-calext-vpoll.html new file mode 100644 index 0000000..59e849f --- /dev/null +++ b/sources/draft-ietf-calext-vpoll.html @@ -0,0 +1,9150 @@ + + + + + + +VPOLL: Consensus Scheduling Component for iCalendar + + + + + + + + + + + + + + + + + + + + + + + + +
Internet-DraftVPOLLJuly 2020
York, et al.Expires 17 January 2021[Page]
+
+
+
+
Workgroup:
+
Network Working Group
+
Internet-Draft:
+
draft-ietf-calext-vpoll-00
+
:
+
+
Published:
+
+ +
+
Intended Status:
+
Standards Track
+
Expires:
+
+
Authors:
+
+
+
E. York
+
+
+
C. Daboo
+
+
+
M. Douglass
+
+
+
+
+

VPOLL: Consensus Scheduling Component for iCalendar

+
+
+

Abstract

+
+

This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives.

+
+
+
+
+
+

+Status of This Memo +

+

+ This Internet-Draft is submitted in full conformance with the + provisions of BCP 78 and BCP 79.

+

+ Internet-Drafts are working documents of the Internet Engineering Task + Force (IETF). Note that other groups may also distribute working + documents as Internet-Drafts. The list of current Internet-Drafts is + at https://datatracker.ietf.org/drafts/current/.

+

+ Internet-Drafts are draft documents valid for a maximum of six months + and may be updated, replaced, or obsoleted by other documents at any + time. It is inappropriate to use Internet-Drafts as reference + material or to cite them other than as "work in progress."

+

+ This Internet-Draft will expire on 17 January 2021.

+
+
+ +
+
+

+Table of Contents +

+ +
+
+
+
+

+1. Acknowledgements +

+
+

The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support.

+
+
+
+
+
+

+2. Introduction +

+
+

The currently existing approach to agreeing on meeting times using +iTip [RFC5546] and/or iMip [RFC6047] has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing.

+
+
+

Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities.

+
+
+

A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time.

+
+
+

Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice.

+
+
+

The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact.

+
+
+

These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process.

+
+
+
+
+
+

+3. Terms and definitions +

+
+

For the purposes of this document, + the following terms and definitions apply.

+
+
+
+

+3.1. consensus scheduling +

+
+

The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task.

+
+
+
+
+
+

+3.2. active Vpoll +

+
+

A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period

+
+
+
+
+
+

+3.3. voter +

+
+

A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented.

+
+
+
+
+
+
+
+

+4. Simple Consensus Scheduling +

+
+

This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees.

+
+
+

This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives.

+
+
+
+

+4.1. The VPOLL Component: An Overview +

+
+

The VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate:

+
+
+
+
DTSTAMP
+
+
+

The usual [RFC5545] property.

+
+
+
+
SEQUENCE
+
+
+

The usual [RFC5545] property. See below for SEQUENCE +behavior.

+
+
+
+
UID
+
+
+

The usual [RFC5545] property.

+
+
+
+
ORGANIZER
+
+
+

The usual [RFC5545] property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same.

+
+
+
+
SUMMARY
+
+
+

The usual [RFC5545] property. This optional but +recommended property provides the a short title to the poll.

+
+
+
+
DESCRIPTION
+
+
+

The usual [RFC5545] property. This optional property +provides more details.

+
+
+
+
DTEND
+
+
+

The usual [RFC5545] property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active.

+
+
+
+
POLL-MODE
+
+
+

A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives.

+
+
+
+
POLL-COMPLETION
+
+
+

A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice.

+
+
+
+
POLL-PROPERTIES
+
+
+

A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process.

+
+
+
+
PARTICIPANT
+
+
+

There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on.

+
+
+
+
VOTE
+
+
+

A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration.

+
+
+
+
VEVENT
+
+
+

In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting.

+
+
+
+
+
+
+

EXAMPLE

+
+
+

VPOLL with 3 voters and 3 alternative meetings:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD:REQUEST
+BEGIN:VPOLL
+POLL-MODE:BASIC
+POLL-COMPLETION:SERVER-SUBMIT
+POLL-PROPERTIES:DTSTART,LOCATION
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T000000Z
+SUMMARY:What to do this week
+DTEND:20120101T000000Z
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+END PARTICIPANT
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+END PARTICIPANT
+BEGIN: PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:mike@example.com
+END PARTICIPANT
+BEGIN:VEVENT.......(with a poll-item-id=1)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=2)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=3)
+END:VEVENT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 1
+
+
+

As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.

+
+
+
+
+
+

+4.2. The VPOLL Alternative Choices: An Overview +

+
+

Within the VPOLL component we have the alternatives to vote on. In +many respects these are standard [RFC5545] components. For our +simple use case they are all VEVENT components. In addition to the +usual [RFC5545] properties some extra properties are used for a +VPOLL.

+
+
+
+
POLL-ITEM-ID
+
+
+

This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer.

+
+
+
+
+
+
+
+
+
+

+4.3. VPOLL responses +

+
+

Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components:

+
+
+
+
DTSTAMP
+
+
+

The usual [RFC5545] property.

+
+
+
+
SEQUENCE
+
+
+

The usual [RFC5545] property. See below for SEQUENCE +behavior.

+
+
+
+
UID
+
+
+

Same as the request.

+
+
+
+
ORGANIZER
+
+
+

Same as the request.

+
+
+
+
SUMMARY
+
+
+

Same as the request.

+
+
+
+
PARTICIPANT
+
+
+

One only with a CALENDAR-ADDRESS identifying the voter replying.

+
+
+
+
VOTE
+
+
+

One per item being voted on.

+
+
+
+
POLL-ITEM-ID
+
+
+

One inside each VOTE component to identify the choice.

+
+
+
+
RESPONSE
+
+
+

One inside each VOTE component to specify the vote.

+
+
+
+
+
+
+

Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3.

+
+
+
+
NOTE
+
+
+

This is poll-mode specific behavior?

+
+
+
+
+
+
+

EXAMPLE

+
+
+

REPLY VPOLL from Cyrus:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: REPLY
+BEGIN:VPOLL
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T010000Z
+SUMMARY:What to do this week
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+BEGIN:VOTE
+POLL-ITEM-ID:1
+RESPONSE:50
+COMMENT:Work on iTIP
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+COMMENT:Work on WebDAV
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 2
+
+
+
+
+
+

+4.4. VPOLL updates +

+
+

When the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components.

+
+
+

EXAMPLE

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: POLLSTATUS
+BEGIN:VPOLL
+ORGANIZER:mailto:mike@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T020000Z
+SEQUENCE:0
+SUMMARY:What to do this week
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:cyrus@example.com
+BEGIN: VOTE
+POLL-ITEM-ID:1
+RESPONSE:50
+COMMENT:Work on iTIP
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+COMMENT:Work on WebDAV
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+BEGIN:VOTE
+POLL-ITEM-ID:1
+RESPONSE:100
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:2
+RESPONSE:100
+END:VOTE
+BEGIN:VOTE
+POLL-ITEM-ID:3
+RESPONSE:0
+END:VOTE
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 3
+
+
+
+
+
+

+4.5. VPOLL Completion +

+
+

After a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED.

+
+
+

The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED".

+
+
+

EXAMPLE

+
+
+

VPOLL confirmation:

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Example//Example
+METHOD: REQUEST
+BEGIN:VPOLL
+ORGANIZER:mailto:douglm@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T030000Z
+COMPLETED:20120101T030000Z
+POLL-COMPLETION:SERVER-SUBMIT
+SEQUENCE:0
+SUMMARY:What to do this week
+STATUS:CONFIRMED
+POLL-WINNER:3
+BEGIN:VEVENT.......(with a poll-item-id=1)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=2)
+END:VEVENT
+BEGIN:VEVENT.......(with a poll-item-id=3)
+END:VEVENT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 4
+
+
+
+
+
+

+4.6. Other Responses +

+
+

A voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care.

+
+
+

An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices.

+
+
+

This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.

+
+
+
+
+
+
+
+

+5. iCalendar Extensions +

+
+
+

+5.1. Updated Participant Type Value +

+
+

Participant type property values are defined in section 11.2.1. of +[I-D.draft-ietf-calext-eventpub-extensions]. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
partvalue       /= "VOTER"
+
+
Figure 5
+
+
+
+
Description
+
+
+

The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL.

+
+
+
+
+
+
+
+
+
+

+5.2. Updated Relation Type Value +

+
+

Relationship parameter type values are defined in section 3.2.15. of +[RFC5545]. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
reltypeparam       /= "RELTYPE" "=" "POLL"
+; Property value is a VPOLL uid
+
+
Figure 6
+
+
+
+
Description
+
+
+

This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component.

+
+
+
+
+
+
+
+
+
+

+5.3. Updated Status Value +

+
+

Status property values are defined in section 3.8.1.11. of [RFC5545]. +This specification updates that type to define valid VPOLL status +values.

+
+
+
+
Format Definition
+
+
+

This property parameter is redefined by the following notation:

+
+
+
+
+
+
+
+
+
statvalue /= statvalue-poll
+   ; Status values for "VPOLL".
+statvalue-poll = "IN-PROCESS"
+          / "COMPLETED"  ; Poll has closed,
+                         ; nothing has been chosen yet
+          / "CONFIRMED"  ; Poll has closed and
+                         ; winning items confirmed
+          / "SUBMITTED"  ; The winning item has been
+                         ; submitted
+          / "CANCELLED"
+
+
Figure 7
+
+
+
+
Description
+
+
+

These values allow clients and servers to handle the +choosing and submission of winning choices.

+
+
+
+
+
+
If the client is choosing and the server submitting then the
+client should set the POLL-WINNER property, set the status to
+CONFIRMED and save the poll.  When the server submits the winning
+choice it will set the status to SUBMITTED.
+
+
+
Figure 8
+
+
+
+
+
+
+
+
+
+

+5.4. New Property Parameters +

+
+
+

+5.4.1. Required +

+
+
+
Parameter name
+
+
+

REQUIRED

+
+
+
+
Purpose
+
+
+

To specify whether the associated property is required in +the current context.

+
+
+
+
Format Definition
+
+
+

This parameter is defined by the following notation:

+
+
+
+
+
+
+
+
+
requirededparam = "REQUIRED"  "=" ("TRUE" / "FALSE")
+  ; Default is FALSE
+
+
Figure 9
+
+
+
+
Description
+
+
+

This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies.

+
+
+
+
+
+
+
+
+
+

+5.4.2. Stay-Informed +

+
+
+
Parameter name
+
+
+

STAY-INFORMED

+
+
+
+
Purpose
+
+
+

To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed.

+
+
+
+
Format Definition
+
+
+

This parameter is defined by the following notation:

+
+
+
+
+
+
+
+
+
stayinformedparam = "STAY-INFORMED"  "=" ("TRUE" / "FALSE")
+                  ; Default is FALSE
+
+
Figure 10
+
+
+
+
Description
+
+
+

This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant.

+
+
+
+
+
+
+
+
+
+
+
+

+5.5. New Properties +

+
+
+

+5.5.1. Accept-Response +

+
+
+
Property name
+
+
+

ACCEPT-RESPONSE

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate the types of +component that may be supplied in a response.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives.

+
+
+

If this property is not present voters are only allowed to respond +to the choices in the request.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":"
+                    iana-token ("," iana-token) CRLF
+
+acceptresponseparams = *(";" other-param)
+
+
Figure 11
+
+
+
+
+
+

+5.5.2. Poll-Completion +

+
+
+
Property name
+
+
+

POLL-COMPLETION

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s).

+
+
+
+
Description
+
+
+

When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.

+
+
+

For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action.

+
+
+

Server initiated submission requires that the submitted choice +MUST be a valid calendaring component.

+
+
+

POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF
+
+pcparam = *(";" other-param)
+
+pcvalue = "SERVER"  ; The server is responsible for both choosing and
+                   ; submitting the winner(s)
+        / "SERVER-SUBMIT" ; The server is responsible for
+                   ; submitting the winner(s). The client chooses.
+        / "SERVER-CHOICE"  ; The server is responsible for
+                   ; choosing the winner(s). The client will submit.
+        / "CLIENT" ; The client is responsible for both choosing and
+                   ; submitting the winner(s)
+        / iana-token
+        / x-name
+        ;Default is CLIENT
+
+
Figure 12
+
+
+
+
Example
+
+
+

The following is an example of this property:

+
+
+
+
+
+
+
+
+
POLL-COMPLETION: SERVER-SUBMIT
+
+
Figure 13
+
+
+
+
+
+

+5.5.3. Poll-Item-Id +

+
+
+
Property name
+
+
+

POLL-ITEM-ID

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL child components as an +identifier.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Property Parameters
+
+
+

Non-standard parameters can be specified on +this property.

+
+
+
+
Conformance
+
+
+

This property MUST be specified in a VOTE component and +in VPOLL choice items.

+
+
+
+
Description
+
+
+

In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on.

+
+
+

POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollitemid = "POLL-ITEM-ID" pollitemdparams ":"
+                  integer CRLF
+
+pollitemidparams = *(
+                   (";" other-param)
+            )
+
+
Figure 14
+
+
+
+
+
+

+5.5.4. Poll-Mode +

+
+
+
Property name
+
+
+

POLL-MODE

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to indicate what voting mode +is to be applied.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component or +its sub-components.

+
+
+
+
Description
+
+
+

The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID.

+
+
+

Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollmode = "POLL-MODE" pollmodeparams ":"
+             ("BASIC" / iana-token / other-token) CRLF
+
+pollmodeparams = *(";" other-param)
+
+
Figure 15
+
+
+
+
+
+

+5.5.5. Poll-properties +

+
+
+
Property name
+
+
+

POLL-PROPERTIES

+
+
+
+
Purpose
+
+
+

This property is used in VPOLL to define which icalendar +properties are being voted on.

+
+
+
+
Property Parameters
+
+
+

Non-standard or iana parameters can be +specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollproperties = "POLL-PROPERTIES" pollpropparams ":"
+             text *("," text) CRLF
+
+pollpropparams = *(";" other-param)
+
+
Figure 16
+
+
+
+
+
+

+5.5.6. Poll-Winner +

+
+
+
Property name
+
+
+

POLL-WINNER

+
+
+
+
Purpose
+
+
+

This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Property Parameters
+
+
+

Non-standard parameters can be specified on +this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollwinner = "POLL-WINNER" pollwinnerparams ":"
+                 integer CRLF
+
+pollwinnerparams = *(";" other-param)
+
+       ; Used with a STATUS:CONFIRMED VPOLL to indicate which
+       ; components have been confirmed
+
+
Figure 17
+
+
+
+
+
+

+5.5.7. Reply-URL +

+
+
+
Property name
+
+
+

REPLY-URL

+
+
+
+
Purpose
+
+
+

This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service.

+
+
+
+
Property Parameters
+
+
+

Non-standard, required or iana parameters can +be specified on this property.

+
+
+
+
Conformance
+
+
+

This property MAY be specified in a VPOLL component.

+
+
+
+
Description
+
+
+

When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF
+
+reply-urlparams = *(
+                  (";" requiredparam) /
+                  (";" other-param)
+                  )
+
+
Figure 18
+
+
+
+
+
+

+5.5.8. Response +

+
+
+
Property name
+
+
+

RESPONSE

+
+
+
+
Purpose
+
+
+

To specify a response vote.

+
+
+
+
Value type
+
+
+

INTEGER

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
response = "RESPONSE" response-params ":" integer CRLF
+                 ; integer value 0..100
+
+responseparams = *(";" other-param)
+
+
Figure 19
+
+
+
+
Description
+
+
+

This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention:

+
+
    +
  • +
    +

    0 - 39 A "NO vote"

    +
    +
  • +
  • +
    +

    40 - 79 A "MAYBE" vote

    +
    +
  • +
  • +
    +

    80 - 89 A "YES - but not preferred vote"

    +
    +
  • +
  • +
    +

    90-100 A "YES" vote.

    +
    +
    +

    Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe).

    +
    +
  • +
+
+
+
+
+
+
+
+
+
+
+

+5.6. New Components +

+
+
+

+5.6.1. VPOLL Component +

+
+
+
Component name
+
+
+

VPOLL

+
+
+
+
Purpose
+
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
pollc    = "BEGIN" ":" "VPOLL" CRLF
+            pollprop
+            *participantc *eventc *todoc *journalc *freebusyc
+            *availabilityc *alarmc *iana-comp *x-comp
+            "END" ":" "VPOLL" CRLF
+
+pollprop = *(
+          ;
+          ; The following are REQUIRED,
+          ; but MUST NOT occur more than once.
+          ;
+          dtstamp / uid / organizer /
+          ;
+          ; The following are OPTIONAL,
+          ; but MUST NOT occur more than once.
+          ;
+          acceptresponse / class / created / completed /
+          description / dtstart / last-mod / pollmode /
+          pollproperties / priority / seq / status /
+          summary / url /
+          ;
+          ; Either 'dtend' or 'duration' MAY appear in
+          ; a 'pollprop', but 'dtend' and 'duration'
+          ; MUST NOT occur in the same 'pollprop'.
+          ; 'duration' MUST only occur when 'dtstart'
+          ; is present
+          ;
+          dtend / duration /
+          ;
+          ; The following are OPTIONAL,
+          ; and MAY occur more than once.
+          ;
+          attach / categories / comment /
+          contact / rstatus / related /
+          resources / x-prop / iana-prop
+          ;
+          ; The following is OPTIONAL, it SHOULD appear
+          ; once for the confirmation of a BASIC mode
+          ; VPOLL. Other modes may define differing
+          ; requirements.
+          ;
+          pollwinner /
+          ;
+          )
+
+
Figure 20
+
+
+
+
Description
+
+
+

This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.

+
+
+

The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components.

+
+
+

If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created.

+
+
+

If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration.

+
+
+

"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property.

+
+
+

If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.

+
+
+
+
+
+
+
+
+
+

+5.6.2. VOTE Component +

+
+
+
Component name
+
+
+

VOTE

+
+
+
+
Purpose
+
+
+

This component provides a mechanism by which voters can +vote on provided choices.

+
+
+
+
Conformance
+
+
+

This component may be specified zero or more times in a PARTICIPANT component which identifies the voter.

+
+
+
+
Format Definition
+
+
+

This property is defined by the following notation:

+
+
+
+
+
+
+
+
+
votec     = "BEGIN" ":" "VOTE" CRLF
+            voteprop
+            *eventc *todoc *journalc *freebusyc
+            *availabilityc *alarmc *iana-comp *x-comp
+            "END" ":" "VOTE" CRLF
+
+voteprop = *(
+           ;
+           ; The following are REQUIRED,
+           ; but MUST NOT occur more than once.
+           ;
+           pollitemid / response /
+           ;
+           ; The following are OPTIONAL,
+           ; and MAY occur more than once.
+           ;
+           comment / x-prop / iana-prop
+           ;
+           )
+
+
Figure 21
+
+
+
+
Description
+
+
+

This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.

+
+
+

The required and optional properties and their meanings will depend +upon the POLL-MODE in effect.

+
+
+

For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice.

+
+
+

If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.

+
+
+
+
+
+
+
+
+
+
+
+
+
+

+6. Poll Modes +

+
+

The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property.

+
+
+

New poll modes can be registered by including a completed POLL-MODE +Registration Template (see Section 10.3) in a published RFC.

+
+
+
+

+6.1. POLL-MODE:BASIC +

+
+

BASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected.

+
+
+
+

+6.1.1. Property restrictions +

+
+

This poll mode has the following property requirements:

+
+
+
+
POLL-ITEM-ID
+
+
+

Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll.

+
+
+
+
POLL-WINNER
+
+
+

On confirmation of the poll this property MUST be +present and identifies the winning component.

+
+
+
+
+
+
+
+
+
+

+6.1.2. Outcome reporting +

+
+

To confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED.

+
+
+

When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.

+
+
+
+
+
+
+
+
+
+

+7. iTIP Extensions +

+
+

This specification introduces a number of extensions to [RFC5546]. +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters.

+
+
+

For many of the iTip processing rules the voters take the place of +attendees.

+
+
+
+

+7.1. Methods +

+
+

There are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1
MethodDescription
+
+

PUBLISH

+
+
+
+

No changes (yet)

+
+
+
+

REQUEST

+
+
+
+

Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on.

+
+
+
+

REPLY

+
+
+
+

There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only.

+
+
+
+

ADD

+
+
+
+

Not supported for VPOLL.

+
+
+
+

CANCEL

+
+
+
+

There MUST be a single VPOLL component with UID

+
+
+
+

matching that of the poll being cancelled.

+
+
+
+

REFRESH

+
+
+
+

The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found.

+
+
+
+

COUNTER

+
+
+
+

Not supported for VPOLL.

+
+
+
+

DECLINECOUNTER

+
+
+
+

Not supported for VPOLL.

+
+
+
+

POLLSTATUS

+
+
+
+

Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS.

+
+
+
+
+

The following table shows the above methods broken down by who can +send them with VPOLL components.

+
+
+ + + + + + + + + + + + + + + + + + +
Table 2
OriginatorMethods
+
+

Organizer

+
+
+
+

CANCEL, PUBLISH, REQUEST, POLLSTATUS

+
+
+
+

Voter

+
+
+
+

REPLY, REFRESH, REQUEST (only when delegating)

+
+
+
+
+
+
+
+

+7.2. Interoperability Models +

+
+

Most of the standard iTip specification applies with respect to +organizer and voters.

+
+
+
+

+7.2.1. Delegation +

+
+

TBD

+
+
+
+ +
+
+

+7.2.3. Component Revisions +

+
    +
  • +
    +

    Need to talk about what a change in SEQUENCE means

    +
    +
  • +
  • +
    +

    Sequence change forces a revote.

    +
    +
  • +
  • +
    +

    New voter - no sequence change

    +
    +
  • +
  • +
    +

    Add another poll set or change poll item ids or any change to a child

    +
    +
  • +
  • +
    +

    component - bump sequence

    +
    +
  • +
+
+
+
+
+

+7.2.4. Message Sequencing +

+
+

TBD

+
+
+
+
+
+
+
+

+7.3. Application Protocol Elements +

+
+
+

+7.3.1. Methods for VPOLL Calendar Components +

+
+

This section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method.

+
+
+

The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3
Presence ValueDescription
+
+

1

+
+
+
+

One instance MUST be present.

+
+
+
+

1+

+
+
+
+

At least one instance MUST be present.

+
+
+
+

0

+
+
+
+

Instances of this property MUST NOT be present.

+
+
+
+

0+

+
+
+
+

Multiple instances MAY be present.

+
+
+
+

0 or 1

+
+
+
+

Up to 1 instance of this property MAY be present.

+
+
+
+
+

The following summarizes the methods that are defined for the "VPOLL" +calendar component.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4
MethodDescription
+
+

PUBLISH

+
+
+
+

Post notification of an poll. Used primarily as a +method of advertising the existence of a poll.

+
+
+
+

REQUEST

+
+
+
+

To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach.

+
+
+
+

REPLY

+
+
+
+

Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100.

+
+
+
+

CANCEL

+
+
+
+

Cancel a poll.

+
+
+
+

REFRESH

+
+
+
+

A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester.

+
+
+
+

POLLSTATUS

+
+
+
+

Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT.

+
+
+
+
+
+
+
+

+7.3.2. Method: PUBLISH +

+
+

The "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component.

+
+
+
+
Note
+
+
+

Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification.

+
+
+
+
+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 5: +Constraints for a METHOD:PUBLISH of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST equal PUBLISH.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0 or 1

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0 or 1

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

PARTICIPANT

+
+
+
+

0+

+
+
+
+

Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTODO

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+
+
+
+
+

+7.3.3. Method: REQUEST +

+
+

The "REQUEST" method in a "VPOLL" component provides the following +scheduling functions:

+
+
    +
  • +
    +

    Invite "Voters" to respond to the poll.

    +
    +
  • +
  • +
    +

    Change the items being voted upon.

    +
    +
  • +
  • +
    +

    Complete or confirm the poll.

    +
    +
  • +
  • +
    +

    Response to a "REFRESH" request.

    +
    +
  • +
  • +
    +

    Update the details of an existing vpoll.

    +
    +
  • +
  • +
    +

    Update the status of "Voters".

    +
    +
  • +
  • +
    +

    Forward a "VPOLL" to another uninvited CU.

    +
    +
  • +
  • +
    +

    For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU.

    +
    +
  • +
  • +
    +

    For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU.

    +
    +
  • +
+
+

The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer".

+
+
+

The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component.

+
+
+

For the "REQUEST" method only a single iCalendar object is permitted.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 6: +Constraints for a METHOD:REQUEST of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REQUEST.

+
+
+
+

VPOLL

+
+
+
+

1

+
+
+
+

PARTICIPANT

+
+
+
+

1+

+
+
+
+

Identified as voters with the PARTICIPANT-TYPE=VOTER

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

If present defines the start of the poll. Otherwise the poll starts when it is created and distributed.

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0 or 1

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of COMPLETED/CONFIRMED/CANCELLED.

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+

VTODO

+
+
+
+

0+

+
+
+
+

Depending upon the poll mode in effect there MAY be candidate components included in the poll component.

+
+
+
+
+
+
+7.3.3.1. Rescheduling a poll +
+
+

The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll.

+
+
+
+
+
+
+7.3.3.2. Updating or Reconfirmation of a Poll +
+
+

The "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method

+
+
+

describes an update of the poll details, but not a rescheduling of +the POLL.

+
+
+

The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll.

+
+
+

The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.

+
+
+
+
+
+
+7.3.3.3. Confirmation of a Poll +
+
+

The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component.

+
+
+
+
+
+
+7.3.3.4. Closing a Poll +
+
+

The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED.

+
+
+
+
+
+
+7.3.3.5. Delegating a Poll to Another CU +
+
+

Some calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU.

+
+
+

The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above.

+
+
+

In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY"

+
+
+

method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address.

+
+
+

The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".

+
+
+
+
+
+
+7.3.3.6. Changing the Organizer +
+
+

The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer".

+
+
+
+
+
+
+7.3.3.7. Sending on Behalf of the Organizer +
+
+

There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer".

+
+
+
+
+
+
+7.3.3.8. Forwarding to an Uninvited CU +
+
+

A "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU.

+
+
+

The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll.

+
+
+

If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added.

+
+
+

When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.

+
+
+
+
+
+
+7.3.3.9. Updating Voter Status +
+
+

The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST".

+
+
+
+
+
+
+
+

+7.3.4. Method: REPLY +

+
+

The "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property.

+
+
+

The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed.

+
+
+

The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter".

+
+
+

A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value.

+
+
+

The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter.

+
+
+

The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY)

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 7: +Constraints for a METHOD:REPLY of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REPLY.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

All components MUST have the same

+
+
+
+

UID.

+
+
+
+

PARTICIPANT

+
+
+
+

1

+
+
+
+

Identifies the Voter replying.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID of the original

+
+
+
+

REQUEST.

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0 or 1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

1+

+
+
+
+

One per item being voted on.

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

SUMMARY

+
+
+
+

0 or 1

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0 or 1

+
+
+
+

A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy.

+
+
+
+

VAVAILABILITY

+
+
+
+

0

+
+
+
+

A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available.

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.5. Method: CANCEL +

+
+

The "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll.

+
+
+

The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each.

+
+
+

When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in Section 7.2.3.

+
+
+

Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 8: +Constraints for a METHOD:CANCEL of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be CANCEL.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

All must have the same UID.

+
+
+
+

PARTICIPANT

+
+
+
+

0+

+
+
+
+

MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID of the original REQUEST.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

1

+
+
+
+

ATTACH

+
+
+
+

0+

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

CATEGORIES

+
+
+
+

0+

+
+
+
+

CLASS

+
+
+
+

0 or 1

+
+
+
+

CONTACT

+
+
+
+

0+

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

GEO

+
+
+
+

0 or 1

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

LOCATION

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included.

+
+
+
+

SUMMARY

+
+
+
+

0 or 1

+
+
+
+

TRANSP

+
+
+
+

0 or 1

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.6. Method: REFRESH +

+
+

The "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 9: +Constraints for a METHOD:REFRESH of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST be REFRESH.

+
+
+
+

VPOLL

+
+
+
+

1

+
+
+
+

PARTICIPANT

+
+
+
+

1

+
+
+
+

MUST identify the requester as a voter.

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

MUST be the UID associated with original REQUEST.

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

COMPLETED

+
+
+
+

0

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

ATTACH

+
+
+
+

0

+
+
+
+

CATEGORIES

+
+
+
+

0

+
+
+
+

CLASS

+
+
+
+

0

+
+
+
+

CONTACT

+
+
+
+

0

+
+
+
+

CREATED

+
+
+
+

0

+
+
+
+

DESCRIPTION

+
+
+
+

0

+
+
+
+

DTEND

+
+
+
+

0

+
+
+
+

DTSTART

+
+
+
+

0

+
+
+
+

DURATION

+
+
+
+

0

+
+
+
+

GEO

+
+
+
+

0

+
+
+
+

LAST-MODIFIED

+
+
+
+

0

+
+
+
+

LOCATION

+
+
+
+

0

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0

+
+
+
+

RELATED-TO

+
+
+
+

0

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

RESOURCES

+
+
+
+

0

+
+
+
+

SEQUENCE

+
+
+
+

0

+
+
+
+

STATUS

+
+
+
+

0

+
+
+
+

SUMMARY

+
+
+
+

0

+
+
+
+

URL

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+
+
+
+
+

+7.3.7. Method: POLLSTATUS +

+
+

The "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars.

+
+
+

This method type is an iCalendar object that conforms to the +following property constraints:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Table 10: +Constraints for a METHOD:POLLSTATUS of a VPOLL +
Component/PropertyPresenceComment
+
+

METHOD

+
+
+
+

1

+
+
+
+

MUST equal POLLSTATUS.

+
+
+
+

VPOLL

+
+
+
+

1+

+
+
+
+

PARTICIPANT

+
+
+
+

1+

+
+
+
+

The voters containing their current vote

+
+
+
+

COMPLETED

+
+
+
+

0 or 1

+
+
+
+

Only present for a completed poll

+
+
+
+

DTSTAMP

+
+
+
+

1

+
+
+
+

DTSTART

+
+
+
+

0 or 1

+
+
+
+

ORGANIZER

+
+
+
+

1

+
+
+
+

SUMMARY

+
+
+
+

1

+
+
+
+

Can be null.

+
+
+
+

UID

+
+
+
+

1

+
+
+
+

SEQUENCE

+
+
+
+

0 or 1

+
+
+
+

MUST be present if value is greater than 0; MAY be present if 0.

+
+
+
+

ACCEPT-RESPONSE

+
+
+
+

0

+
+
+
+

ATTACH

+
+
+
+

0

+
+
+
+

CATEGORIES

+
+
+
+

0

+
+
+
+

CLASS

+
+
+
+

0

+
+
+
+

COMMENT

+
+
+
+

0+

+
+
+
+

CONTACT

+
+
+
+

0

+
+
+
+

CREATED

+
+
+
+

0 or 1

+
+
+
+

DESCRIPTION

+
+
+
+

0 or 1

+
+
+
+

Can be null.

+
+
+
+

DTEND

+
+
+
+

0 or 1

+
+
+
+

If present, DURATION MUST NOT be present.

+
+
+
+

DURATION

+
+
+
+

0 or 1

+
+
+
+

If present, DTEND MUST NOT be present.

+
+
+
+

LAST-MODIFIED

+
+
+
+

0 or 1

+
+
+
+

POLL-ITEM-ID

+
+
+
+

0

+
+
+
+

POLL-MODE

+
+
+
+

0 or 1

+
+
+
+

POLL-PROPERTIES

+
+
+
+

0

+
+
+
+

PRIORITY

+
+
+
+

0 or 1

+
+
+
+

RELATED-TO

+
+
+
+

0+

+
+
+
+

RESOURCES

+
+
+
+

0+

+
+
+
+

STATUS

+
+
+
+

0 or 1

+
+
+
+

MAY be one of TENTATIVE/CONFIRMED/CANCELLED.

+
+
+
+

URL

+
+
+
+

0 or 1

+
+
+
+

IANA-PROPERTY

+
+
+
+

0+

+
+
+
+

X-PROPERTY

+
+
+
+

0+

+
+
+
+

REQUEST-STATUS

+
+
+
+

0

+
+
+
+

VALARM

+
+
+
+

0+

+
+
+
+

VEVENT

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VFREEBUSY

+
+
+
+

0

+
+
+
+

VJOURNAL

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VTODO

+
+
+
+

0

+
+
+
+

All candidate components SHOULD NOT be present.

+
+
+
+

VTIMEZONE

+
+
+
+

0+

+
+
+
+

MUST be present if any date/time refers to a timezone.

+
+
+
+

IANA-COMPONENT

+
+
+
+

0+

+
+
+
+

X-COMPONENT

+
+
+
+

0+

+
+
+
+
+
+
+
+
+
+
+
+

+8. CalDAV Extensions +

+
+

This specification extends [RFC4791] in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports.

+
+
+

Additionally, it extends [RFC6638] as it a VPOLL component is a +schedulable entity.

+
+
+
+

+8.1. Calendar Collection Properties +

+
+

This section defines new CalDAV properties for calendar collections.

+
+
+
+

+8.1.1. CALDAV:supported-vpoll-component-sets +

+
+
+
Name
+
+
+

supported-vpoll-component-sets

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.

+
+
+

It also specifies the combination of allowed component types.

+
+
+

Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition Section 8.2 being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
&lt;!ELEMENT supported-vpoll-component-sets
+     (supported-vpoll-component-set*) &gt;
+
+&lt;!ELEMENT supported-vpoll-component-set (comp+)&gt;
+
+
Figure 22
+
+
+
+
+
&lt;C:supported-vpoll-component-sets
+     xmlns:C="urn:ietf:params:xml:ns:caldav"&gt;
+
+  &lt;!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --&gt;
+  &lt;C:supported-vpoll-component-set&gt;
+    &lt;C:comp name="VEVENT" /&gt;
+    &lt;C:comp name="VFREEBUSY" /&gt;
+    &lt;C:comp name="VTODO" /&gt;
+  &lt;/C:supported-vpoll-component-set&gt;
+
+  &lt;!-- VPOLLs with just VEVENT or VFREEBUSY --&gt;
+  &lt;C:supported-vpoll-component-set&gt;
+    &lt;C:comp name="VEVENT" /&gt;
+    &lt;C:comp name="VFREEBUSY" /&gt;
+  &lt;/C:supported-vpoll-component-set&gt;
+
+  &lt;!-- VPOLLs with just VEVENT --&gt;
+  &lt;C:supported-vpoll-component-set&gt;
+    &lt;C:comp name="VEVENT" /&gt;
+  &lt;/C:supported-vpoll-component-set&gt;
+
+  &lt;!-- VPOLLs with just VTODO --&gt;
+  &lt;C:supported-vpoll-component-set&gt;
+    &lt;C:comp name="VTODO" /&gt;
+  &lt;/C:supported-vpoll-component-set&gt;
+&lt;/C:supported-vpoll-component-sets&gt;
+
+
Figure 23
+
+
+
+
+
+

+8.1.2. CALDAV:vpoll-max-items +

+
+
+
Name
+
+
+

vpoll-max-items

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition +Section 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
&lt;!ELEMENT vpoll-max-items (#PCDATA)&gt;
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 24
+
+
+
+
+
&lt;C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav"
+&gt;25&lt;/C:vpoll-max-items&gt;
+
+
Figure 25
+
+
+
+
+
+

+8.1.3. CALDAV:vpoll-max-active +

+
+
+
Name
+
+
+

vpoll-max-active

+
+
+
+
Namespace
+
+
+

urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +active vpolls at any one time.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition +Section 8.2 being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
&lt;!ELEMENT vpoll-max-active (#PCDATA)&gt;
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 26
+
+
+
+
+
&lt;C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav"
+&gt;25&lt;/C:vpoll-max-active&gt;
+
+
Figure 27
+
+
+
+
+
+

+8.1.4. CALDAV:vpoll-max-voters +

+
+
+
Name
+
+
+

+vpoll-max-voters

+
+
+
+
Namespace
+
+
+

+urn:ietf:params:xml:ns:caldav

+
+
+
+
Purpose
+
+
+

Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection.

+
+
+
+
Conformance
+
+
+

This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +[RFC2518]).

+
+
+
+
Description
+
+
+

The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition Section 8.2 +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component.

+
+
+
+
Definition
+
+
+
+
+
+
+
+
&lt;!ELEMENT vpoll-max-voters (#PCDATA)&gt;
+PCDATA value: a numeric value (integer greater than zero)
+
+
Figure 28
+
+
+
+
+
&lt;C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav"
+&gt;25&lt;/C:vpoll-max-voters&gt;
+
+
Figure 29
+
+
+
+ +
+
+

+8.1.6. Extensions to CalDAV scheduling +

+
+

This specification extends [RFC6638].

+
+
+

Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL.

+
+
+

Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.

+
+
+
+
+
+
+
+

+8.2. Additional Preconditions for PUT, COPY, and MOVE +

+
+

This specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection.

+
+
+

The new preconditions are:

+
+
+
+
(CALDAV:supported-vpoll-component-sets)
+
+
+

The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection;

+
+
+
+
(CALDAV:vpoll-max-items)
+
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value Section 8.1.2 +on the calendar collection where the resource will be stored;

+
+
+
+
(CALDAV:vpoll-max-active)
+
+
+

The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value +Section 8.1.3 on the calendar collection where the resource will +be stored;

+
+
+
+
(CALDAV:vpoll-max-voters)
+
+
+

The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value Section 8.1.4 on the +calendar collection where the resource will be stored;

+
+
+
+
+
+
+
+
+
+

+8.3. CalDAV:calendar-query Report +

+
+

This allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself.

+
+
+
+

+8.3.1. Example: Partial Retrieval of VPOLL +

+
+

In this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION.

+
+
+
+
+
&gt;&gt; Request &lt;&lt;
+
+REPORT /cyrus/work/ HTTP/1.1
+Host: cal.example.com
+Depth: 1
+Content-Type: application/xml; charset="utf-8"
+Content-Length: xxxx
+
+&lt;?xml version="1.0" encoding="utf-8" ?&gt;
+&lt;C:calendar-query xmlns:D="DAV:"
+              xmlns:C="urn:ietf:params:xml:ns:caldav"&gt;
+  &lt;D:prop&gt;
+    &lt;D:getetag/&gt;
+    &lt;C:calendar-data&gt;
+      &lt;C:comp name="VCALENDAR"&gt;
+        &lt;C:prop name="VERSION"/&gt;
+        &lt;C:comp name="VPOLL"&gt;
+          &lt;C:prop name="SUMMARY"/&gt;
+          &lt;C:prop name="UID"/&gt;
+          &lt;C:prop name="DTSTART"/&gt;
+          &lt;C:prop name="DTEND"/&gt;
+          &lt;C:prop name="DURATION"/&gt;
+        &lt;/C:comp&gt;
+
+      &lt;/C:comp&gt;
+    &lt;/C:calendar-data&gt;
+  &lt;/D:prop&gt;
+  &lt;C:filter&gt;
+    &lt;C:comp-filter name="VCALENDAR"&gt;
+      &lt;C:comp-filter name="VPOLL"&gt;
+        &lt;C:time-range start="20121204T000000Z"
+                      end="20121205T000000Z"/&gt;
+      &lt;/C:comp-filter&gt;
+    &lt;/C:comp-filter&gt;
+  &lt;/C:filter&gt;
+&lt;/C:calendar-query&gt;
+
+&gt;&gt; Response &lt;&lt;
+
+HTTP/1.1 207 Multi-Status
+Date: Sat, 11 Nov 2012 09:32:12 GMT
+Content-Type: application/xml; charset="utf-8"
+Content-Length: xxxx
+
+&lt;?xml version="1.0" encoding="utf-8" ?&gt;
+&lt;D:multistatus xmlns:D="DAV:"
+           xmlns:C="urn:ietf:params:xml:ns:caldav"&gt;
+  &lt;D:response&gt;
+    &lt;D:href&gt;http://cal.example.com/cyrus/work/poll2.ics&lt;/D:href&gt;
+    &lt;D:propstat&gt;
+      &lt;D:prop&gt;
+        &lt;D:getetag&gt;"fffff-abcd2"&lt;/D:getetag&gt;
+        &lt;C:calendar-data&gt;BEGIN:VCALENDAR
+VERSION:2.0
+BEGIN:VPOLL
+DTSTART;TZID=US/Eastern:20121202T120000
+DURATION:PT4D
+SUMMARY:Poll #2
+UID:00959BC664CA650E933C892C@example.com
+END:VPOLL
+END:VCALENDAR
+&lt;/C:calendar-data&gt;
+      &lt;/D:prop&gt;
+      &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
+    &lt;/D:propstat&gt;
+  &lt;/D:response&gt;
+  &lt;D:response&gt;
+    &lt;D:href&gt;http://cal.example.com/cyrus/work/poll3.ics&lt;/D:href&gt;
+    &lt;D:propstat&gt;
+      &lt;D:prop&gt;
+        &lt;D:getetag&gt;"fffff-abcd3"&lt;/D:getetag&gt;
+        &lt;C:calendar-data&gt;BEGIN:VCALENDAR
+
+VERSION:2.0
+PRODID:-//Example Corp.//CalDAV Client//EN
+BEGIN:VPOLL
+DTSTART;TZID=US/Eastern:20121204T100000
+DURATION:PT4D
+SUMMARY:Poll #3
+UID:DC6C50A017428C5216A2F1CD@example.com
+END:VPOLL
+END:VCALENDAR
+&lt;/C:calendar-data&gt;
+      &lt;/D:prop&gt;
+      &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
+    &lt;/D:propstat&gt;
+  &lt;/D:response&gt;
+&lt;/D:multistatus&gt;
+
+
Figure 30
+
+
+
+
+
+
+
+

+8.4. CalDAV time ranges +

+
+

"CALDAV:time-range XML Element" in [RFC4791] describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends [RFC4791] to +describe the meaning of time ranges for VPOLL

+
+
+

A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified.

+
+
+
+
+
+-------------------------------------------------------------------+
+| VPOLL has the DTSTART property?                                   |
+|   +---------------------------------------------------------------+
+|   |   VPOLL has the DURATION property?                            |
+|   |   +-----------------------------------------------------------+
+|   |   | VPOLL has the DTEND property?                             |
+|   |   |   +-------------------------------------------------------+
+|   |   |   | VPOLL has the COMPLETED property?                     |
+|   |   |   |   +---------------------------------------------------+
+|   |   |   |   | VPOLL has the CREATED property?                   |
+|   |   |   |   |   +-----------------------------------------------+
+|   |   |   |   |   | Condition to evaluate                         |
++---+---+---+---+---+-----------------------------------------------+
+| Y | Y | N | * | * | (start  &lt;= DTSTART+DURATION)  AND             |
+|   |   |   |   |   | ((end   &gt;  DTSTART)  OR                       |
+|   |   |   |   |   |  (end   &gt;= DTSTART+DURATION))                 |
++---+---+---+---+---+-----------------------------------------------+
+| Y | N | Y | * | * | ((start &lt;  DTEND)    OR  (start &lt;= DTSTART))  |
+|   |   |   |   |   | AND                                           |
+|   |   |   |   |   | ((end   &gt;  DTSTART)  OR  (end   &gt;= DTEND))    |
++---+---+---+---+---+-----------------------------------------------+
+| Y | N | N | * | * | (start  &lt;= DTSTART)  AND (end &gt;  DTSTART)     |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | Y | * | * | (start  &lt;  DTEND)    AND (end &gt;= DTEND)       |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | Y | Y | ((start &lt;= CREATED)  OR  (start &lt;= COMPLETED))|
+|   |   |   |   |   | AND                                           |
+|   |   |   |   |   | ((end   &gt;= CREATED)  OR  (end   &gt;= COMPLETED))|
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | Y | N | (start  &lt;= COMPLETED) AND (end  &gt;= COMPLETED) |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | N | Y | (end    &gt;  CREATED)                           |
++---+---+---+---+---+-----------------------------------------------+
+| N | N | N | N | N | TRUE                                          |
++---+---+---+---+---+-----------------------------------------------+
+
+
Figure 31
+
+
+
+
+
+
+
+

+9. Security Considerations +

+
+

Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See [RFC3986] for a +discussion of the security considerations relating to URIs.

+
+
+
+
+
+

+10. IANA Considerations +

+
+
+

+10.1. Parameter Registrations +

+
+

This document defines the following new iCalendar property parameters +to be added to the registry defined in [RFC5545]:

+
+
+ + + + + + + + + + + + + + + + + + + + + +
Table 11
Property ParameterStatusReference
+
+

REQUIRED

+
+
+
+

Current

+
+
+ +
+
+

STAY-INFORMED

+
+
+
+

Current

+
+
+ +
+
+
+
+
+
+

+10.2. Property Registrations +

+
+

This document defines the following new iCalendar properties to be +added to the registry defined in [RFC5545]:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12
PropertyStatusReference
+
+

ACCEPT-RESPONSE

+
+
+
+

Current

+
+
+ +
+
+

POLL-ITEM-ID

+
+
+
+

Current

+
+
+ +
+
+

POLL-MODE

+
+
+
+

Current

+
+
+ +
+
+

POLL-PROPERTIES

+
+
+
+

Current

+
+
+ +
+
+

POLL-WINNER

+
+
+
+

Current

+
+
+ +
+
+

RESPONSE

+
+
+
+

Current

+
+
+ +
+
+
+
+
+
+

+10.3. POLL-MODE Registration Template +

+
+

A poll mode is defined by completing the following template.

+
+
+
+
Poll mode name
+
+
+

The name of the poll mode.

+
+
+
+
Purpose
+
+
+

The purpose of the poll mode. Give a short but clear +description.

+
+
+
+
Reference
+
+
+

A reference to the RFC in which the poll mode is defined

+
+
+
+
+
+
+
+
+
+

+10.4. POLL-MODE Registrations +

+
+

This document defines the following registered poll modes.

+
+
+ + + + + + + + + + + + + + + + +
Table 13
Poll mode namePurposeReference
+
+

BASIC

+
+
+
+

To provide simple voting for a single outcome from a number of candidates.

+
+
+
+

Current

+
+
+
+
+
+
+
+
+
+

+11. Normative References +

+
+
[RFC2518]
+
+Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D. Jensen, "HTTP Extensions for Distributed Authoring - WEBDAV", IETF RFC 2518, IETF RFC 2518, DOI 10.17487/RFC2518, , <https://www.rfc-editor.org/info/rfc2518>.
+
+
[RFC3986]
+
+Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", IETF RFC 3986, IETF RFC 3986, DOI 10.17487/RFC3986, , <https://www.rfc-editor.org/info/rfc3986>.
+
+
[RFC4791]
+
+Daboo, C., Desruisseaux, B., and L. Dusseault, "Calendaring Extensions to WebDAV (CalDAV)", IETF RFC 4791, IETF RFC 4791, DOI 10.17487/RFC4791, , <https://www.rfc-editor.org/info/rfc4791>.
+
+
[RFC5545]
+
+Desruisseaux, B., Ed., "Internet Calendaring and Scheduling Core Object Specification (iCalendar)", IETF RFC 5545, IETF RFC 5545, DOI 10.17487/RFC5545, , <https://www.rfc-editor.org/info/rfc5545>.
+
+
[RFC5546]
+
+Daboo, C., Ed., "iCalendar Transport-Independent Interoperability Protocol (iTIP)", IETF RFC 5546, IETF RFC 5546, DOI 10.17487/RFC5546, , <https://www.rfc-editor.org/info/rfc5546>.
+
+
[RFC6047]
+
+Melnikov, A., Ed., "iCalendar Message-Based Interoperability Protocol (iMIP)", IETF RFC 6047, IETF RFC 6047, DOI 10.17487/RFC6047, , <https://www.rfc-editor.org/info/rfc6047>.
+
+
[RFC6638]
+
+Daboo, C. and B. Desruisseaux, "Scheduling Extensions to CalDAV", IETF RFC 6638, IETF RFC 6638, DOI 10.17487/RFC6638, , <https://www.rfc-editor.org/info/rfc6638>.
+
+
[I-D.draft-ietf-calext-eventpub-extensions]
+
+"AUTOFILL", IETF IETF I-D.draft-ietf-calext-eventpub-extensions, IETF IETF I-D.draft-ietf-calext-eventpub-extensions.
+
+
+
+
+
+
+

+12. Bibliography +

+
+
+
+
+

+Appendix A. Open issues +

+
+

public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property

+
+
+

Notifications: Need to do a section on what Notifications to + support. + A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user?

+
+
+

Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote

+
+
+

Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status

+
+
+

ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration

+
+
+

Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event.

+
+
+

Need to write down what isn't valid in a VPOLL + a. Can't change POLL-MODE

+
+
+

Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc

+
+
+

? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER

+
+
+

Need to add example of freebusy in response

+
+
+
+
+
BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest
+METHOD: REPLY
+BEGIN:VPOLL
+ORGANIZER:mailto:douglm@mysite.edu
+BEGIN:PARTICIPANT
+PARTICIPANT-TYPE: VOTER
+CALENDAR-ADDRESS:mailto:eric@example.com
+UID:sched01-1234567890
+DTSTAMP:20120101T010000Z
+SEQUENCE:0
+SUMMARY:What to do this week
+BEGIN:VFREEBUSY
+.......
+END:VFREEBUSY
+END:PARTICIPANT
+END:VPOLL
+END:VCALENDAR
+
+
Figure 32
+
+
+
+
+
+

+Appendix B. Change log +

+
+
+
Calext V01: 2019-10-17 MD
+
+
+

Replace VVOTER and VOTER with PARTICIPANT.

+
+
+
+
Calext V00: 2019-05-17 MD
+
+
+

First calext version. Moved source to metanorma. No changes to specification.

+
+
+
+
V03: 2014-10-28 MD
+
+
    +
  • +
    +

    Add VVOTER and VOTE components.

    +
    +
  • +
  • +
    +

    Add RESPONSE property.

    +
    +
  • +
  • +
    +

    Remove RESPONSE parameter from VOTER.

    +
    +
  • +
+
+
+
V03: 2014-05-12 MD
+
+
    +
  • +
    +

    Add reply-url property and required parameter.

    +
    +
  • +
  • +
    +

    Fix ACCEPT-RESPONSE definition.

    +
    +
  • +
+
+
+
V02: 2014-05-12 MD
+
+
    +
  • +
    +

    Typos fixed, clarifications made.

    +
    +
  • +
  • +
    +

    Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT

    +
    +
  • +
  • +
    +

    Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values.

    +
    +
  • +
  • +
    +

    iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent

    +
    +
  • +
  • +
    +

    iTip: fix broken table cells

    +
    +
  • +
  • +
    +

    Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table

    +
    +
  • +
  • +
    +

    Added Caldav scheduling section

    +
    +
  • +
+
+
+
V01: 2013-08-07 MD
+
+
    +
  • +
    +

    Removed method CONFIRM

    +
    +
  • +
  • +
    +

    Removed pollitemid from VPOLL abnf. Added text for pollwinner

    +
    +
  • +
  • +
    +

    Added POLL-WINNER and verbiage

    +
    +
  • +
  • +
    +

    Added STATUS values

    +
    +
  • +
  • +
    +

    Added RELTYPE=POLL

    +
    +
  • +
  • +
    +

    Added supported-vpoll-component-sets

    +
    +
  • +
  • +
    +

    Added CalDAV related parameters to VOTER

    +
    +
  • +
  • +
    +

    Removed bad CalDAV query example. State that queries cannot +target the sub-components.

    +
    +
  • +
+
+
+
Initial version: 2012-11-02 MD
+
+
+
+
+
+
+
+
+

+Authors' Addresses +

+
+
Eric York
+ +
+
+
Cyrus Daboo
+ +
+
+
Michael Douglass
+ +
+
+
+ + + diff --git a/sources/draft-ietf-calext-vpoll.rfc.xml b/sources/draft-ietf-calext-vpoll.rfc.xml new file mode 100644 index 0000000..806dcd4 --- /dev/null +++ b/sources/draft-ietf-calext-vpoll.rfc.xml @@ -0,0 +1,3134 @@ + + + + + + + + + + VPOLL: Consensus Scheduling Component for iCalendar + + + +
+ + eric.york@gmail.com + +
+
+ +
+ + cyrus@daboo.name + +
+
+ +
+ + mikeadouglass@gmail.com + +
+
+ Internet + + +This specification introduces a new iCalendar component which allows +for consensus scheduling, that is, voting on a number of alternative +meeting or task alternatives. + +
+ +
+ Acknowledgements + The authors would like to thank the members of the Calendaring and Scheduling Consortium (CalConnect) for contributing their ideas and support. +
+
+ Introduction + The currently existing approach to agreeing on meeting times using +iTip and/or iMip has some significant failings. +There is no useful bargaining or suggestion mechanism in iTip, only +the ability for a potential attendee to accept or refuse or to +counter with a time of their own choosing. + Part of the problem is that for many potential attendees, their +freebusy is not an accurate representation of their availability. In +fact, when trying to schedule conference calls across different +organizations, attendees may not be allowed to provide freebusy +information or availability as this may reveal something of the +organizations internal activities. + A number of studies have shown that large amounts of time are spent +trying to come to an agreement - up to and beyond 20 working hours +per meeting. Many organizers fall back on other approaches such as +phone calls and email to determine a suitable time. + Online services have appeared as a result and these allow +participants to vote on a number of alternatives without revealing or +using freebusy or availability. When agreement is reached a +conventional scheduling message may be sent to the attendees. This +approach appears to reach consensus fairly rapidly. Peer pressure +may have some bearing on this as all voters are usually able to see +the current state of the voting and may adjust their own meeting +schedules to make themselves available for a popular choice. + The component and properties defined in this specification provide a +standardized structure for this process and allow calendar clients +and servers and web based services to interact. + These structures also have uses beyond the relatively simple needs of +most meeting organizers. The process of coming to consensus can also +be viewed as a bidding process. +
+
+ Terms and definitions + For the purposes of this document, + the following terms and definitions apply. +
+consensus scheduling +The process whereby users come to some agreement on meeting +or task alternatives and then book that meeting or task. +
+
+active Vpoll +A VPoll may have a DTSTART, DTEND and DURATION which +may define the start and end of the active voting period +
+
+voter +A participant who votes on the alternatives. A voter need not be an attendee of any of the alternatives presented. +
+
+
+ Simple Consensus Scheduling + This specification defines components and properties which can be +used for simple consensus scheduling but also have the generality to +handle more complex cases. To provide an easy (and for many - +sufficient) introduction to consensus scheduling and VPOLL we will +outline the flow of information for the simple case of voting on a +number of meeting alternatives which differ only in time. In +addition the voters will all be potential attendees. + This specification not only defines data structures but adds a new +iTip method used when consensus has been reached. This document will +show how a VPOLL object is used to inform voters of the state of a +simple vote on some alternatives. +
The VPOLL Component: An OverviewThe VPOLL component acts as a wrapper for a number of alternatives to +be voted on, together with some properties and a new component used +to maintain the state of the voting. For our simple example the +following VPOLL properties and sub-components are either required or +appropriate: +
DTSTAMP
+The usual property. +
SEQUENCE
+The usual property. See below for SEQUENCE +behavior. +
UID
+The usual property. +
ORGANIZER
+The usual property. In general this need not +be an organizer of any of the alternatives. In this simple +outline we assume it is the same. +
SUMMARY
+The usual property. This optional but +recommended property provides the a short title to the poll. +
DESCRIPTION
+The usual property. This optional property +provides more details. +
DTEND
+The usual property. This optional property +provides a poll closing time and date after which the VPOLL is no +longer active. +
POLL-MODE
+A new property which defines how the votes are used to +obtain a result. For our use case it will take the value "BASIC" +meaning one event will be chosen from the alternatives. +
POLL-COMPLETION
+A new property which defines who (server or client) +chooses and/or submits the winning choice. In our example the +value is "SERVER-SUBMIT" which means the client chooses the winner +but the server will submit the winning choice. +
POLL-PROPERTIES
+A new property which defines which icalendar +properties are being voted on. For our use case it will take the +value "DTSTART, LOCATION" meaning only those properties are +significant for voting. Other properties in the events may differ +but are not considered significant for the voting process. +
PARTICIPANT
+There is one of these components for each voter with +the PARTICIPANT-TYPE set to "VOTER". The +CALENDAR-ADDRESS property identifies the voter and this component +will contain one VOTE component for each item being voted on. +
VOTE
+A new component. There is one of these for each voter and +choice. It usually contains at least a POLL-ITEM-ID property to +identify the choice and a RESPONSE property to provide a vote. +For more complex poll modes it may contain other information such +as cost or estimated duration. +
VEVENT
+In our simple use case there will be multiple VEVENT sub- +components defining the alternatives. Each will have a different +date and or time for the meeting. +
+EXAMPLEVPOLL with 3 voters and 3 alternative meetings:
+As can be seen in the example above, there is an iTip METHOD property +with the value REQUEST. The VPOLL object will be distributed to all +the voters, either through iMip or through some VPOLL enabled +service.
+
The VPOLL Alternative Choices: An OverviewWithin the VPOLL component we have the alternatives to vote on. In +many respects these are standard components. For our +simple use case they are all VEVENT components. In addition to the +usual properties some extra properties are used for a +VPOLL. +
POLL-ITEM-ID
+This provides a unique reference to the sub-component +within the VPOLL. It's value SHOULD be a small integer. +
+
VPOLL responsesUpon receipt of a VPOLL REQUEST the voter will reply with a VPOLL +component containing their vote. In our simple case it will have the +following properties and components: +
DTSTAMP
+The usual property. +
SEQUENCE
+The usual property. See below for SEQUENCE +behavior. +
UID
+Same as the request. +
ORGANIZER
+Same as the request. +
SUMMARY
+Same as the request. +
PARTICIPANT
+One only with a CALENDAR-ADDRESS identifying the voter replying. +
VOTE
+One per item being voted on. +
POLL-ITEM-ID
+One inside each VOTE component to identify the choice. +
RESPONSE
+One inside each VOTE component to specify the vote. +
+Note that a voter can send a number of REPLYs for each REQUEST sent +by the organizer. Each REPLY completely replaces the voting record +for that voter for all components being voted on. In our example, if +Eric responds and votes for items 1 and 2 and then responds again +with a vote for only item 3, the final outcome is one vote on item 3. +
NOTE
+This is poll-mode specific behavior? +
+EXAMPLEREPLY VPOLL from Cyrus:
+
VPOLL updatesWhen the organizer receives a response from one or more voters the +current state of the poll is sent to all voters. The new iTip method +POLLSTATUS is used. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, +ORGANIZER and one or more PARTICIPANT components each populated with zero or more VOTE components. +EXAMPLE
+
VPOLL CompletionAfter a number of REPLY messages have been received the poll will be +considered complete. If there is a DTEND on the poll the system may +automatically close the poll, or the organizer may, at any time, +consider the poll complete. A VPOLL can be completed (and +effectively closed for voting) by sending an iTip REQUEST message +with the VPOLL STATUS property set to COMPLETED. +The poll winner is confirmed by sending a final iTip REQUEST message +with the VPOLL STATUS property set to CONFIRMED. In this case the +VPOLL component contains all the events being voted on along with a +POLL-WINNER property to identify the winning event. As the POLL- +COMPLETION property is set to SERVER-SUBMIT the server will submit +the winning choice and when it has done so set the STATUS to +"SUBMITTED". +EXAMPLEVPOLL confirmation:
+
Other ResponsesA voter being asked to choose between a number of ORGANIZER supplied +alternatives may find none of them acceptable or may simply not care. +An alternative response, which may be disallowed by the ORGANIZER, is +to send back the respondees availability or freebusy or even one or +more new, alternative choices. +This is accomplished by responding with a VOTE component which has no +POLL-ITEM-ID property. In this case it MUST contain some alternative +information. What form this takes depends on the poll mode in +effect.
+
+
+ iCalendar Extensions +
Updated Participant Type ValueParticipant type property values are defined in section 11.2.1. of +. This specification updates that type to include the new +participant type VOTER to provide information about the voter and to contain their votes. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+The new property value indicates that the associated PARTICIPANT component identifies a voter in a VPOLL. +
+
Updated Relation Type ValueRelationship parameter type values are defined in section 3.2.15. of +. This specification updates that type to include the new +relationship value POLL to provide a link to the VPOLL component in +which the current component appears. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+This parameter can be specified on a property that +references another related calendar component. The new parameter +value indicates that the associated property references a VPOLL +component which contains the current component. +
+
Updated Status ValueStatus property values are defined in section 3.8.1.11. of . +This specification updates that type to define valid VPOLL status +values. +
Format Definition
+This property parameter is redefined by the following notation: +
+
+ +
Description
+These values allow clients and servers to handle the +choosing and submission of winning choices. +
+ +
+
+
New Property Parameters
Required
Parameter name
+REQUIRED +
Purpose
+To specify whether the associated property is required in +the current context. +
Format Definition
+This parameter is defined by the following notation: +
+
+ +
Description
+This parameter MAY be specified on REPLY-URL and, if +the value is TRUE, indicates the organizer requires all replies to +be made via the specified service rather than iTip replies. +
+
Stay-Informed
Parameter name
+STAY-INFORMED +
Purpose
+To specify the voter also wants to be added as an ATTENDEE +when the poll is confirmed. +
Format Definition
+This parameter is defined by the following notation: +
+
+ +
Description
+This parameter MAY be specified on the CALENDAR-ADDRESS +property in the PARTICIPANT component and, if the +value is TRUE, indicates the voter wishes to be added to the final +choice as a non participant. +
+
New Properties
Accept-Response
Property name
+ACCEPT-RESPONSE +
Purpose
+This property is used in VPOLL to indicate the types of +component that may be supplied in a response. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+When used in a VPOLL this property indicates what +allowable component types may be returned in a reply. Typically +this would allow a voter to respond with their freebusy or +availability rather than choosing one of the presented +alternatives. +If this property is not present voters are only allowed to respond +to the choices in the request. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Completion
Property name
+POLL-COMPLETION +
Purpose
+This property is used in VPOLL to indicate whether the +client or server is responsible for choosing and/or submitting the +winner(s). +
Description
When a VPOLL is stored on a server which is capable of +handling choosing and submission of winning choices a value of +SERVER indicates that the server should close the poll, choose the +winner and submit whenever it is appropriate to do so.For example, in BASIC poll-mode, reaching the DTEND of the poll +could trigger this server side action. +Server initiated submission requires that the submitted choice +MUST be a valid calendaring component. +POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- +winner, set the status to CONFIRMED and then store the poll on the +server. The server will then submit the winning choice and set +the status to SUBMITTED.
Format Definition
+This property is defined by the following notation: +
+
+ +
Example
+The following is an example of this property: +
+
+
+
Poll-Item-Id
Property name
+POLL-ITEM-ID +
Purpose
+This property is used in VPOLL child components as an +identifier. +
Value type
+INTEGER +
Property Parameters
+Non-standard parameters can be specified on +this property. +
Conformance
+This property MUST be specified in a VOTE component and +in VPOLL choice items. +
Description
+In a METHOD:REQUEST each choice component MUST have a +POLL-ITEM-ID property. Each set of components with the same POLL- +ITEM-ID value represents one overall set of items to be voted on. +POLL-ITEM-ID SHOULD be a unique small integer for each component +or set of components. If it remains the same between REQUESTs +then the previous response for that component MAY be re-used. To +force a re-vote on a component due to a significant change, the +POLL-ITEM-ID MUST change. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Mode
Property name
+POLL-MODE +
Purpose
+This property is used in VPOLL to indicate what voting mode +is to be applied. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component or +its sub-components. +
Description
+The poll mode defines how the votes are applied to +obtain a result. BASIC mode, the default, means that the voters +are selecting one component (or group of components) with a given +POLL=ITEM-ID. +Other polling modes may be defined in updates to this +specification. These may allow for such modes as ranking or task +assignment. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-properties
Property name
+POLL-PROPERTIES +
Purpose
+This property is used in VPOLL to define which icalendar +properties are being voted on. +
Property Parameters
+Non-standard or iana parameters can be +specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+This property defines which icalendar properties are +significant in the voting process. It may not be clear to voters +which properties are varying in a significant manner. Clients may +use this property to highlight those listed properties. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Poll-Winner
Property name
+POLL-WINNER +
Purpose
+This property is used in a basic mode VPOLL to indicate +which of the VPOLL sub-components won. +
Value type
+INTEGER +
Property Parameters
+Non-standard parameters can be specified on +this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+For poll confirmation each child component MUST have a +POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD +have a POLL-WINNER property which MUST correspond to one of the +POLL-ITEM-ID properties and indicates which sub-component was the +winner. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Reply-URL
Property name
+REPLY-URL +
Purpose
+This property may be used in scheduling messages to +indicate additional reply methods, for example a web-service. +
Property Parameters
+Non-standard, required or iana parameters can +be specified on this property. +
Conformance
+This property MAY be specified in a VPOLL component. +
Description
+When used in a scheduling message this property +indicates additional or required services that can be used to +reply. Typically this would be a web service of some form. +
Format Definition
+This property is defined by the following notation: +
+
+
+
Response
Property name
+RESPONSE +
Purpose
+To specify a response vote. +
Value type
+INTEGER +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
+This parameter can be specified on the POLL-ITEM-ID +property to provide the value of the voters response. This +parameter allows for fine grained responses which are appropriate +to some applications. For the case of individuals voting for a +choice of events, client applications SHOULD conform to the +following convention: +
    +
  • +0 - 39 A "NO vote" +
  • +
  • +40 - 79 A "MAYBE" vote +
  • +
  • +80 - 89 A "YES - but not preferred vote" +
  • +
  • +90-100 A "YES" vote. +Clients MUST preserve the response value when there is no change +from the user even if they have a UI with fixed states (e.g. +yes/no/maybe). +
  • +
+
+
New Components
VPOLL Component
Component name
+VPOLL +
Purpose
+This component provides a mechanism by which voters can +vote on provided choices. +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
This component provides a mechanism by which voters can +vote on provided choices. The outcome depends upon the POLL-MODE +in effect.The PARTICIPANT components in VPOLL requests provide information on +each recipient who will be voting - both their identity through +the CALENDAR-ADDRESS property and their votes through the VOTE components. +If specified, the "DTSTART" property defines the start or opening +of the poll active period. If absent the poll is presumed to have +started when created. +If "DTSTART" is present "DURATION" MAY be specified and indicates +the duration, and hence the ending, of the poll. The value of the +property MUST be a positive duration. +"DTEND" MAY be specified with or without "DTSTART" and indicates +the ending of the poll. If DTEND is specified it MUST be later +than the DTSTART or CREATED property. +If one or more VALARM components are included in the VPOLL they +are not components to be voted on and MUST NOT contain a POLL- +ITEM-ID property. VALARM sub-components may be used to provide +warnings to the user when polls are due to start or end.
+
VOTE Component
Component name
+VOTE +
Purpose
+This component provides a mechanism by which voters can +vote on provided choices. +
Conformance
+This component may be specified zero or more times in a PARTICIPANT component which identifies the voter. +
Format Definition
+This property is defined by the following notation: +
+
+ +
Description
This component appears inside the PARTICIPANT component +with a PARTICIPANT-TYPE of VOTER to identify the voter. This component +contains that participants responses.The required and optional properties and their meanings will depend +upon the POLL-MODE in effect. +For any POLL-MODE, POLL-ITEM-ID is used to associate the +information to a choice supplied by the organizer. This means that each VOTE component only provides information about that choice. +If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- +ID may be provided in a REPLY to indicate a possible new choice or +to provide information to the ORGANIZER - such as the respondees +availability.
+
+
+ Poll Modes + The VPOLL component is intended to allow for various forms of +polling. The particular form in efffect is indicated by the POLL- +MODE property. + New poll modes can be registered by including a completed POLL-MODE +Registration Template (see ) in a published RFC. +
POLL-MODE:BASICBASIC poll mode is the form of voting in which one possible outcome +is chosen from a set of possibilities. Usually this will be +represented as a number of possible event objects one of which will +be selected. +
Property restrictionsThis poll mode has the following property requirements: +
POLL-ITEM-ID
+Each contained sub-component that is being voted upon +MUST contain a POLL-ITEM_ID property which is unique within the +context of the POLL. The value MUST NOT be reused when events are +removed and/or added to the poll. +
POLL-WINNER
+On confirmation of the poll this property MUST be +present and identifies the winning component. +
+
Outcome reportingTo confirm the winner the POLL-WINNER property MUST be present and +the STATUS MUST be set to CONFIRMED. +When the winning VEVENT or VTODO is not a scheduled entity, that is, +it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER +property and a list of non-participating ATTENDEEs. This allows the +winning entity to be distributed to the participants through iTip or +some other protocol.
+
+
+ iTIP Extensions + This specification introduces a number of extensions to . +In group scheduling the parties involved are organizer and attendees. +In VPOLL the parties are organizer and voters. + For many of the iTip processing rules the voters take the place of +attendees. +
MethodsThere are some extensions to the behavior of iTip methods for a VPOLL +object and two new methods are defined. +
MethodDescription
+PUBLISH + +No changes (yet) +
+REQUEST + +Each child component MUST have a POLL-ITEM-ID +property. Each set of components with the same +POLL-ITEM-ID value represents one overall set of +items to be voted on. +
+REPLY + +There MUST be a single VPOLL component which +MUST have: either one or more POLL-ITEM-ID +properties with a RESPONSE param matching that +from a REQUEST or a VFREEBUSY or VAVAILABILITY +child component showing overall busy/available +time. The VPOLL MUST have one voter only. +
+ADD + +Not supported for VPOLL. +
+CANCEL + +There MUST be a single VPOLL component with UID +
+matching that of the poll being cancelled. +
+REFRESH + +The organizer returns a METHOD:REQUEST with the +current full state, or a METHOD:CANCEL or an +error if no matching poll is found. +
+COUNTER + +Not supported for VPOLL. +
+DECLINECOUNTER + +Not supported for VPOLL. +
+POLLSTATUS + +Used to send the current state of the poll to +all voters. The VPOLL can contain a reduced set +of properties but MUST contain DTSTAMP, SEQUENCE +(if not 0), UID, ORGANIZER and PARTICIPANTS. +
+The following table shows the above methods broken down by who can +send them with VPOLL components. +
OriginatorMethods
+Organizer + +CANCEL, PUBLISH, REQUEST, POLLSTATUS +
+Voter + +REPLY, REFRESH, REQUEST (only when delegating) +
+
Interoperability ModelsMost of the standard iTip specification applies with respect to +organizer and voters. +
Delegation + +TBD +
+
Acting on Behalf of Other Calendar Users + +TBD +
+
Component Revisions + +
    +
  • +Need to talk about what a change in SEQUENCE means +
  • +
  • +Sequence change forces a revote. +
  • +
  • +New voter - no sequence change +
  • +
  • +Add another poll set or change poll item ids or any change to a child +
  • +
  • +component - bump sequence +
  • +
+
+
Message Sequencing + +TBD +
+
Application Protocol Elements
Methods for VPOLL Calendar ComponentsThis section defines the property set restrictions for the method +types that are applicable to the "VPOLL" calendar component. Each +method is defined using a table that clarifies the property +constraints that define the particular method. +The presence column uses the following values to assert whether a +property is required or optional, and the number of times it may +appear in the iCalendar object. +
Presence ValueDescription
+1 + +One instance MUST be present. +
+1+ + +At least one instance MUST be present. +
+0 + +Instances of this property MUST NOT be present. +
+0+ + +Multiple instances MAY be present. +
+0 or 1 + +Up to 1 instance of this property MAY be present. +
+The following summarizes the methods that are defined for the "VPOLL" +calendar component. +
MethodDescription
+PUBLISH + +Post notification of an poll. Used primarily as a +method of advertising the existence of a poll. +
+REQUEST + +To make a request for a poll. This is an explicit +invitation to one or more voters. Poll requests are +also used to update, change or confirm an existing +poll. Clients that cannot handle REQUEST MAY degrade +the poll to view it as a PUBLISH. REQUEST SHOULD NOT +be used just to set the status of the poll - +POLLSTATUS provides a more compact approach. +
+REPLY + +Reply to a poll request. Voters may set their +RESPONSE parameter to supply the current vote in the +range 0 to 100. +
+CANCEL + +Cancel a poll. +
+REFRESH + +A request is sent to an Organizer by a Voter asking +for the latest version of a poll to be resent to the +requester. +
+POLLSTATUS + +Used to send the current state of the poll to all +voters. The VPOLL can contain a reduced set of +properties but MUST contain DTSTAMP, SEQUENCE (if +not 0), UID, ORGANIZER and PARTICIPANT. +
+
Method: PUBLISHThe "PUBLISH" method in a "VPOLL" calendar component is an +unsolicited posting of an iCalendar object. Any CU may add published +components to their calendar. The "Organizer" MUST be present in a +published iCalendar component. "Voters" MUST NOT be present. Its +expected usage is for encapsulating an arbitrary poll as an iCalendar +object. The "Organizer" may subsequently update (with another +"PUBLISH" method) or cancel (with a "CANCEL" method) a previously +published "VPOLL" calendar component. +
Note
+Not clear how useful this is but needs some work on transmitting the +current vote without any voter identification. +
+This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:PUBLISH of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST equal PUBLISH. +
+VPOLL + +1+ +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 + +If present defines the start of the poll. Otherwise the poll starts when it is created and distributed. +
+ORGANIZER + +1 +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0 or 1 +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+LAST-MODIFIED + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 or 1 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of COMPLETED/CONFIRMED/CANCELLED. +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+PARTICIPANT + +0+ + +Only PARTICIPANT components with PARTICIPANT-TYPE not equal to "VOTER" - that is, no voters +
+REQUEST-STATUS + +0 +
+VALARM + +0+ +
+VEVENT + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VFREEBUSY + +0 +
+VJOURNAL + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTODO + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+
Method: REQUESTThe "REQUEST" method in a "VPOLL" component provides the following +scheduling functions: +
    +
  • +Invite "Voters" to respond to the poll. +
  • +
  • +Change the items being voted upon. +
  • +
  • +Complete or confirm the poll. +
  • +
  • +Response to a "REFRESH" request. +
  • +
  • +Update the details of an existing vpoll. +
  • +
  • +Update the status of "Voters". +
  • +
  • +Forward a "VPOLL" to another uninvited CU. +
  • +
  • +For an existing "VPOLL" calendar component, delegate the role of +"Voter" to another CU. +
  • +
  • +For an existing "VPOLL" calendar component, change the role of +"Organizer" to another CU. +
  • +
+The "Organizer" originates the "REQUEST". The recipients of the +"REQUEST" method are the CUs voting in the poll, the "Voters". +"Voters" use the "REPLY" method to convey votes to the "Organizer". +The "UID" and "SEQUENCE" properties are used to distinguish the +various uses of the "REQUEST" method. If the "UID" property value in +the "REQUEST" is not found on the recipient's calendar, then the +"REQUEST" is for a new "VPOLL" calendar component. If the "UID" +property value is found on the recipient's calendar, then the +"REQUEST" is for an update, or a reconfirmation of the "VPOLL" +calendar component. +For the "REQUEST" method only a single iCalendar object is permitted. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REQUEST of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REQUEST. +
+VPOLL + +1 +
+PARTICIPANT + +1+ + +Identified as voters with the PARTICIPANT-TYPE=VOTER +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 + +If present defines the start of the poll. Otherwise the poll starts when it is created and distributed. +
+ORGANIZER + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 or 1 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+REQUEST-STATUS + +0 +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of COMPLETED/CONFIRMED/CANCELLED. +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+VALARM + +0+ +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VEVENT + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VFREEBUSY + +0 +
+VJOURNAL + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+VTODO + +0+ + +Depending upon the poll mode in effect there MAY be candidate components included in the poll component. +
+
Rescheduling a poll + +The "REQUEST" method may be used to reschedule a poll, that is force +a revote. A rescheduled poll involves a change to the existing poll +in terms of its time the components being voted on may have changed. +If the recipient CUA of a "REQUEST" method finds that the "UID" +property value already exists on the calendar but that the "SEQUENCE" +(or "DTSTAMP") property value in the "REQUEST" method is greater than +the value for the existing poll, then the "REQUEST" method describes +a rescheduling of the poll. +
+
Updating or Reconfirmation of a PollThe "REQUEST" method may be used to update or reconfirm a poll. An +update to an existing poll does not involve changes to the time or +candidates, and might not involve a change to the location or +description for the poll. If the recipient CUA of a "REQUEST" method +finds that the "UID" property value already exists on the calendar +and that the "SEQUENCE" property value in the "REQUEST" is the same +as the value for the existing poll, then the "REQUEST" method +describes an update of the poll details, but not a rescheduling of +the POLL. +The update "REQUEST" method is the appropriate response to a +"REFRESH" method sent from a "Voter" to the "Organizer" of a poll. +The "Organizer" of a poll may also send unsolicited "REQUEST" +methods. The unsolicited "REQUEST" methods may be used to update the +details of the poll without rescheduling it, to update the "RESPONSE" +parameter of "Voters", or to reconfirm the poll.
+
Confirmation of a Poll + +The "REQUEST" method may be used to confirm a poll, that is announce +the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and +for BASIC mode a VPOLL POLL-WINNER property must be provided with the +poll-id of the winning component. +
+
Closing a Poll + +The "REQUEST" method may be used to close a poll, that is indicate +voting is completed. The STATUS MUST be set to COMPLETED. +
+
Delegating a Poll to Another CUSome calendar and scheduling systems allow "Voters" to delegate the +vote to another "Calendar User". iTIP supports this concept using the +following workflow. Any "Voter" may delegate their right to vote in +a poll to another CU. The implication is that the delegate +participates in lieu of the original "Voter", NOT in addition to the +"Voter". The delegator MUST notify the "Organizer" of this action +using the steps outlined below. Implementations may support or +restrict delegation as they see fit. For instance, some +implementations may restrict a delegate from delegating a "REQUEST" +to another CU. +The "Delegator" of a poll forwards the existing "REQUEST" to the +"Delegate". The "REQUEST" method MUST include a "Voter" property +with the calendar address of the "Delegate". The "Delegator" MUST +also send a "REPLY" method to the "Organizer" with the "Delegator's" +"Voter" property "DELEGATED-TO" parameter set to the calendar address +of the "Delegate". Also, a new "Voter" property for the "Delegate" +MUST be included and must specify the calendar user address set in +the "DELEGATED-TO" parameter, as above. +In response to the request, the "Delegate" MUST send a "REPLY" method +to the "Organizer", and optionally to the "Delegator". The "REPLY" +method SHOULD include the "Voter" property with the "DELEGATED-FROM" +parameter value of the "Delegator's" calendar address. +The "Delegator" may continue to receive updates to the poll even +though they will not be attending. This is accomplished by the +"Delegator" setting their "role" attribute to "NON-PARTICIPANT" in +the "REPLY" to the "Organizer".
+
Changing the Organizer + +The situation may arise where the "Organizer" of a "VPOLL" is no +longer able to perform the "Organizer" role and abdicates without +passing on the "Organizer" role to someone else. When this occurs, +the "Voters" of the "VPOLL" may use out-of-band mechanisms to +communicate the situation and agree upon a new "Organizer". The new +"Organizer" should then send out a new "REQUEST" with a modified +version of the "VPOLL" in which the "SEQUENCE" number has been +incremented and the "ORGANIZER" property has been changed to the new +"Organizer". +
+
Sending on Behalf of the Organizer + +There are a number of scenarios that support the need for a "Calendar +User" to act on behalf of the "Organizer" without explicit role +changing. This might be the case if the CU designated as "Organizer" +is sick or unable to perform duties associated with that function. +In these cases, iTIP supports the notion of one CU acting on behalf +of another. Using the "SENT-BY" parameter, a "Calendar User" could +send an updated "VPOLL" "REQUEST". In the case where one CU sends on +behalf of another CU, the "Voter" responses are still directed back +towards the CU designated as "Organizer". +
+
Forwarding to an Uninvited CUA "Voter" invited to a "VPOLL" calendar component may send the +"VPOLL" calendar component to another new CU not previously +associated with the "VPOLL" calendar component. The current "Voter" +participating in the "VPOLL" calendar component does this by +forwarding the original "REQUEST" method to the new CU. The new CU +can send a "REPLY" to the "Organizer" of the "VPOLL" calendar +component. The reply contains a "Voter" property for the new CU. +The "Organizer" ultimately decides whether or not the new CU becomes +part of the poll and is not obligated to do anything with a "REPLY" +from a new (uninvited) CU. If the "Organizer" does not want the new +CU to be part of the poll, the new "Voter" property is not added to +the "VPOLL" calendar component. The "Organizer" MAY send the CU a +"CANCEL" message to indicate that they will not be added to the poll. +If the "Organizer" decides to add the new CU, the new "Voter" +property is added to the "VPOLL" calendar component. Furthermore, +the "Organizer" is free to change any "Voter" property parameter from +the values supplied by the new CU to something the "Organizer" +considers appropriate. The "Organizer" SHOULD send the new CU a +"REQUEST" message to inform them that they have been added. +When forwarding a "REQUEST" to another CU, the forwarding "Voter" +MUST NOT make changes to the original message.
+
Updating Voter Status + +The "Organizer" of an poll may also request updated status from one +or more "Voters". The "Organizer" sends a "REQUEST" method to the +"Voter" and sets the "RSVP=TRUE" property parameter on the PARTICIPANT CALENDAR-ADDRESS. The +"SEQUENCE" property for the poll is not changed from its previous +value. A recipient will determine that the only change in the +"REQUEST" is that their "RSVP" property parameter indicates a request +for updated status. The recipient SHOULD respond with a "REPLY" +method indicating their current vote with respect to the "REQUEST". +
+
Method: REPLYThe "REPLY" method in a "VPOLL" calendar component is used to respond +(e.g., accept or decline) to a "REQUEST" or to reply to a delegation +"REQUEST". When used to provide a delegation response, the +"Delegator" SHOULD include the calendar address of the "Delegate" on +the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR-ADDRESS" +property. The "Delegate" SHOULD include the calendar address of the +"Delegator" on the "DELEGATED-FROM" property parameter of the +"Delegate's" "CALENDAR-ADDRESS" property. +The "REPLY" method is also used when processing of a "REQUEST" fails. +Depending on the value of the "REQUEST-STATUS" property, no action +may have been performed. +The "Organizer" of a poll may receive the "REPLY" method from a CU +not in the original "REQUEST". For example, a "REPLY" may be +received from a "Delegate" to a poll. In addition, the "REPLY" +method may be received from an unknown CU (a "Party Crasher"). This +uninvited "Voter" may be accepted, or the "Organizer" may cancel the +poll for the uninvited "Voter" by sending a "CANCEL" method to the +uninvited "Voter". +A "Voter" MAY include a message to the "Organizer" using the +"COMMENT" property. For example, if the user indicates a low +interest and wants to let the "Organizer" know why, the reason can be +expressed in the "COMMENT" property value. +The "Organizer" may also receive a "REPLY" from one CU on behalf of +another. Like the scenario enumerated above for the "Organizer", +"Voters" may have another CU respond on their behalf. This is done +using the "SENT-BY" parameter. +The optional properties listed in the table below (those listed as +"0+" or "0 or 1") MUST NOT be changed from those of the original +request. (But see comments on VFREEBUSY and VAVAILABILITY) +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REPLY of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REPLY. +
+VPOLL + +1+ + +All components MUST have the same +
+UID. +
+PARTICIPANT + +1 + +Identifies the Voter replying. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+UID + +1 + +MUST be the UID of the original +
+REQUEST. +
+SEQUENCE + +0 or 1 + +If non-zero, MUST be the sequence number of the original REQUEST. MAY be present if 0. +
+ACCEPT-RESPONSE + +0 or 1 +
+ATTACH + +0+ +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DTSTART + +0 or 1 +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +1+ + +One per item being voted on. +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+REQUEST-STATUS + +0+ +
+STATUS + +0 or 1 +
+SUMMARY + +0 or 1 +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+VALARM + +0 +
+VTIMEZONE + +0 or 1 + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VEVENT + +0 +
+VFREEBUSY + +0 or 1 + +A voter may respond with a VFREEBUSY component indicating that the ORGANIZER may select some other time which is not marked as busy. +
+VAVAILABILITY + +0 + +A voter may respond with a VAVAILABILITY component indicating that the ORGANIZER may select some other time which is shown as available. +
+VJOURNAL + +0 +
+VTODO + +0 +
+
Method: CANCELThe "CANCEL" method in a "VPOLL" calendar component is used to send a +cancellation notice of an existing poll request to the affected +"Voters". The message is sent by the "Organizer" of the poll. +The "Organizer" MUST send a "CANCEL" message to each "Voter" affected +by the cancellation. This can be done using a single "CANCEL" +message for all "Voters" or by using multiple messages with different +subsets of the affected "Voters" in each. +When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be +incremented as described in . +Once a CANCEL message has been sent to all voters no further voting +may take place. The poll is considered closed. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:CANCEL of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be CANCEL. +
+VPOLL + +1+ + +All must have the same UID. +
+PARTICIPANT + +0+ + +MUST include some or all Voters being removed from the poll. MUST include some or all Voters if the entire poll is cancelled. +
+UID + +1 + +MUST be the UID of the original REQUEST. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+SEQUENCE + +1 +
+ATTACH + +0+ +
+ACCEPT-RESPONSE + +0 +
+COMMENT + +0+ +
+COMPLETED + +0 or 1 +
+CATEGORIES + +0+ +
+CLASS + +0 or 1 +
+CONTACT + +0+ +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DTSTART + +0 or 1 +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+GEO + +0 or 1 +
+LAST-MODIFIED + +0 or 1 +
+LOCATION + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MUST be set to CANCELLED to cancel the entire event. If uninviting specific Attendees, then MUST NOT be included. +
+SUMMARY + +0 or 1 +
+TRANSP + +0 or 1 +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+REQUEST-STATUS + +0 +
+VALARM + +0 +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VTODO + +0 +
+VJOURNAL + +0 +
+VEVENT + +0 +
+VFREEBUSY + +0 +
+
Method: REFRESHThe "REFRESH" method in a "VPOLL" calendar component is used by +"Voters" of an existing event to request an updated description from +the poll "Organizer". The "REFRESH" method must specify the "UID" +property of the poll to update. The "Organizer" responds with the +latest description and version of the poll. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:REFRESH of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST be REFRESH. +
+VPOLL + +1 +
+PARTICIPANT + +1 + +MUST identify the requester as a voter. +
+DTSTAMP + +1 +
+ORGANIZER + +1 +
+UID + +1 + +MUST be the UID associated with original REQUEST. +
+COMMENT + +0+ +
+COMPLETED + +0 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+ACCEPT-RESPONSE + +0 +
+ATTACH + +0 +
+CATEGORIES + +0 +
+CLASS + +0 +
+CONTACT + +0 +
+CREATED + +0 +
+DESCRIPTION + +0 +
+DTEND + +0 +
+DTSTART + +0 +
+DURATION + +0 +
+GEO + +0 +
+LAST-MODIFIED + +0 +
+LOCATION + +0 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 +
+RELATED-TO + +0 +
+REQUEST-STATUS + +0 +
+RESOURCES + +0 +
+SEQUENCE + +0 +
+STATUS + +0 +
+SUMMARY + +0 +
+URL + +0 +
+VALARM + +0 +
+VTIMEZONE + +0+ +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+VTODO + +0 +
+VJOURNAL + +0 +
+VEVENT + +0 +
+VFREEBUSY + +0 +
+
Method: POLLSTATUSThe "POLLSTATUS" method in a "VPOLL" calendar component is used to +inform recipients of the current status of the poll in a compact +manner. The "Organizer" MUST be present in the confirmed poll +component. All "Voters" MUST be present. The selected component(s) +according to the poll mode SHOULD NOT be present in the poll +component. Clients receiving this message may store the confirmed +items in their calendars. +This method type is an iCalendar object that conforms to the +following property constraints: +Constraints for a METHOD:POLLSTATUS of a VPOLL
Component/PropertyPresenceComment
+METHOD + +1 + +MUST equal POLLSTATUS. +
+VPOLL + +1+ +
+PARTICIPANT + +1+ + +The voters containing their current vote +
+COMPLETED + +0 or 1 + +Only present for a completed poll +
+DTSTAMP + +1 +
+DTSTART + +0 or 1 +
+ORGANIZER + +1 +
+SUMMARY + +1 + +Can be null. +
+UID + +1 +
+SEQUENCE + +0 or 1 + +MUST be present if value is greater than 0; MAY be present if 0. +
+ACCEPT-RESPONSE + +0 +
+ATTACH + +0 +
+CATEGORIES + +0 +
+CLASS + +0 +
+COMMENT + +0+ +
+CONTACT + +0 +
+CREATED + +0 or 1 +
+DESCRIPTION + +0 or 1 + +Can be null. +
+DTEND + +0 or 1 + +If present, DURATION MUST NOT be present. +
+DURATION + +0 or 1 + +If present, DTEND MUST NOT be present. +
+LAST-MODIFIED + +0 or 1 +
+POLL-ITEM-ID + +0 +
+POLL-MODE + +0 or 1 +
+POLL-PROPERTIES + +0 +
+PRIORITY + +0 or 1 +
+RELATED-TO + +0+ +
+RESOURCES + +0+ +
+STATUS + +0 or 1 + +MAY be one of TENTATIVE/CONFIRMED/CANCELLED. +
+URL + +0 or 1 +
+IANA-PROPERTY + +0+ +
+X-PROPERTY + +0+ +
+REQUEST-STATUS + +0 +
+VALARM + +0+ +
+VEVENT + +0 + +All candidate components SHOULD NOT be present. +
+VFREEBUSY + +0 +
+VJOURNAL + +0 + +All candidate components SHOULD NOT be present. +
+VTODO + +0 + +All candidate components SHOULD NOT be present. +
+VTIMEZONE + +0+ + +MUST be present if any date/time refers to a timezone. +
+IANA-COMPONENT + +0+ +
+X-COMPONENT + +0+ +
+
+
+ CalDAV Extensions + This specification extends in that it defines a new +component and new iCalendar properties to be supported and requires +extra definitions related to time-ranges and reports. + Additionally, it extends as it a VPOLL component is a +schedulable entity. +
Calendar Collection PropertiesThis section defines new CalDAV properties for calendar collections. +
CALDAV:supported-vpoll-component-sets
Name
+supported-vpoll-component-sets +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Specifies the calendar component types (e.g., VEVENT, +VTODO, etc.) and combination of types that may be included in a +VPOLL component. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
The CALDAV:supported-vpoll-component-sets property is +used to specify restrictions on the calendar component types that +VPOLL components may contain in a calendar collection.It also specifies the combination of allowed component types. +Any attempt by the client to store VPOLL components with component +types or combinations of types not listed in this property, if it +exists, MUST result in an error, with the CALDAV:supported-vpoll-component-sets +precondition being violated. Since +this property is protected, it cannot be changed by clients using +a PROPPATCH request. However, clients can initialize the value of +this property when creating a new calendar collection with +MKCALENDAR. In the absence of this property, the server MUST +accept all component types, and the client can assume that all +component types are accepted.
Definition
+
+ +
+
+
CALDAV:vpoll-max-items
Name
+vpoll-max-items +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Provides a numeric value indicating the maximum number of +items that may be contained in any instance of a VPOLL calendar +object resource stored in the calendar collection. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-items is used to specify a numeric +value that indicates the maximum number of iCalendar components in +any one instance of a VPOLL calendar object resource stored in a +calendar collection. Any attempt to store a calendar object +resource with more components per instance than this value MUST +result in an error, with the CALDAV: vpoll-max-items precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of items +in a VPOLL calendar component. +
Definition
+
+ +
+
+
CALDAV:vpoll-max-active
Name
+vpoll-max-active +
Namespace
+urn:ietf:params:xml:ns:caldav +
Purpose
+Provides a numeric value indicating the maximum number of +active vpolls at any one time. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-active is used to specify a +numeric value that indicates the maximum number of active VPOLLs +at any one time. Any attempt to store a new active VPOLL calendar +object resource which results in exceeding this limit MUST result +in an error, with the CALDAV:vpoll-max-active precondition + being violated. In the absence of this property, the +client can assume that the server can handle any number of active +VPOLLs. +
Definition
+
+ +
+
+
CALDAV:vpoll-max-voters
Name
+ +vpoll-max-voters + +
Namespace
+ +urn:ietf:params:xml:ns:caldav + +
Purpose
+Provides a numeric value indicating the maximum number of +voters for any instance of a VPOLL calendar object resource stored +in the calendar collection. +
Conformance
+This property MAY be defined on any calendar +collection. If defined, it MUST be protected and SHOULD NOT be +returned by a PROPFIND DAV:allprop request (as defined in +). +
Description
+The CALDAV:vpoll-max-voters is used to specify a +numeric value that indicates the maximum number of voters for any one instance of a VPOLL calendar object +resource stored in a calendar collection. Any attempt to store a +calendar object resource with more voters per instance +than this value MUST result in an error, with the CALDAV: +vpoll-max-voters precondition +being violated. In the absence of this property, the client can +assume that the server can handle any number of voters in a VPOLL +calendar component. +
Definition
+
+ +
+
+
CalDAV:even-more-properties + +
+
Extensions to CalDAV schedulingThis specification extends . +Each section of Appendix A "Scheduling Privileges Summary" is +extended to include VPOLL. +Any reference to the ATTENDEE property should be read to include the +CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. +That is, for scheduling purposes the CALENDAR-ADDRESS property +is handled in exactly the same manner as the ATTENDEE property.
+
Additional Preconditions for PUT, COPY, and MOVEThis specification creates additional Preconditions for PUT, COPY, +and MOVE methods. These preconditions apply when a PUT operation of +a VPOLL calendar object resource into a calendar collection occurs, +or when a COPY or MOVE operation of a calendar object resource into a +calendar collection occurs, or when a COPY or MOVE operation occurs +on a calendar collection. +The new preconditions are: +
(CALDAV:supported-vpoll-component-sets)
+The VPOLL resource +submitted in the PUT request, or targeted by a COPY or MOVE +request, MUST contain a type or combination of calendar component +that is supported in the targeted calendar collection; +
(CALDAV:vpoll-max-items)
+The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of sub-components (excluding VTIMEZONE) less than or equal to the +value of the CALDAV:vpoll-max-items property value +on the calendar collection where the resource will be stored; +
(CALDAV:vpoll-max-active)
+The PUT request, or COPY or MOVE request, +MUST not result in the number of active VPOLLs being greater than +the value of the CALDAV:vpoll-max-active property value + on the calendar collection where the resource will +be stored; +
(CALDAV:vpoll-max-voters)
+The VPOLL resource submitted in the PUT +request, or targeted by a COPY or MOVE request, MUST have a number +of voters represented by PARTICIPANT components less than or equal to the value of the +CALDAV:vpoll-max-voters property value on the +calendar collection where the resource will be stored; +
+
CalDAV:calendar-query ReportThis allows the retrieval of VPOLLs and their included components. +The query specification allows queries to be directed at the +contained sub-components. For VPOLL queries this feature is +disallowed. Time-range queries can only target the vpoll component +itself. +
Example: Partial Retrieval of VPOLLIn this example, the client requests the server to return specific +components and properties of the VPOLL components that overlap the +time range from December 4, 2012, at 00:00:00 A.M. UTC to December +5, 2012, at 00:00:00 A.M. UTC. In addition, the DAV:getetag +property is also requested and returned as part of the response. +Note that due to the CALDAV: calendar-data element restrictions, the +DTSTAMP property in VPOLL components has not been returned, and the +only property returned in the VCALENDAR object is VERSION. +
+
+
CalDAV time ranges"CALDAV:time-range XML Element" in describes +how to specify time ranges to limit the set of calendar components +returned by the server. This specification extends to +describe the meaning of time ranges for VPOLL +A VPOLL component is said to overlap a given time range if the +condition for the corresponding component state specified in the +table below is satisfied. The conditions depend on the presence of +the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the +VPOLL component. Note that, as specified above, the DTEND value MUST +be a DATE-TIME value equal to or after the DTSTART value if +specified. +
+
+
+
+ Security Considerations + Applications using these property need to be aware of the risks +entailed in using the URIs provided as values. See for a +discussion of the security considerations relating to URIs. +
+
+ IANA Considerations +
Parameter RegistrationsThis document defines the following new iCalendar property parameters +to be added to the registry defined in : +
Property ParameterStatusReference
+REQUIRED + +Current + + + + +
+STAY-INFORMED + +Current + + + + +
+
Property RegistrationsThis document defines the following new iCalendar properties to be +added to the registry defined in : +
PropertyStatusReference
+ACCEPT-RESPONSE + +Current + + + + +
+POLL-ITEM-ID + +Current + + + + +
+POLL-MODE + +Current + + + + +
+POLL-PROPERTIES + +Current + + + + +
+POLL-WINNER + +Current + + + + +
+RESPONSE + +Current + + + + +
+
POLL-MODE Registration TemplateA poll mode is defined by completing the following template. +
Poll mode name
+The name of the poll mode. +
Purpose
+The purpose of the poll mode. Give a short but clear +description. +
Reference
+A reference to the RFC in which the poll mode is defined +
+
POLL-MODE RegistrationsThis document defines the following registered poll modes. +
Poll mode namePurposeReference
+BASIC + +To provide simple voting for a single outcome from a number of candidates. + +Current +
+
+
+ + + Normative References + + + HTTP Extensions for Distributed Authoring — WEBDAV + + + + + + + + This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collision avoidance). [STANDARDS-TRACK] + + + + + IETF RFC 2518 + + + + + + Uniform Resource Identifier (URI): Generic Syntax + + + + + + A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] + + + + + IETF RFC 3986 + + + + + + Calendaring Extensions to WebDAV (CalDAV) + + + + + + This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the "calendar-access" feature of CalDAV. [STANDARDS-TRACK] + + + + + IETF RFC 4791 + + + + + + Internet Calendaring and Scheduling Core Object Specification (iCalendar) + + + + This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] + + + + + IETF RFC 5545 + + + + + + iCalendar Transport-Independent Interoperability Protocol (iTIP) + + + + This document specifies a protocol that uses the iCalendar object specification to provide scheduling interoperability between different calendaring systems. This is done without reference to a specific transport protocol so as to allow multiple methods of communication between systems. Subsequent documents will define profiles of this protocol that use specific, interoperable methods of communication between systems.The iCalendar Transport-Independent Interoperability Protocol (iTIP) complements the iCalendar object specification by adding semantics for group scheduling methods commonly available in current calendaring systems. These scheduling methods permit two or more calendaring systems to perform transactions such as publishing, scheduling, rescheduling, responding to scheduling requests, negotiating changes, or canceling. [STANDARDS-TRACK] + + + + + IETF RFC 5546 + + + + + + iCalendar Message-Based Interoperability Protocol (iMIP) + + + + This document, "iCalendar Message-Based Interoperability Protocol (iMIP)", specifies a binding from the iCalendar Transport-independent Interoperability Protocol (iTIP) to Internet email-based transports. Calendaring entries defined by the iCalendar Object Model (iCalendar) are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC 2046, RFC 2047, and RFC 2049), and then transported over SMTP. [STANDARDS-TRACK] + + + + + IETF RFC 6047 + + + + + + Scheduling Extensions to CalDAV + + + + + This document defines extensions to the Calendaring Extensions to WebDAV (CalDAV) "calendar-access" feature to specify a standard way of performing scheduling operations with iCalendar-based calendar components. This document defines the "calendar-auto-schedule" feature of CalDAV. [STANDARDS-TRACK] + + + + + IETF RFC 6638 + + + + + + + AUTOFILL + + + IETF IETF I-D.draft-ietf-calext-eventpub-extensions + + + + + Bibliography + +
+ Open issues + public-comment: Not documented and was a parameter on something. +Really sounds like a PARTICIPANT or VOTE property + Notifications: Need to do a section on what Notifications to + support. + A. VPOLL is about to end and you haven't voted on it yet. + Instead reuse VALARMS to notify the user? + Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. + Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any + events booked as a result of confirmation. + MUST winning event be cancelled for POLL-MODE basic? No - voter + has indicated now unable to attend - want to revote + Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. + Requires retention of VPOLL + retention period + Removed status + ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create + a poll with a set of events where I am just the attendee of the + events. Are there any other restrictions for components in a + VPOLL? + Add to security consideration + Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event. + Need to write down what isn't valid in a VPOLL + a. Can't change POLL-MODE + Guide for ATTENDEE roles + chair, NON-PARTICIPANT etc + ? - some iTip notes On confirm - send itip if appropriate (PUBLISH) + - all non-participating - shared - feeds + Organizer can specify where result is? + Confirm can specify that itip is sent - ITIP / NONE - parameter ? + on POLL-WINNER + Need to add example of freebusy in response +
+ +
+
+
+ Change log +
+
Calext V01: 2019-10-17 MD
+
+Replace VVOTER and VOTER with PARTICIPANT. +
+
Calext V00: 2019-05-17 MD
+
+First calext version. Moved source to metanorma. No changes to specification. +
+
V03: 2014-10-28 MD
+
+
    +
  • +Add VVOTER and VOTE components. +
  • +
  • +Add RESPONSE property. +
  • +
  • +Remove RESPONSE parameter from VOTER. +
  • +
+
+
V03: 2014-05-12 MD
+
+
    +
  • +Add reply-url property and required parameter. +
  • +
  • +Fix ACCEPT-RESPONSE definition. +
  • +
+
+
V02: 2014-05-12 MD
+
+
    +
  • +Typos fixed, clarifications made. +
  • +
  • +Removed spurious COMMENT param. Switched some to PUBLIC-COMMENT +
  • +
  • +Changed STAY-INFORMED to remove boolean value type and state +explicit TRUE/FALSE values. +
  • +
  • +iTip: Allow VPOLL DTSTART to be optional and allow VAVAILABILITY +as subcomponent +
  • +
  • +iTip: fix broken table cells +
  • +
  • +Add POLL-PROPERTIES, POLL-WINNER to 5545 extensions table +
  • +
  • +Added Caldav scheduling section +
  • +
+
+
V01: 2013-08-07 MD
+
+
    +
  • +Removed method CONFIRM +
  • +
  • +Removed pollitemid from VPOLL abnf. Added text for pollwinner +
  • +
  • +Added POLL-WINNER and verbiage +
  • +
  • +Added STATUS values +
  • +
  • +Added RELTYPE=POLL +
  • +
  • +Added supported-vpoll-component-sets +
  • +
  • +Added CalDAV related parameters to VOTER +
  • +
  • +Removed bad CalDAV query example. State that queries cannot +target the sub-components. +
  • +
+
+
Initial version: 2012-11-02 MD
+
+
+
+
+
diff --git a/sources/draft-ietf-calext-vpoll.txt b/sources/draft-ietf-calext-vpoll.txt new file mode 100644 index 0000000..d15a930 --- /dev/null +++ b/sources/draft-ietf-calext-vpoll.txt @@ -0,0 +1,3472 @@ + + + + +Network Working Group E. York +Internet-Draft +Intended status: Standards Track C. Daboo +Expires: 17 January 2021 + M. Douglass + 16 July 2020 + + + VPOLL: Consensus Scheduling Component for iCalendar + draft-ietf-calext-vpoll-00 + +Abstract + + This specification introduces a new iCalendar component which allows + for consensus scheduling, that is, voting on a number of alternative + meeting or task alternatives. + +Status of This Memo + + This Internet-Draft is submitted in full conformance with the + provisions of BCP 78 and BCP 79. + + Internet-Drafts are working documents of the Internet Engineering + Task Force (IETF). Note that other groups may also distribute + working documents as Internet-Drafts. The list of current Internet- + Drafts is at https://datatracker.ietf.org/drafts/current/. + + Internet-Drafts are draft documents valid for a maximum of six months + and may be updated, replaced, or obsoleted by other documents at any + time. It is inappropriate to use Internet-Drafts as reference + material or to cite them other than as "work in progress." + + This Internet-Draft will expire on 17 January 2021. + +Copyright Notice + + Copyright (c) 2020 IETF Trust and the persons identified as the + document authors. All rights reserved. + + This document is subject to BCP 78 and the IETF Trust's Legal + Provisions Relating to IETF Documents (https://trustee.ietf.org/ + license-info) in effect on the date of publication of this document. + Please review these documents carefully, as they describe your rights + and restrictions with respect to this document. Code Components + extracted from this document must include Simplified BSD License text + as described in Section 4.e of the Trust Legal Provisions and are + provided without warranty as described in the Simplified BSD License. + + + + +York, et al. Expires 17 January 2021 [Page 1] + +Internet-Draft VPOLL July 2020 + + +Table of Contents + + 1. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 3 + 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 + 3. Terms and definitions . . . . . . . . . . . . . . . . . . . . 4 + 3.1. consensus scheduling . . . . . . . . . . . . . . . . . . 4 + 3.2. active Vpoll . . . . . . . . . . . . . . . . . . . . . . 4 + 3.3. voter . . . . . . . . . . . . . . . . . . . . . . . . . . 4 + 4. Simple Consensus Scheduling . . . . . . . . . . . . . . . . . 5 + 4.1. The VPOLL Component: An Overview . . . . . . . . . . . . 5 + 4.2. The VPOLL Alternative Choices: An Overview . . . . . . . 7 + 4.3. VPOLL responses . . . . . . . . . . . . . . . . . . . . . 8 + 4.4. VPOLL updates . . . . . . . . . . . . . . . . . . . . . . 9 + 4.5. VPOLL Completion . . . . . . . . . . . . . . . . . . . . 11 + 4.6. Other Responses . . . . . . . . . . . . . . . . . . . . . 12 + 5. iCalendar Extensions . . . . . . . . . . . . . . . . . . . . 12 + 5.1. Updated Participant Type Value . . . . . . . . . . . . . 12 + 5.2. Updated Relation Type Value . . . . . . . . . . . . . . . 12 + 5.3. Updated Status Value . . . . . . . . . . . . . . . . . . 13 + 5.4. New Property Parameters . . . . . . . . . . . . . . . . . 13 + 5.4.1. Required . . . . . . . . . . . . . . . . . . . . . . 13 + 5.4.2. Stay-Informed . . . . . . . . . . . . . . . . . . . . 14 + 5.5. New Properties . . . . . . . . . . . . . . . . . . . . . 14 + 5.5.1. Accept-Response . . . . . . . . . . . . . . . . . . . 14 + 5.5.2. Poll-Completion . . . . . . . . . . . . . . . . . . . 15 + 5.5.3. Poll-Item-Id . . . . . . . . . . . . . . . . . . . . 16 + 5.5.4. Poll-Mode . . . . . . . . . . . . . . . . . . . . . . 17 + 5.5.5. Poll-properties . . . . . . . . . . . . . . . . . . . 17 + 5.5.6. Poll-Winner . . . . . . . . . . . . . . . . . . . . . 18 + 5.5.7. Reply-URL . . . . . . . . . . . . . . . . . . . . . . 19 + 5.5.8. Response . . . . . . . . . . . . . . . . . . . . . . 19 + 5.6. New Components . . . . . . . . . . . . . . . . . . . . . 20 + 5.6.1. VPOLL Component . . . . . . . . . . . . . . . . . . . 20 + 5.6.2. VOTE Component . . . . . . . . . . . . . . . . . . . 22 + 6. Poll Modes . . . . . . . . . . . . . . . . . . . . . . . . . 23 + 6.1. POLL-MODE:BASIC . . . . . . . . . . . . . . . . . . . . . 24 + 6.1.1. Property restrictions . . . . . . . . . . . . . . . . 24 + 6.1.2. Outcome reporting . . . . . . . . . . . . . . . . . . 24 + 7. iTIP Extensions . . . . . . . . . . . . . . . . . . . . . . . 24 + 7.1. Methods . . . . . . . . . . . . . . . . . . . . . . . . . 24 + 7.2. Interoperability Models . . . . . . . . . . . . . . . . . 26 + 7.2.1. Delegation . . . . . . . . . . . . . . . . . . . . . 26 + 7.2.2. Acting on Behalf of Other Calendar Users . . . . . . 26 + 7.2.3. Component Revisions . . . . . . . . . . . . . . . . . 26 + 7.2.4. Message Sequencing . . . . . . . . . . . . . . . . . 26 + 7.3. Application Protocol Elements . . . . . . . . . . . . . . 26 + 7.3.1. Methods for VPOLL Calendar Components . . . . . . . . 26 + 7.3.2. Method: PUBLISH . . . . . . . . . . . . . . . . . . . 28 + + + +York, et al. Expires 17 January 2021 [Page 2] + +Internet-Draft VPOLL July 2020 + + + 7.3.3. Method: REQUEST . . . . . . . . . . . . . . . . . . . 31 + 7.3.4. Method: REPLY . . . . . . . . . . . . . . . . . . . . 37 + 7.3.5. Method: CANCEL . . . . . . . . . . . . . . . . . . . 40 + 7.3.6. Method: REFRESH . . . . . . . . . . . . . . . . . . . 43 + 7.3.7. Method: POLLSTATUS . . . . . . . . . . . . . . . . . 45 + 8. CalDAV Extensions . . . . . . . . . . . . . . . . . . . . . . 47 + 8.1. Calendar Collection Properties . . . . . . . . . . . . . 47 + 8.1.1. CALDAV:supported-vpoll-component-sets . . . . . . . . 47 + 8.1.2. CALDAV:vpoll-max-items . . . . . . . . . . . . . . . 49 + 8.1.3. CALDAV:vpoll-max-active . . . . . . . . . . . . . . . 50 + 8.1.4. CALDAV:vpoll-max-voters . . . . . . . . . . . . . . . 51 + 8.1.5. CalDAV:even-more-properties . . . . . . . . . . . . . 51 + 8.1.6. Extensions to CalDAV scheduling . . . . . . . . . . . 51 + 8.2. Additional Preconditions for PUT, COPY, and MOVE . . . . 52 + 8.3. CalDAV:calendar-query Report . . . . . . . . . . . . . . 52 + 8.3.1. Example: Partial Retrieval of VPOLL . . . . . . . . . 53 + 8.4. CalDAV time ranges . . . . . . . . . . . . . . . . . . . 55 + 9. Security Considerations . . . . . . . . . . . . . . . . . . . 56 + 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 56 + 10.1. Parameter Registrations . . . . . . . . . . . . . . . . 57 + 10.2. Property Registrations . . . . . . . . . . . . . . . . . 57 + 10.3. POLL-MODE Registration Template . . . . . . . . . . . . 57 + 10.4. POLL-MODE Registrations . . . . . . . . . . . . . . . . 58 + 11. Normative References . . . . . . . . . . . . . . . . . . . . 58 + 12. Bibliography . . . . . . . . . . . . . . . . . . . . . . . . 59 + Appendix A. Open issues . . . . . . . . . . . . . . . . . . . . 59 + Appendix B. Change log . . . . . . . . . . . . . . . . . . . . . 60 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 61 + +1. Acknowledgements + + The authors would like to thank the members of the Calendaring and + Scheduling Consortium (CalConnect) for contributing their ideas and + support. + +2. Introduction + + The currently existing approach to agreeing on meeting times using + iTip [RFC5546] and/or iMip [RFC6047] has some significant failings. + There is no useful bargaining or suggestion mechanism in iTip, only + the ability for a potential attendee to accept or refuse or to + counter with a time of their own choosing. + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 3] + +Internet-Draft VPOLL July 2020 + + + Part of the problem is that for many potential attendees, their + freebusy is not an accurate representation of their availability. In + fact, when trying to schedule conference calls across different + organizations, attendees may not be allowed to provide freebusy + information or availability as this may reveal something of the + organizations internal activities. + + A number of studies have shown that large amounts of time are spent + trying to come to an agreement - up to and beyond 20 working hours + per meeting. Many organizers fall back on other approaches such as + phone calls and email to determine a suitable time. + + Online services have appeared as a result and these allow + participants to vote on a number of alternatives without revealing or + using freebusy or availability. When agreement is reached a + conventional scheduling message may be sent to the attendees. This + approach appears to reach consensus fairly rapidly. Peer pressure + may have some bearing on this as all voters are usually able to see + the current state of the voting and may adjust their own meeting + schedules to make themselves available for a popular choice. + + The component and properties defined in this specification provide a + standardized structure for this process and allow calendar clients + and servers and web based services to interact. + + These structures also have uses beyond the relatively simple needs of + most meeting organizers. The process of coming to consensus can also + be viewed as a bidding process. + +3. Terms and definitions + + For the purposes of this document, the following terms and + definitions apply. + +3.1. consensus scheduling + + The process whereby users come to some agreement on meeting or task + alternatives and then book that meeting or task. + +3.2. active Vpoll + + A VPoll may have a DTSTART, DTEND and DURATION which may define the + start and end of the active voting period + +3.3. voter + + A participant who votes on the alternatives. A voter need not be an + attendee of any of the alternatives presented. + + + +York, et al. Expires 17 January 2021 [Page 4] + +Internet-Draft VPOLL July 2020 + + +4. Simple Consensus Scheduling + + This specification defines components and properties which can be + used for simple consensus scheduling but also have the generality to + handle more complex cases. To provide an easy (and for many - + sufficient) introduction to consensus scheduling and VPOLL we will + outline the flow of information for the simple case of voting on a + number of meeting alternatives which differ only in time. In + addition the voters will all be potential attendees. + + This specification not only defines data structures but adds a new + iTip method used when consensus has been reached. This document will + show how a VPOLL object is used to inform voters of the state of a + simple vote on some alternatives. + +4.1. The VPOLL Component: An Overview + + The VPOLL component acts as a wrapper for a number of alternatives to + be voted on, together with some properties and a new component used + to maintain the state of the voting. For our simple example the + following VPOLL properties and sub-components are either required or + appropriate: + + DTSTAMP The usual [RFC5545] property. + + SEQUENCE The usual [RFC5545] property. See below for SEQUENCE + behavior. + + UID The usual [RFC5545] property. + + ORGANIZER The usual [RFC5545] property. In general this need not be + an organizer of any of the alternatives. In this simple outline + we assume it is the same. + + SUMMARY The usual [RFC5545] property. This optional but recommended + property provides the a short title to the poll. + + DESCRIPTION The usual [RFC5545] property. This optional property + provides more details. + + DTEND The usual [RFC5545] property. This optional property provides + a poll closing time and date after which the VPOLL is no longer + active. + + POLL-MODE A new property which defines how the votes are used to + obtain a result. For our use case it will take the value "BASIC" + meaning one event will be chosen from the alternatives. + + + + +York, et al. Expires 17 January 2021 [Page 5] + +Internet-Draft VPOLL July 2020 + + + POLL-COMPLETION A new property which defines who (server or client) + chooses and/or submits the winning choice. In our example the + value is "SERVER-SUBMIT" which means the client chooses the winner + but the server will submit the winning choice. + + POLL-PROPERTIES A new property which defines which icalendar + properties are being voted on. For our use case it will take the + value "DTSTART, LOCATION" meaning only those properties are + significant for voting. Other properties in the events may differ + but are not considered significant for the voting process. + + PARTICIPANT There is one of these components for each voter with the + PARTICIPANT-TYPE set to "VOTER". The CALENDAR-ADDRESS property + identifies the voter and this component will contain one VOTE + component for each item being voted on. + + VOTE A new component. There is one of these for each voter and + choice. It usually contains at least a POLL-ITEM-ID property to + identify the choice and a RESPONSE property to provide a vote. + For more complex poll modes it may contain other information such + as cost or estimated duration. + + VEVENT In our simple use case there will be multiple VEVENT sub- + components defining the alternatives. Each will have a different + date and or time for the meeting. + + EXAMPLE + + VPOLL with 3 voters and 3 alternative meetings: + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 6] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD:REQUEST + BEGIN:VPOLL + POLL-MODE:BASIC + POLL-COMPLETION:SERVER-SUBMIT + POLL-PROPERTIES:DTSTART,LOCATION + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T000000Z + SUMMARY:What to do this week + DTEND:20120101T000000Z + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + END PARTICIPANT + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + END PARTICIPANT + BEGIN: PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:mike@example.com + END PARTICIPANT + BEGIN:VEVENT.......(with a poll-item-id=1) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=2) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=3) + END:VEVENT + END:VPOLL + END:VCALENDAR + + Figure 1 + + As can be seen in the example above, there is an iTip METHOD property + with the value REQUEST. The VPOLL object will be distributed to all + the voters, either through iMip or through some VPOLL enabled + service. + +4.2. The VPOLL Alternative Choices: An Overview + + Within the VPOLL component we have the alternatives to vote on. In + many respects these are standard [RFC5545] components. For our + simple use case they are all VEVENT components. In addition to the + usual [RFC5545] properties some extra properties are used for a + VPOLL. + + + +York, et al. Expires 17 January 2021 [Page 7] + +Internet-Draft VPOLL July 2020 + + + POLL-ITEM-ID This provides a unique reference to the sub-component + within the VPOLL. It's value SHOULD be a small integer. + +4.3. VPOLL responses + + Upon receipt of a VPOLL REQUEST the voter will reply with a VPOLL + component containing their vote. In our simple case it will have the + following properties and components: + + DTSTAMP The usual [RFC5545] property. + + SEQUENCE The usual [RFC5545] property. See below for SEQUENCE + behavior. + + UID Same as the request. + + ORGANIZER Same as the request. + + SUMMARY Same as the request. + + PARTICIPANT One only with a CALENDAR-ADDRESS identifying the voter + replying. + + VOTE One per item being voted on. + + POLL-ITEM-ID One inside each VOTE component to identify the choice. + + RESPONSE One inside each VOTE component to specify the vote. + + Note that a voter can send a number of REPLYs for each REQUEST sent + by the organizer. Each REPLY completely replaces the voting record + for that voter for all components being voted on. In our example, if + Eric responds and votes for items 1 and 2 and then responds again + with a vote for only item 3, the final outcome is one vote on item 3. + + NOTE This is poll-mode specific behavior? + + EXAMPLE + + REPLY VPOLL from Cyrus: + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 8] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: REPLY + BEGIN:VPOLL + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T010000Z + SUMMARY:What to do this week + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + BEGIN:VOTE + POLL-ITEM-ID:1 + RESPONSE:50 + COMMENT:Work on iTIP + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + COMMENT:Work on WebDAV + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 2 + +4.4. VPOLL updates + + When the organizer receives a response from one or more voters the + current state of the poll is sent to all voters. The new iTip method + POLLSTATUS is used. The VPOLL can contain a reduced set of + properties but MUST contain DTSTAMP, SEQUENCE (if not 0), UID, + ORGANIZER and one or more PARTICIPANT components each populated with + zero or more VOTE components. + + EXAMPLE + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 9] + +Internet-Draft VPOLL July 2020 + + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: POLLSTATUS + BEGIN:VPOLL + ORGANIZER:mailto:mike@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T020000Z + SEQUENCE:0 + SUMMARY:What to do this week + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:cyrus@example.com + BEGIN: VOTE + POLL-ITEM-ID:1 + RESPONSE:50 + COMMENT:Work on iTIP + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + COMMENT:Work on WebDAV + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + BEGIN:VOTE + POLL-ITEM-ID:1 + RESPONSE:100 + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:2 + RESPONSE:100 + END:VOTE + BEGIN:VOTE + POLL-ITEM-ID:3 + RESPONSE:0 + END:VOTE + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 3 + + + +York, et al. Expires 17 January 2021 [Page 10] + +Internet-Draft VPOLL July 2020 + + +4.5. VPOLL Completion + + After a number of REPLY messages have been received the poll will be + considered complete. If there is a DTEND on the poll the system may + automatically close the poll, or the organizer may, at any time, + consider the poll complete. A VPOLL can be completed (and + effectively closed for voting) by sending an iTip REQUEST message + with the VPOLL STATUS property set to COMPLETED. + + The poll winner is confirmed by sending a final iTip REQUEST message + with the VPOLL STATUS property set to CONFIRMED. In this case the + VPOLL component contains all the events being voted on along with a + POLL-WINNER property to identify the winning event. As the POLL- + COMPLETION property is set to SERVER-SUBMIT the server will submit + the winning choice and when it has done so set the STATUS to + "SUBMITTED". + + EXAMPLE + + VPOLL confirmation: + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//Example//Example + METHOD: REQUEST + BEGIN:VPOLL + ORGANIZER:mailto:douglm@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T030000Z + COMPLETED:20120101T030000Z + POLL-COMPLETION:SERVER-SUBMIT + SEQUENCE:0 + SUMMARY:What to do this week + STATUS:CONFIRMED + POLL-WINNER:3 + BEGIN:VEVENT.......(with a poll-item-id=1) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=2) + END:VEVENT + BEGIN:VEVENT.......(with a poll-item-id=3) + END:VEVENT + END:VPOLL + END:VCALENDAR + + Figure 4 + + + + + + +York, et al. Expires 17 January 2021 [Page 11] + +Internet-Draft VPOLL July 2020 + + +4.6. Other Responses + + A voter being asked to choose between a number of ORGANIZER supplied + alternatives may find none of them acceptable or may simply not care. + + An alternative response, which may be disallowed by the ORGANIZER, is + to send back the respondees availability or freebusy or even one or + more new, alternative choices. + + This is accomplished by responding with a VOTE component which has no + POLL-ITEM-ID property. In this case it MUST contain some alternative + information. What form this takes depends on the poll mode in + effect. + +5. iCalendar Extensions + +5.1. Updated Participant Type Value + + Participant type property values are defined in section 11.2.1. of + [I-D.draft-ietf-calext-eventpub-extensions]. This specification + updates that type to include the new participant type VOTER to + provide information about the voter and to contain their votes. + + Format Definition This property parameter is redefined by the + following notation: + + partvalue /= "VOTER" + + Figure 5 + + Description The new property value indicates that the associated + PARTICIPANT component identifies a voter in a VPOLL. + +5.2. Updated Relation Type Value + + Relationship parameter type values are defined in section 3.2.15. of + [RFC5545]. This specification updates that type to include the new + relationship value POLL to provide a link to the VPOLL component in + which the current component appears. + + Format Definition This property parameter is redefined by the + following notation: + + reltypeparam /= "RELTYPE" "=" "POLL" + ; Property value is a VPOLL uid + + Figure 6 + + + + +York, et al. Expires 17 January 2021 [Page 12] + +Internet-Draft VPOLL July 2020 + + + Description This parameter can be specified on a property that + references another related calendar component. The new parameter + value indicates that the associated property references a VPOLL + component which contains the current component. + +5.3. Updated Status Value + + Status property values are defined in section 3.8.1.11. of [RFC5545]. + This specification updates that type to define valid VPOLL status + values. + + Format Definition This property parameter is redefined by the + following notation: + + statvalue /= statvalue-poll + ; Status values for "VPOLL". + statvalue-poll = "IN-PROCESS" + / "COMPLETED" ; Poll has closed, + ; nothing has been chosen yet + / "CONFIRMED" ; Poll has closed and + ; winning items confirmed + / "SUBMITTED" ; The winning item has been + ; submitted + / "CANCELLED" + + Figure 7 + + Description These values allow clients and servers to handle the + choosing and submission of winning choices. + + If the client is choosing and the server submitting then the + client should set the POLL-WINNER property, set the status to + CONFIRMED and save the poll. When the server submits the winning + choice it will set the status to SUBMITTED. + + Figure 8 + +5.4. New Property Parameters + +5.4.1. Required + + Parameter name REQUIRED + + Purpose To specify whether the associated property is required in + the current context. + + Format Definition This parameter is defined by the following + notation: + + + +York, et al. Expires 17 January 2021 [Page 13] + +Internet-Draft VPOLL July 2020 + + + requirededparam = "REQUIRED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + + Figure 9 + + Description This parameter MAY be specified on REPLY-URL and, if the + value is TRUE, indicates the organizer requires all replies to be + made via the specified service rather than iTip replies. + +5.4.2. Stay-Informed + + Parameter name STAY-INFORMED + + Purpose To specify the voter also wants to be added as an ATTENDEE + when the poll is confirmed. + + Format Definition This parameter is defined by the following + notation: + + stayinformedparam = "STAY-INFORMED" "=" ("TRUE" / "FALSE") + ; Default is FALSE + + Figure 10 + + Description This parameter MAY be specified on the CALENDAR-ADDRESS + property in the PARTICIPANT component and, if the value is TRUE, + indicates the voter wishes to be added to the final choice as a + non participant. + +5.5. New Properties + +5.5.1. Accept-Response + + Property name ACCEPT-RESPONSE + + Purpose This property is used in VPOLL to indicate the types of + component that may be supplied in a response. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description When used in a VPOLL this property indicates what + allowable component types may be returned in a reply. Typically + this would allow a voter to respond with their freebusy or + availability rather than choosing one of the presented + alternatives. + + + +York, et al. Expires 17 January 2021 [Page 14] + +Internet-Draft VPOLL July 2020 + + + If this property is not present voters are only allowed to respond + to the choices in the request. + + Format Definition This property is defined by the following + notation: + + acceptresponse = "ACCEPT-RESPONSE" acceptresponseparams ":" + iana-token ("," iana-token) CRLF + + acceptresponseparams = *(";" other-param) + + Figure 11 + +5.5.2. Poll-Completion + + Property name POLL-COMPLETION + + Purpose This property is used in VPOLL to indicate whether the + client or server is responsible for choosing and/or submitting the + winner(s). + + Description When a VPOLL is stored on a server which is capable of + handling choosing and submission of winning choices a value of + SERVER indicates that the server should close the poll, choose the + winner and submit whenever it is appropriate to do so. + + For example, in BASIC poll-mode, reaching the DTEND of the poll + could trigger this server side action. + + Server initiated submission requires that the submitted choice + MUST be a valid calendaring component. + + POLL-COMPLETION=SERVER-SUBMIT allows the client to set the poll- + winner, set the status to CONFIRMED and then store the poll on the + server. The server will then submit the winning choice and set + the status to SUBMITTED. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 15] + +Internet-Draft VPOLL July 2020 + + + poll-completion = "POLL-COMPLETION" pcparam ":" pcvalue CRLF + + pcparam = *(";" other-param) + + pcvalue = "SERVER" ; The server is responsible for both choosing and + ; submitting the winner(s) + / "SERVER-SUBMIT" ; The server is responsible for + ; submitting the winner(s). The client chooses. + / "SERVER-CHOICE" ; The server is responsible for + ; choosing the winner(s). The client will submit. + / "CLIENT" ; The client is responsible for both choosing and + ; submitting the winner(s) + / iana-token + / x-name + ;Default is CLIENT + + Figure 12 + + Example The following is an example of this property: + + POLL-COMPLETION: SERVER-SUBMIT + + Figure 13 + +5.5.3. Poll-Item-Id + + Property name POLL-ITEM-ID + + Purpose This property is used in VPOLL child components as an + identifier. + + Value type INTEGER + + Property Parameters Non-standard parameters can be specified on this + property. + + Conformance This property MUST be specified in a VOTE component and + in VPOLL choice items. + + Description In a METHOD:REQUEST each choice component MUST have a + POLL-ITEM-ID property. Each set of components with the same POLL- + ITEM-ID value represents one overall set of items to be voted on. + + POLL-ITEM-ID SHOULD be a unique small integer for each component + or set of components. If it remains the same between REQUESTs + then the previous response for that component MAY be re-used. To + force a re-vote on a component due to a significant change, the + POLL-ITEM-ID MUST change. + + + +York, et al. Expires 17 January 2021 [Page 16] + +Internet-Draft VPOLL July 2020 + + + Format Definition This property is defined by the following + notation: + + pollitemid = "POLL-ITEM-ID" pollitemdparams ":" + integer CRLF + + pollitemidparams = *( + (";" other-param) + ) + + Figure 14 + +5.5.4. Poll-Mode + + Property name POLL-MODE + + Purpose This property is used in VPOLL to indicate what voting mode + is to be applied. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component or + its sub-components. + + Description The poll mode defines how the votes are applied to + obtain a result. BASIC mode, the default, means that the voters + are selecting one component (or group of components) with a given + POLL=ITEM-ID. + + Other polling modes may be defined in updates to this + specification. These may allow for such modes as ranking or task + assignment. + + Format Definition This property is defined by the following + notation: + + pollmode = "POLL-MODE" pollmodeparams ":" + ("BASIC" / iana-token / other-token) CRLF + + pollmodeparams = *(";" other-param) + + Figure 15 + +5.5.5. Poll-properties + + Property name POLL-PROPERTIES + + + + +York, et al. Expires 17 January 2021 [Page 17] + +Internet-Draft VPOLL July 2020 + + + Purpose This property is used in VPOLL to define which icalendar + properties are being voted on. + + Property Parameters Non-standard or iana parameters can be specified + on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description This property defines which icalendar properties are + significant in the voting process. It may not be clear to voters + which properties are varying in a significant manner. Clients may + use this property to highlight those listed properties. + + Format Definition This property is defined by the following + notation: + + pollproperties = "POLL-PROPERTIES" pollpropparams ":" + text *("," text) CRLF + + pollpropparams = *(";" other-param) + + Figure 16 + +5.5.6. Poll-Winner + + Property name POLL-WINNER + + Purpose This property is used in a basic mode VPOLL to indicate + which of the VPOLL sub-components won. + + Value type INTEGER + + Property Parameters Non-standard parameters can be specified on this + property. + + Conformance This property MAY be specified in a VPOLL component. + + Description For poll confirmation each child component MUST have a + POLL-ITEM-ID property. For basic mode the VPOLL component SHOULD + have a POLL-WINNER property which MUST correspond to one of the + POLL-ITEM-ID properties and indicates which sub-component was the + winner. + + Format Definition This property is defined by the following + notation: + + + + + + +York, et al. Expires 17 January 2021 [Page 18] + +Internet-Draft VPOLL July 2020 + + + pollwinner = "POLL-WINNER" pollwinnerparams ":" + integer CRLF + + pollwinnerparams = *(";" other-param) + + ; Used with a STATUS:CONFIRMED VPOLL to indicate which + ; components have been confirmed + + Figure 17 + +5.5.7. Reply-URL + + Property name REPLY-URL + + Purpose This property may be used in scheduling messages to indicate + additional reply methods, for example a web-service. + + Property Parameters Non-standard, required or iana parameters can be + specified on this property. + + Conformance This property MAY be specified in a VPOLL component. + + Description When used in a scheduling message this property + indicates additional or required services that can be used to + reply. Typically this would be a web service of some form. + + Format Definition This property is defined by the following + notation: + + reply-url = "REPLY-URL" reply-urlparams ":" uri CRLF + + reply-urlparams = *( + (";" requiredparam) / + (";" other-param) + ) + + Figure 18 + +5.5.8. Response + + Property name RESPONSE + + Purpose To specify a response vote. + + Value type INTEGER + + Format Definition This property is defined by the following + notation: + + + +York, et al. Expires 17 January 2021 [Page 19] + +Internet-Draft VPOLL July 2020 + + + response = "RESPONSE" response-params ":" integer CRLF + ; integer value 0..100 + + responseparams = *(";" other-param) + + Figure 19 + + Description This parameter can be specified on the POLL-ITEM-ID + property to provide the value of the voters response. This + parameter allows for fine grained responses which are appropriate + to some applications. For the case of individuals voting for a + choice of events, client applications SHOULD conform to the + following convention: + + * 0 - 39 A "NO vote" + + * 40 - 79 A "MAYBE" vote + + * 80 - 89 A "YES - but not preferred vote" + + * 90-100 A "YES" vote. + + Clients MUST preserve the response value when there is no + change from the user even if they have a UI with fixed states + (e.g. yes/no/maybe). + +5.6. New Components + +5.6.1. VPOLL Component + + Component name VPOLL + + Purpose This component provides a mechanism by which voters can vote + on provided choices. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 20] + +Internet-Draft VPOLL July 2020 + + + pollc = "BEGIN" ":" "VPOLL" CRLF + pollprop + *participantc *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VPOLL" CRLF + + pollprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + dtstamp / uid / organizer / + ; + ; The following are OPTIONAL, + ; but MUST NOT occur more than once. + ; + acceptresponse / class / created / completed / + description / dtstart / last-mod / pollmode / + pollproperties / priority / seq / status / + summary / url / + ; + ; Either 'dtend' or 'duration' MAY appear in + ; a 'pollprop', but 'dtend' and 'duration' + ; MUST NOT occur in the same 'pollprop'. + ; 'duration' MUST only occur when 'dtstart' + ; is present + ; + dtend / duration / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + attach / categories / comment / + contact / rstatus / related / + resources / x-prop / iana-prop + ; + ; The following is OPTIONAL, it SHOULD appear + ; once for the confirmation of a BASIC mode + ; VPOLL. Other modes may define differing + ; requirements. + ; + pollwinner / + ; + ) + + Figure 20 + + Description This component provides a mechanism by which voters can + + + +York, et al. Expires 17 January 2021 [Page 21] + +Internet-Draft VPOLL July 2020 + + + vote on provided choices. The outcome depends upon the POLL-MODE + in effect. + + The PARTICIPANT components in VPOLL requests provide information + on each recipient who will be voting - both their identity through + the CALENDAR-ADDRESS property and their votes through the VOTE + components. + + If specified, the "DTSTART" property defines the start or opening + of the poll active period. If absent the poll is presumed to have + started when created. + + If "DTSTART" is present "DURATION" MAY be specified and indicates + the duration, and hence the ending, of the poll. The value of the + property MUST be a positive duration. + + "DTEND" MAY be specified with or without "DTSTART" and indicates + the ending of the poll. If DTEND is specified it MUST be later + than the DTSTART or CREATED property. + + If one or more VALARM components are included in the VPOLL they + are not components to be voted on and MUST NOT contain a POLL- + ITEM-ID property. VALARM sub-components may be used to provide + warnings to the user when polls are due to start or end. + +5.6.2. VOTE Component + + Component name VOTE + + Purpose This component provides a mechanism by which voters can vote + on provided choices. + + Conformance This component may be specified zero or more times in a + PARTICIPANT component which identifies the voter. + + Format Definition This property is defined by the following + notation: + + + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 22] + +Internet-Draft VPOLL July 2020 + + + votec = "BEGIN" ":" "VOTE" CRLF + voteprop + *eventc *todoc *journalc *freebusyc + *availabilityc *alarmc *iana-comp *x-comp + "END" ":" "VOTE" CRLF + + voteprop = *( + ; + ; The following are REQUIRED, + ; but MUST NOT occur more than once. + ; + pollitemid / response / + ; + ; The following are OPTIONAL, + ; and MAY occur more than once. + ; + comment / x-prop / iana-prop + ; + ) + + Figure 21 + + Description This component appears inside the PARTICIPANT component + with a PARTICIPANT-TYPE of VOTER to identify the voter. This + component contains that participants responses. + + The required and optional properties and their meanings will + depend upon the POLL-MODE in effect. + + For any POLL-MODE, POLL-ITEM-ID is used to associate the + information to a choice supplied by the organizer. This means + that each VOTE component only provides information about that + choice. + + If allowed by the POLL-MODE a VOTE component without a POLL-ITEM- + ID may be provided in a REPLY to indicate a possible new choice or + to provide information to the ORGANIZER - such as the respondees + availability. + +6. Poll Modes + + The VPOLL component is intended to allow for various forms of + polling. The particular form in efffect is indicated by the POLL- + MODE property. + + New poll modes can be registered by including a completed POLL-MODE + Registration Template (see Section 10.3) in a published RFC. + + + + +York, et al. Expires 17 January 2021 [Page 23] + +Internet-Draft VPOLL July 2020 + + +6.1. POLL-MODE:BASIC + + BASIC poll mode is the form of voting in which one possible outcome + is chosen from a set of possibilities. Usually this will be + represented as a number of possible event objects one of which will + be selected. + +6.1.1. Property restrictions + + This poll mode has the following property requirements: + + POLL-ITEM-ID Each contained sub-component that is being voted upon + MUST contain a POLL-ITEM_ID property which is unique within the + context of the POLL. The value MUST NOT be reused when events are + removed and/or added to the poll. + + POLL-WINNER On confirmation of the poll this property MUST be + present and identifies the winning component. + +6.1.2. Outcome reporting + + To confirm the winner the POLL-WINNER property MUST be present and + the STATUS MUST be set to CONFIRMED. + + When the winning VEVENT or VTODO is not a scheduled entity, that is, + it has no ORGANIZER or ATTENDEES it MUST be assigned an ORGANIZER + property and a list of non-participating ATTENDEEs. This allows the + winning entity to be distributed to the participants through iTip or + some other protocol. + +7. iTIP Extensions + + This specification introduces a number of extensions to [RFC5546]. + In group scheduling the parties involved are organizer and attendees. + In VPOLL the parties are organizer and voters. + + For many of the iTip processing rules the voters take the place of + attendees. + +7.1. Methods + + There are some extensions to the behavior of iTip methods for a VPOLL + object and two new methods are defined. + + + + + + + + +York, et al. Expires 17 January 2021 [Page 24] + +Internet-Draft VPOLL July 2020 + + + +----------------+------------------------------------------------+ + | Method | Description | + +================+================================================+ + | PUBLISH | No changes (yet) | + +----------------+------------------------------------------------+ + | REQUEST | Each child component MUST have a POLL-ITEM-ID | + | | property. Each set of components with the | + | | same POLL-ITEM-ID value represents one overall | + | | set of items to be voted on. | + +----------------+------------------------------------------------+ + | REPLY | There MUST be a single VPOLL component which | + | | MUST have: either one or more POLL-ITEM-ID | + | | properties with a RESPONSE param matching that | + | | from a REQUEST or a VFREEBUSY or VAVAILABILITY | + | | child component showing overall busy/available | + | | time. The VPOLL MUST have one voter only. | + +----------------+------------------------------------------------+ + | ADD | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | CANCEL | There MUST be a single VPOLL component with | + | | UID | + +----------------+------------------------------------------------+ + | | matching that of the poll being cancelled. | + +----------------+------------------------------------------------+ + | REFRESH | The organizer returns a METHOD:REQUEST with | + | | the current full state, or a METHOD:CANCEL or | + | | an error if no matching poll is found. | + +----------------+------------------------------------------------+ + | COUNTER | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | DECLINECOUNTER | Not supported for VPOLL. | + +----------------+------------------------------------------------+ + | POLLSTATUS | Used to send the current state of the poll to | + | | all voters. The VPOLL can contain a reduced | + | | set of properties but MUST contain DTSTAMP, | + | | SEQUENCE (if not 0), UID, ORGANIZER and | + | | PARTICIPANTS. | + +----------------+------------------------------------------------+ + + Table 1 + + The following table shows the above methods broken down by who can + send them with VPOLL components. + + + + + + + + +York, et al. Expires 17 January 2021 [Page 25] + +Internet-Draft VPOLL July 2020 + + + +------------+------------------------------------------------+ + | Originator | Methods | + +============+================================================+ + | Organizer | CANCEL, PUBLISH, REQUEST, POLLSTATUS | + +------------+------------------------------------------------+ + | Voter | REPLY, REFRESH, REQUEST (only when delegating) | + +------------+------------------------------------------------+ + + Table 2 + +7.2. Interoperability Models + + Most of the standard iTip specification applies with respect to + organizer and voters. + +7.2.1. Delegation + + TBD + +7.2.2. Acting on Behalf of Other Calendar Users + + TBD + +7.2.3. Component Revisions + + * Need to talk about what a change in SEQUENCE means + + * Sequence change forces a revote. + + * New voter - no sequence change + + * Add another poll set or change poll item ids or any change to a + child + + * component - bump sequence + +7.2.4. Message Sequencing + + TBD + +7.3. Application Protocol Elements + +7.3.1. Methods for VPOLL Calendar Components + + This section defines the property set restrictions for the method + types that are applicable to the "VPOLL" calendar component. Each + method is defined using a table that clarifies the property + constraints that define the particular method. + + + +York, et al. Expires 17 January 2021 [Page 26] + +Internet-Draft VPOLL July 2020 + + + The presence column uses the following values to assert whether a + property is required or optional, and the number of times it may + appear in the iCalendar object. + + +----------------+-------------------------------------------------+ + | Presence Value | Description | + +================+=================================================+ + | 1 | One instance MUST be present. | + +----------------+-------------------------------------------------+ + | 1+ | At least one instance MUST be present. | + +----------------+-------------------------------------------------+ + | 0 | Instances of this property MUST NOT be present. | + +----------------+-------------------------------------------------+ + | 0+ | Multiple instances MAY be present. | + +----------------+-------------------------------------------------+ + | 0 or 1 | Up to 1 instance of this property MAY be | + | | present. | + +----------------+-------------------------------------------------+ + + Table 3 + + The following summarizes the methods that are defined for the "VPOLL" + calendar component. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 27] + +Internet-Draft VPOLL July 2020 + + + +------------+------------------------------------------------------+ + | Method | Description | + +============+======================================================+ + | PUBLISH | Post notification of an poll. Used primarily | + | | as a method of advertising the existence of a | + | | poll. | + +------------+------------------------------------------------------+ + | REQUEST | To make a request for a poll. This is an | + | | explicit invitation to one or more voters. | + | | Poll requests are also used to update, change | + | | or confirm an existing poll. Clients that | + | | cannot handle REQUEST MAY degrade the poll to | + | | view it as a PUBLISH. REQUEST SHOULD NOT be | + | | used just to set the status of the poll - | + | | POLLSTATUS provides a more compact approach. | + +------------+------------------------------------------------------+ + | REPLY | Reply to a poll request. Voters may set | + | | their RESPONSE parameter to supply the | + | | current vote in the range 0 to 100. | + +------------+------------------------------------------------------+ + | CANCEL | Cancel a poll. | + +------------+------------------------------------------------------+ + | REFRESH | A request is sent to an Organizer by a Voter | + | | asking for the latest version of a poll to be | + | | resent to the requester. | + +------------+------------------------------------------------------+ + | POLLSTATUS | Used to send the current state of the poll to | + | | all voters. The VPOLL can contain a reduced | + | | set of properties but MUST contain DTSTAMP, | + | | SEQUENCE (if not 0), UID, ORGANIZER and | + | | PARTICIPANT. | + +------------+------------------------------------------------------+ + + Table 4 + +7.3.2. Method: PUBLISH + + The "PUBLISH" method in a "VPOLL" calendar component is an + unsolicited posting of an iCalendar object. Any CU may add published + components to their calendar. The "Organizer" MUST be present in a + published iCalendar component. "Voters" MUST NOT be present. Its + expected usage is for encapsulating an arbitrary poll as an iCalendar + object. The "Organizer" may subsequently update (with another + "PUBLISH" method) or cancel (with a "CANCEL" method) a previously + published "VPOLL" calendar component. + + Note Not clear how useful this is but needs some work on + transmitting the current vote without any voter identification. + + + +York, et al. Expires 17 January 2021 [Page 28] + +Internet-Draft VPOLL July 2020 + + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST equal PUBLISH. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | If present defines the start of the | + | | | poll. Otherwise the poll starts | + | | | when it is created and distributed. | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + + + +York, et al. Expires 17 January 2021 [Page 29] + +Internet-Draft VPOLL July 2020 + + + | | | present. | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of COMPLETED/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 0+ | Only PARTICIPANT components with | + | | | PARTICIPANT-TYPE not equal to | + | | | "VOTER" - that is, no voters | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + + + +York, et al. Expires 17 January 2021 [Page 30] + +Internet-Draft VPOLL July 2020 + + + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + + Table 5: Constraints for a METHOD:PUBLISH of a VPOLL + +7.3.3. Method: REQUEST + + The "REQUEST" method in a "VPOLL" component provides the following + scheduling functions: + + * Invite "Voters" to respond to the poll. + + * Change the items being voted upon. + + * Complete or confirm the poll. + + * Response to a "REFRESH" request. + + * Update the details of an existing vpoll. + + * Update the status of "Voters". + + * Forward a "VPOLL" to another uninvited CU. + + * For an existing "VPOLL" calendar component, delegate the role of + "Voter" to another CU. + + * For an existing "VPOLL" calendar component, change the role of + "Organizer" to another CU. + + The "Organizer" originates the "REQUEST". The recipients of the + "REQUEST" method are the CUs voting in the poll, the "Voters". + "Voters" use the "REPLY" method to convey votes to the "Organizer". + + The "UID" and "SEQUENCE" properties are used to distinguish the + various uses of the "REQUEST" method. If the "UID" property value in + the "REQUEST" is not found on the recipient's calendar, then the + "REQUEST" is for a new "VPOLL" calendar component. If the "UID" + property value is found on the recipient's calendar, then the + "REQUEST" is for an update, or a reconfirmation of the "VPOLL" + calendar component. + + + +York, et al. Expires 17 January 2021 [Page 31] + +Internet-Draft VPOLL July 2020 + + + For the "REQUEST" method only a single iCalendar object is permitted. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST be REQUEST. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1 | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1+ | Identified as voters with the | + | | | PARTICIPANT-TYPE=VOTER | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | If present defines the start of the | + | | | poll. Otherwise the poll starts | + | | | when it is created and distributed. | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + + + +York, et al. Expires 17 January 2021 [Page 32] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of COMPLETED/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0+ | Depending upon the poll mode in | + + + +York, et al. Expires 17 January 2021 [Page 33] + +Internet-Draft VPOLL July 2020 + + + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0+ | Depending upon the poll mode in | + | | | effect there MAY be candidate | + | | | components included in the poll | + | | | component. | + +-----------------+----------+-------------------------------------+ + + Table 6: Constraints for a METHOD:REQUEST of a VPOLL + +7.3.3.1. Rescheduling a poll + + The "REQUEST" method may be used to reschedule a poll, that is force + a revote. A rescheduled poll involves a change to the existing poll + in terms of its time the components being voted on may have changed. + If the recipient CUA of a "REQUEST" method finds that the "UID" + property value already exists on the calendar but that the "SEQUENCE" + (or "DTSTAMP") property value in the "REQUEST" method is greater than + the value for the existing poll, then the "REQUEST" method describes + a rescheduling of the poll. + +7.3.3.2. Updating or Reconfirmation of a Poll + + The "REQUEST" method may be used to update or reconfirm a poll. An + update to an existing poll does not involve changes to the time or + candidates, and might not involve a change to the location or + description for the poll. If the recipient CUA of a "REQUEST" method + finds that the "UID" property value already exists on the calendar + and that the "SEQUENCE" property value in the "REQUEST" is the same + as the value for the existing poll, then the "REQUEST" method + + describes an update of the poll details, but not a rescheduling of + the POLL. + + The update "REQUEST" method is the appropriate response to a + "REFRESH" method sent from a "Voter" to the "Organizer" of a poll. + + + + + + +York, et al. Expires 17 January 2021 [Page 34] + +Internet-Draft VPOLL July 2020 + + + The "Organizer" of a poll may also send unsolicited "REQUEST" + methods. The unsolicited "REQUEST" methods may be used to update the + details of the poll without rescheduling it, to update the "RESPONSE" + parameter of "Voters", or to reconfirm the poll. + +7.3.3.3. Confirmation of a Poll + + The "REQUEST" method may be used to confirm a poll, that is announce + the winner in BASIC mode. The STATUS MUST be set to CONFIRMED and + for BASIC mode a VPOLL POLL-WINNER property must be provided with the + poll-id of the winning component. + +7.3.3.4. Closing a Poll + + The "REQUEST" method may be used to close a poll, that is indicate + voting is completed. The STATUS MUST be set to COMPLETED. + +7.3.3.5. Delegating a Poll to Another CU + + Some calendar and scheduling systems allow "Voters" to delegate the + vote to another "Calendar User". iTIP supports this concept using the + following workflow. Any "Voter" may delegate their right to vote in + a poll to another CU. The implication is that the delegate + participates in lieu of the original "Voter", NOT in addition to the + "Voter". The delegator MUST notify the "Organizer" of this action + using the steps outlined below. Implementations may support or + restrict delegation as they see fit. For instance, some + implementations may restrict a delegate from delegating a "REQUEST" + to another CU. + + The "Delegator" of a poll forwards the existing "REQUEST" to the + "Delegate". The "REQUEST" method MUST include a "Voter" property + with the calendar address of the "Delegate". The "Delegator" MUST + also send a "REPLY" method to the "Organizer" with the "Delegator's" + "Voter" property "DELEGATED-TO" parameter set to the calendar address + of the "Delegate". Also, a new "Voter" property for the "Delegate" + MUST be included and must specify the calendar user address set in + the "DELEGATED-TO" parameter, as above. + + In response to the request, the "Delegate" MUST send a "REPLY" method + to the "Organizer", and optionally to the "Delegator". The "REPLY" + + method SHOULD include the "Voter" property with the "DELEGATED-FROM" + parameter value of the "Delegator's" calendar address. + + + + + + + +York, et al. Expires 17 January 2021 [Page 35] + +Internet-Draft VPOLL July 2020 + + + The "Delegator" may continue to receive updates to the poll even + though they will not be attending. This is accomplished by the + "Delegator" setting their "role" attribute to "NON-PARTICIPANT" in + the "REPLY" to the "Organizer". + +7.3.3.6. Changing the Organizer + + The situation may arise where the "Organizer" of a "VPOLL" is no + longer able to perform the "Organizer" role and abdicates without + passing on the "Organizer" role to someone else. When this occurs, + the "Voters" of the "VPOLL" may use out-of-band mechanisms to + communicate the situation and agree upon a new "Organizer". The new + "Organizer" should then send out a new "REQUEST" with a modified + version of the "VPOLL" in which the "SEQUENCE" number has been + incremented and the "ORGANIZER" property has been changed to the new + "Organizer". + +7.3.3.7. Sending on Behalf of the Organizer + + There are a number of scenarios that support the need for a "Calendar + User" to act on behalf of the "Organizer" without explicit role + changing. This might be the case if the CU designated as "Organizer" + is sick or unable to perform duties associated with that function. + In these cases, iTIP supports the notion of one CU acting on behalf + of another. Using the "SENT-BY" parameter, a "Calendar User" could + send an updated "VPOLL" "REQUEST". In the case where one CU sends on + behalf of another CU, the "Voter" responses are still directed back + towards the CU designated as "Organizer". + +7.3.3.8. Forwarding to an Uninvited CU + + A "Voter" invited to a "VPOLL" calendar component may send the + "VPOLL" calendar component to another new CU not previously + associated with the "VPOLL" calendar component. The current "Voter" + participating in the "VPOLL" calendar component does this by + forwarding the original "REQUEST" method to the new CU. The new CU + can send a "REPLY" to the "Organizer" of the "VPOLL" calendar + component. The reply contains a "Voter" property for the new CU. + + The "Organizer" ultimately decides whether or not the new CU becomes + part of the poll and is not obligated to do anything with a "REPLY" + from a new (uninvited) CU. If the "Organizer" does not want the new + CU to be part of the poll, the new "Voter" property is not added to + the "VPOLL" calendar component. The "Organizer" MAY send the CU a + "CANCEL" message to indicate that they will not be added to the poll. + + + + + + +York, et al. Expires 17 January 2021 [Page 36] + +Internet-Draft VPOLL July 2020 + + + If the "Organizer" decides to add the new CU, the new "Voter" + property is added to the "VPOLL" calendar component. Furthermore, + the "Organizer" is free to change any "Voter" property parameter from + the values supplied by the new CU to something the "Organizer" + considers appropriate. The "Organizer" SHOULD send the new CU a + "REQUEST" message to inform them that they have been added. + + When forwarding a "REQUEST" to another CU, the forwarding "Voter" + MUST NOT make changes to the original message. + +7.3.3.9. Updating Voter Status + + The "Organizer" of an poll may also request updated status from one + or more "Voters". The "Organizer" sends a "REQUEST" method to the + "Voter" and sets the "RSVP=TRUE" property parameter on the + PARTICIPANT CALENDAR-ADDRESS. The "SEQUENCE" property for the poll + is not changed from its previous value. A recipient will determine + that the only change in the "REQUEST" is that their "RSVP" property + parameter indicates a request for updated status. The recipient + SHOULD respond with a "REPLY" method indicating their current vote + with respect to the "REQUEST". + +7.3.4. Method: REPLY + + The "REPLY" method in a "VPOLL" calendar component is used to respond + (e.g., accept or decline) to a "REQUEST" or to reply to a delegation + "REQUEST". When used to provide a delegation response, the + "Delegator" SHOULD include the calendar address of the "Delegate" on + the "DELEGATED-TO" property parameter of the "Delegator's" "CALENDAR- + ADDRESS" property. The "Delegate" SHOULD include the calendar + address of the "Delegator" on the "DELEGATED-FROM" property parameter + of the "Delegate's" "CALENDAR-ADDRESS" property. + + The "REPLY" method is also used when processing of a "REQUEST" fails. + Depending on the value of the "REQUEST-STATUS" property, no action + may have been performed. + + The "Organizer" of a poll may receive the "REPLY" method from a CU + not in the original "REQUEST". For example, a "REPLY" may be + received from a "Delegate" to a poll. In addition, the "REPLY" + method may be received from an unknown CU (a "Party Crasher"). This + uninvited "Voter" may be accepted, or the "Organizer" may cancel the + poll for the uninvited "Voter" by sending a "CANCEL" method to the + uninvited "Voter". + + + + + + + +York, et al. Expires 17 January 2021 [Page 37] + +Internet-Draft VPOLL July 2020 + + + A "Voter" MAY include a message to the "Organizer" using the + "COMMENT" property. For example, if the user indicates a low + interest and wants to let the "Organizer" know why, the reason can be + expressed in the "COMMENT" property value. + + The "Organizer" may also receive a "REPLY" from one CU on behalf of + another. Like the scenario enumerated above for the "Organizer", + "Voters" may have another CU respond on their behalf. This is done + using the "SENT-BY" parameter. + + The optional properties listed in the table below (those listed as + "0+" or "0 or 1") MUST NOT be changed from those of the original + request. (But see comments on VFREEBUSY and VAVAILABILITY) + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST be REPLY. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | All components MUST have the same | + +-----------------+----------+-------------------------------------+ + | | | UID. | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1 | Identifies the Voter replying. | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+-------------------------------------+ + | UID | 1 | MUST be the UID of the original | + +-----------------+----------+-------------------------------------+ + | | | REQUEST. | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | If non-zero, MUST be the sequence | + | | | number of the original REQUEST. | + | | | MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 or 1 | | + + + +York, et al. Expires 17 January 2021 [Page 38] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 1+ | One per item being voted on. | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | SUMMARY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + + + +York, et al. Expires 17 January 2021 [Page 39] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0 | | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0 or 1 | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0 | | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 or 1 | A voter may respond with a | + | | | VFREEBUSY component indicating that | + | | | the ORGANIZER may select some other | + | | | time which is not marked as busy. | + +-----------------+----------+-------------------------------------+ + | VAVAILABILITY | 0 | A voter may respond with a | + | | | VAVAILABILITY component indicating | + | | | that the ORGANIZER may select some | + | | | other time which is shown as | + | | | available. | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0 | | + +-----------------+----------+-------------------------------------+ + | VTODO | 0 | | + +-----------------+----------+-------------------------------------+ + + Table 7: Constraints for a METHOD:REPLY of a VPOLL + +7.3.5. Method: CANCEL + + The "CANCEL" method in a "VPOLL" calendar component is used to send a + cancellation notice of an existing poll request to the affected + "Voters". The message is sent by the "Organizer" of the poll. + + The "Organizer" MUST send a "CANCEL" message to each "Voter" affected + by the cancellation. This can be done using a single "CANCEL" + message for all "Voters" or by using multiple messages with different + subsets of the affected "Voters" in each. + + When a "VPOLL" is cancelled, the "SEQUENCE" property value MUST be + incremented as described in Section 7.2.3. + + Once a CANCEL message has been sent to all voters no further voting + may take place. The poll is considered closed. + + + +York, et al. Expires 17 January 2021 [Page 40] + +Internet-Draft VPOLL July 2020 + + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+----------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+==================================+ + | METHOD | 1 | MUST be CANCEL. | + +-----------------+----------+----------------------------------+ + | VPOLL | 1+ | All must have the same UID. | + +-----------------+----------+----------------------------------+ + | PARTICIPANT | 0+ | MUST include some or all Voters | + | | | being removed from the poll. | + | | | MUST include some or all Voters | + | | | if the entire poll is cancelled. | + +-----------------+----------+----------------------------------+ + | UID | 1 | MUST be the UID of the original | + | | | REQUEST. | + +-----------------+----------+----------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+----------------------------------+ + | ORGANIZER | 1 | | + +-----------------+----------+----------------------------------+ + | SEQUENCE | 1 | | + +-----------------+----------+----------------------------------+ + | ATTACH | 0+ | | + +-----------------+----------+----------------------------------+ + | ACCEPT-RESPONSE | 0 | | + +-----------------+----------+----------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+----------------------------------+ + | COMPLETED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | CATEGORIES | 0+ | | + +-----------------+----------+----------------------------------+ + | CLASS | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | CONTACT | 0+ | | + +-----------------+----------+----------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | DESCRIPTION | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+----------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+----------------------------------+ + + + +York, et al. Expires 17 January 2021 [Page 41] + +Internet-Draft VPOLL July 2020 + + + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+----------------------------------+ + | GEO | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | LOCATION | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+----------------------------------+ + | POLL-MODE | 0 | | + +-----------------+----------+----------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+----------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+----------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+----------------------------------+ + | STATUS | 0 or 1 | MUST be set to CANCELLED to | + | | | cancel the entire event. If | + | | | uninviting specific Attendees, | + | | | then MUST NOT be included. | + +-----------------+----------+----------------------------------+ + | SUMMARY | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | TRANSP | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | URL | 0 or 1 | | + +-----------------+----------+----------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+----------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+----------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+----------------------------------+ + | VALARM | 0 | | + +-----------------+----------+----------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+----------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+----------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+----------------------------------+ + | VTODO | 0 | | + + + +York, et al. Expires 17 January 2021 [Page 42] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+----------------------------------+ + | VJOURNAL | 0 | | + +-----------------+----------+----------------------------------+ + | VEVENT | 0 | | + +-----------------+----------+----------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+----------------------------------+ + + Table 8: Constraints for a METHOD:CANCEL of a VPOLL + +7.3.6. Method: REFRESH + + The "REFRESH" method in a "VPOLL" calendar component is used by + "Voters" of an existing event to request an updated description from + the poll "Organizer". The "REFRESH" method must specify the "UID" + property of the poll to update. The "Organizer" responds with the + latest description and version of the poll. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +--------------------+----------+----------------------------+ + | Component/Property | Presence | Comment | + +====================+==========+============================+ + | METHOD | 1 | MUST be REFRESH. | + +--------------------+----------+----------------------------+ + | VPOLL | 1 | | + +--------------------+----------+----------------------------+ + | PARTICIPANT | 1 | MUST identify the | + | | | requester as a voter. | + +--------------------+----------+----------------------------+ + | DTSTAMP | 1 | | + +--------------------+----------+----------------------------+ + | ORGANIZER | 1 | | + +--------------------+----------+----------------------------+ + | UID | 1 | MUST be the UID associated | + | | | with original REQUEST. | + +--------------------+----------+----------------------------+ + | COMMENT | 0+ | | + +--------------------+----------+----------------------------+ + | COMPLETED | 0 | | + +--------------------+----------+----------------------------+ + | IANA-PROPERTY | 0+ | | + +--------------------+----------+----------------------------+ + | X-PROPERTY | 0+ | | + +--------------------+----------+----------------------------+ + | ACCEPT-RESPONSE | 0 | | + +--------------------+----------+----------------------------+ + + + +York, et al. Expires 17 January 2021 [Page 43] + +Internet-Draft VPOLL July 2020 + + + | ATTACH | 0 | | + +--------------------+----------+----------------------------+ + | CATEGORIES | 0 | | + +--------------------+----------+----------------------------+ + | CLASS | 0 | | + +--------------------+----------+----------------------------+ + | CONTACT | 0 | | + +--------------------+----------+----------------------------+ + | CREATED | 0 | | + +--------------------+----------+----------------------------+ + | DESCRIPTION | 0 | | + +--------------------+----------+----------------------------+ + | DTEND | 0 | | + +--------------------+----------+----------------------------+ + | DTSTART | 0 | | + +--------------------+----------+----------------------------+ + | DURATION | 0 | | + +--------------------+----------+----------------------------+ + | GEO | 0 | | + +--------------------+----------+----------------------------+ + | LAST-MODIFIED | 0 | | + +--------------------+----------+----------------------------+ + | LOCATION | 0 | | + +--------------------+----------+----------------------------+ + | POLL-ITEM-ID | 0 | | + +--------------------+----------+----------------------------+ + | POLL-MODE | 0 | | + +--------------------+----------+----------------------------+ + | POLL-PROPERTIES | 0 | | + +--------------------+----------+----------------------------+ + | PRIORITY | 0 | | + +--------------------+----------+----------------------------+ + | RELATED-TO | 0 | | + +--------------------+----------+----------------------------+ + | REQUEST-STATUS | 0 | | + +--------------------+----------+----------------------------+ + | RESOURCES | 0 | | + +--------------------+----------+----------------------------+ + | SEQUENCE | 0 | | + +--------------------+----------+----------------------------+ + | STATUS | 0 | | + +--------------------+----------+----------------------------+ + | SUMMARY | 0 | | + +--------------------+----------+----------------------------+ + | URL | 0 | | + +--------------------+----------+----------------------------+ + | VALARM | 0 | | + +--------------------+----------+----------------------------+ + + + +York, et al. Expires 17 January 2021 [Page 44] + +Internet-Draft VPOLL July 2020 + + + | VTIMEZONE | 0+ | | + +--------------------+----------+----------------------------+ + | IANA-COMPONENT | 0+ | | + +--------------------+----------+----------------------------+ + | X-COMPONENT | 0+ | | + +--------------------+----------+----------------------------+ + | VTODO | 0 | | + +--------------------+----------+----------------------------+ + | VJOURNAL | 0 | | + +--------------------+----------+----------------------------+ + | VEVENT | 0 | | + +--------------------+----------+----------------------------+ + | VFREEBUSY | 0 | | + +--------------------+----------+----------------------------+ + + Table 9: Constraints for a METHOD:REFRESH of a VPOLL + +7.3.7. Method: POLLSTATUS + + The "POLLSTATUS" method in a "VPOLL" calendar component is used to + inform recipients of the current status of the poll in a compact + manner. The "Organizer" MUST be present in the confirmed poll + component. All "Voters" MUST be present. The selected component(s) + according to the poll mode SHOULD NOT be present in the poll + component. Clients receiving this message may store the confirmed + items in their calendars. + + This method type is an iCalendar object that conforms to the + following property constraints: + + +-----------------+----------+-------------------------------------+ + | Component/ | Presence | Comment | + | Property | | | + +=================+==========+=====================================+ + | METHOD | 1 | MUST equal POLLSTATUS. | + +-----------------+----------+-------------------------------------+ + | VPOLL | 1+ | | + +-----------------+----------+-------------------------------------+ + | PARTICIPANT | 1+ | The voters containing their current | + | | | vote | + +-----------------+----------+-------------------------------------+ + | COMPLETED | 0 or 1 | Only present for a completed poll | + +-----------------+----------+-------------------------------------+ + | DTSTAMP | 1 | | + +-----------------+----------+-------------------------------------+ + | DTSTART | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | ORGANIZER | 1 | | + + + +York, et al. Expires 17 January 2021 [Page 45] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | SUMMARY | 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | UID | 1 | | + +-----------------+----------+-------------------------------------+ + | SEQUENCE | 0 or 1 | MUST be present if value is greater | + | | | than 0; MAY be present if 0. | + +-----------------+----------+-------------------------------------+ + | ACCEPT-RESPONSE | 0 | | + +-----------------+----------+-------------------------------------+ + | ATTACH | 0 | | + +-----------------+----------+-------------------------------------+ + | CATEGORIES | 0 | | + +-----------------+----------+-------------------------------------+ + | CLASS | 0 | | + +-----------------+----------+-------------------------------------+ + | COMMENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | CONTACT | 0 | | + +-----------------+----------+-------------------------------------+ + | CREATED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | DESCRIPTION | 0 or 1 | Can be null. | + +-----------------+----------+-------------------------------------+ + | DTEND | 0 or 1 | If present, DURATION MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | DURATION | 0 or 1 | If present, DTEND MUST NOT be | + | | | present. | + +-----------------+----------+-------------------------------------+ + | LAST-MODIFIED | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-ITEM-ID | 0 | | + +-----------------+----------+-------------------------------------+ + | POLL-MODE | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | POLL-PROPERTIES | 0 | | + +-----------------+----------+-------------------------------------+ + | PRIORITY | 0 or 1 | | + +-----------------+----------+-------------------------------------+ + | RELATED-TO | 0+ | | + +-----------------+----------+-------------------------------------+ + | RESOURCES | 0+ | | + +-----------------+----------+-------------------------------------+ + | STATUS | 0 or 1 | MAY be one of TENTATIVE/CONFIRMED/ | + | | | CANCELLED. | + +-----------------+----------+-------------------------------------+ + | URL | 0 or 1 | | + + + +York, et al. Expires 17 January 2021 [Page 46] + +Internet-Draft VPOLL July 2020 + + + +-----------------+----------+-------------------------------------+ + | IANA-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-PROPERTY | 0+ | | + +-----------------+----------+-------------------------------------+ + | REQUEST-STATUS | 0 | | + +-----------------+----------+-------------------------------------+ + | VALARM | 0+ | | + +-----------------+----------+-------------------------------------+ + | VEVENT | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VFREEBUSY | 0 | | + +-----------------+----------+-------------------------------------+ + | VJOURNAL | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VTODO | 0 | All candidate components SHOULD NOT | + | | | be present. | + +-----------------+----------+-------------------------------------+ + | VTIMEZONE | 0+ | MUST be present if any date/time | + | | | refers to a timezone. | + +-----------------+----------+-------------------------------------+ + | IANA-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + | X-COMPONENT | 0+ | | + +-----------------+----------+-------------------------------------+ + + Table 10: Constraints for a METHOD:POLLSTATUS of a VPOLL + +8. CalDAV Extensions + + This specification extends [RFC4791] in that it defines a new + component and new iCalendar properties to be supported and requires + extra definitions related to time-ranges and reports. + + Additionally, it extends [RFC6638] as it a VPOLL component is a + schedulable entity. + +8.1. Calendar Collection Properties + + This section defines new CalDAV properties for calendar collections. + +8.1.1. CALDAV:supported-vpoll-component-sets + + Name supported-vpoll-component-sets + + Namespace urn:ietf:params:xml:ns:caldav + + + +York, et al. Expires 17 January 2021 [Page 47] + +Internet-Draft VPOLL July 2020 + + + Purpose Specifies the calendar component types (e.g., VEVENT, VTODO, + etc.) and combination of types that may be included in a VPOLL + component. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:supported-vpoll-component-sets property is + used to specify restrictions on the calendar component types that + VPOLL components may contain in a calendar collection. + + It also specifies the combination of allowed component types. + + Any attempt by the client to store VPOLL components with component + types or combinations of types not listed in this property, if it + exists, MUST result in an error, with the "CALDAV:supported-vpoll- + component-sets" precondition Section 8.2 being violated. Since + this property is protected, it cannot be changed by clients using + a PROPPATCH request. However, clients can initialize the value of + this property when creating a new calendar collection with + MKCALENDAR. In the absence of this property, the server MUST + accept all component types, and the client can assume that all + component types are accepted. + + Definition + + <!ELEMENT supported-vpoll-component-sets + (supported-vpoll-component-set*) > + + <!ELEMENT supported-vpoll-component-set (comp+)> + + Figure 22 + + + + + + + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 48] + +Internet-Draft VPOLL July 2020 + + + <C:supported-vpoll-component-sets + xmlns:C="urn:ietf:params:xml:ns:caldav"> + + <!-- VPOLLs with VEVENT, VFREEBUSY or VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT or VFREEBUSY --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + <C:comp name="VFREEBUSY" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VEVENT --> + <C:supported-vpoll-component-set> + <C:comp name="VEVENT" /> + </C:supported-vpoll-component-set> + + <!-- VPOLLs with just VTODO --> + <C:supported-vpoll-component-set> + <C:comp name="VTODO" /> + </C:supported-vpoll-component-set> + </C:supported-vpoll-component-sets> + + Figure 23 + +8.1.2. CALDAV:vpoll-max-items + + Name vpoll-max-items + + Namespace urn:ietf:params:xml:ns:caldav + + Purpose Provides a numeric value indicating the maximum number of + items that may be contained in any instance of a VPOLL calendar + object resource stored in the calendar collection. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:vpoll-max-items is used to specify a numeric + value that indicates the maximum number of iCalendar components in + any one instance of a VPOLL calendar object resource stored in a + calendar collection. Any attempt to store a calendar object + resource with more components per instance than this value MUST + + + +York, et al. Expires 17 January 2021 [Page 49] + +Internet-Draft VPOLL July 2020 + + + result in an error, with the CALDAV: vpoll-max-items precondition + Section 8.2 being violated. In the absence of this property, the + client can assume that the server can handle any number of items + in a VPOLL calendar component. + + Definition + + <!ELEMENT vpoll-max-items (#PCDATA)> + PCDATA value: a numeric value (integer greater than zero) + + Figure 24 + + <C:vpoll-max-items xmlns:C="urn:ietf:params:xml:ns:caldav" + >25</C:vpoll-max-items> + + Figure 25 + +8.1.3. CALDAV:vpoll-max-active + + Name vpoll-max-active + + Namespace urn:ietf:params:xml:ns:caldav + + Purpose Provides a numeric value indicating the maximum number of + active vpolls at any one time. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND DAV:allprop request (as defined in [RFC2518]). + + Description The CALDAV:vpoll-max-active is used to specify a numeric + value that indicates the maximum number of active VPOLLs at any + one time. Any attempt to store a new active VPOLL calendar object + resource which results in exceeding this limit MUST result in an + error, with the "CALDAV:vpoll-max-active" precondition Section 8.2 + being violated. In the absence of this property, the client can + assume that the server can handle any number of active VPOLLs. + + Definition + + <!ELEMENT vpoll-max-active (#PCDATA)> + PCDATA value: a numeric value (integer greater than zero) + + Figure 26 + + <C:vpoll-max-active xmlns:C="urn:ietf:params:xml:ns:caldav" + >25</C:vpoll-max-active> + + + + +York, et al. Expires 17 January 2021 [Page 50] + +Internet-Draft VPOLL July 2020 + + + Figure 27 + +8.1.4. CALDAV:vpoll-max-voters + + Name "vpoll-max-voters" + + Namespace "urn:ietf:params:xml:ns:caldav" + + Purpose Provides a numeric value indicating the maximum number of + voters for any instance of a VPOLL calendar object resource stored + in the calendar collection. + + Conformance This property MAY be defined on any calendar collection. + If defined, it MUST be protected and SHOULD NOT be returned by a + PROPFIND "DAV:allprop" request (as defined in [RFC2518]). + + Description The "CALDAV:vpoll-max-voters" is used to specify a + numeric value that indicates the maximum number of voters for any + one instance of a VPOLL calendar object resource stored in a + calendar collection. Any attempt to store a calendar object + resource with more voters per instance than this value MUST result + in an error, with the CALDAV: "vpoll-max-voters" precondition + Section 8.2 being violated. In the absence of this property, the + client can assume that the server can handle any number of voters + in a VPOLL calendar component. + + Definition + + <!ELEMENT vpoll-max-voters (#PCDATA)> + PCDATA value: a numeric value (integer greater than zero) + + Figure 28 + + <C:vpoll-max-voters xmlns:C="urn:ietf:params:xml:ns:caldav" + >25</C:vpoll-max-voters> + + Figure 29 + +8.1.5. CalDAV:even-more-properties + +8.1.6. Extensions to CalDAV scheduling + + This specification extends [RFC6638]. + + Each section of Appendix A "Scheduling Privileges Summary" is + extended to include VPOLL. + + + + + +York, et al. Expires 17 January 2021 [Page 51] + +Internet-Draft VPOLL July 2020 + + + Any reference to the ATTENDEE property should be read to include the + CALENDAR-ADDRESS property contained in the PARTICIPANT compoents. + That is, for scheduling purposes the CALENDAR-ADDRESS property is + handled in exactly the same manner as the ATTENDEE property. + +8.2. Additional Preconditions for PUT, COPY, and MOVE + + This specification creates additional Preconditions for PUT, COPY, + and MOVE methods. These preconditions apply when a PUT operation of + a VPOLL calendar object resource into a calendar collection occurs, + or when a COPY or MOVE operation of a calendar object resource into a + calendar collection occurs, or when a COPY or MOVE operation occurs + on a calendar collection. + + The new preconditions are: + + (CALDAV:supported-vpoll-component-sets) The VPOLL resource submitted + in the PUT request, or targeted by a COPY or MOVE request, MUST + contain a type or combination of calendar component that is + supported in the targeted calendar collection; + + (CALDAV:vpoll-max-items) The VPOLL resource submitted in the PUT + request, or targeted by a COPY or MOVE request, MUST have a number + of sub-components (excluding VTIMEZONE) less than or equal to the + value of the "CALDAV:vpoll-max-items" property value Section 8.1.2 + on the calendar collection where the resource will be stored; + + (CALDAV:vpoll-max-active) The PUT request, or COPY or MOVE request, + MUST not result in the number of active VPOLLs being greater than + the value of the "CALDAV:vpoll-max-active" property value + Section 8.1.3 on the calendar collection where the resource will + be stored; + + (CALDAV:vpoll-max-voters) The VPOLL resource submitted in the PUT + request, or targeted by a COPY or MOVE request, MUST have a number + of voters represented by PARTICIPANT components less than or equal + to the value of the "CALDAV:vpoll-max-voters" property value + Section 8.1.4 on the calendar collection where the resource will + be stored; + +8.3. CalDAV:calendar-query Report + + This allows the retrieval of VPOLLs and their included components. + The query specification allows queries to be directed at the + contained sub-components. For VPOLL queries this feature is + disallowed. Time-range queries can only target the vpoll component + itself. + + + + +York, et al. Expires 17 January 2021 [Page 52] + +Internet-Draft VPOLL July 2020 + + +8.3.1. Example: Partial Retrieval of VPOLL + + In this example, the client requests the server to return specific + components and properties of the VPOLL components that overlap the + time range from December 4, 2012, at 00:00:00 A.M. UTC to December + 5, 2012, at 00:00:00 A.M. UTC. In addition, the "DAV:getetag" + property is also requested and returned as part of the response. + Note that due to the CALDAV: calendar-data element restrictions, the + DTSTAMP property in VPOLL components has not been returned, and the + only property returned in the VCALENDAR object is VERSION. + + >> Request << + + REPORT /cyrus/work/ HTTP/1.1 + Host: cal.example.com + Depth: 1 + Content-Type: application/xml; charset="utf-8" + Content-Length: xxxx + + <?xml version="1.0" encoding="utf-8" ?> + <C:calendar-query xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:prop> + <D:getetag/> + <C:calendar-data> + <C:comp name="VCALENDAR"> + <C:prop name="VERSION"/> + <C:comp name="VPOLL"> + <C:prop name="SUMMARY"/> + <C:prop name="UID"/> + <C:prop name="DTSTART"/> + <C:prop name="DTEND"/> + <C:prop name="DURATION"/> + </C:comp> + + </C:comp> + </C:calendar-data> + </D:prop> + <C:filter> + <C:comp-filter name="VCALENDAR"> + <C:comp-filter name="VPOLL"> + <C:time-range start="20121204T000000Z" + end="20121205T000000Z"/> + </C:comp-filter> + </C:comp-filter> + </C:filter> + </C:calendar-query> + + + + +York, et al. Expires 17 January 2021 [Page 53] + +Internet-Draft VPOLL July 2020 + + + >> Response << + + HTTP/1.1 207 Multi-Status + Date: Sat, 11 Nov 2012 09:32:12 GMT + Content-Type: application/xml; charset="utf-8" + Content-Length: xxxx + + <?xml version="1.0" encoding="utf-8" ?> + <D:multistatus xmlns:D="DAV:" + xmlns:C="urn:ietf:params:xml:ns:caldav"> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll2.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd2"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + VERSION:2.0 + BEGIN:VPOLL + DTSTART;TZID=US/Eastern:20121202T120000 + DURATION:PT4D + SUMMARY:Poll #2 + UID:00959BC664CA650E933C892C@example.com + END:VPOLL + END:VCALENDAR + </C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + </D:propstat> + </D:response> + <D:response> + <D:href>http://cal.example.com/cyrus/work/poll3.ics</D:href> + <D:propstat> + <D:prop> + <D:getetag>"fffff-abcd3"</D:getetag> + <C:calendar-data>BEGIN:VCALENDAR + + VERSION:2.0 + PRODID:-//Example Corp.//CalDAV Client//EN + BEGIN:VPOLL + DTSTART;TZID=US/Eastern:20121204T100000 + DURATION:PT4D + SUMMARY:Poll #3 + UID:DC6C50A017428C5216A2F1CD@example.com + END:VPOLL + END:VCALENDAR + </C:calendar-data> + </D:prop> + <D:status>HTTP/1.1 200 OK</D:status> + + + +York, et al. Expires 17 January 2021 [Page 54] + +Internet-Draft VPOLL July 2020 + + + </D:propstat> + </D:response> + </D:multistatus> + + Figure 30 + +8.4. CalDAV time ranges + + "CALDAV:time-range XML Element" in [RFC4791] describes how to specify + time ranges to limit the set of calendar components returned by the + server. This specification extends [RFC4791] to describe the meaning + of time ranges for VPOLL + + A VPOLL component is said to overlap a given time range if the + condition for the corresponding component state specified in the + table below is satisfied. The conditions depend on the presence of + the DTSTART, DURATION, DTEND, COMPLETED and CREATED properties in the + VPOLL component. Note that, as specified above, the DTEND value MUST + be a DATE-TIME value equal to or after the DTSTART value if + specified. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 55] + +Internet-Draft VPOLL July 2020 + + + +-------------------------------------------------------------------+ + | VPOLL has the DTSTART property? | + | +---------------------------------------------------------------+ + | | VPOLL has the DURATION property? | + | | +-----------------------------------------------------------+ + | | | VPOLL has the DTEND property? | + | | | +-------------------------------------------------------+ + | | | | VPOLL has the COMPLETED property? | + | | | | +---------------------------------------------------+ + | | | | | VPOLL has the CREATED property? | + | | | | | +-----------------------------------------------+ + | | | | | | Condition to evaluate | + +---+---+---+---+---+-----------------------------------------------+ + | Y | Y | N | * | * | (start <= DTSTART+DURATION) AND | + | | | | | | ((end > DTSTART) OR | + | | | | | | (end >= DTSTART+DURATION)) | + +---+---+---+---+---+-----------------------------------------------+ + | Y | N | Y | * | * | ((start < DTEND) OR (start <= DTSTART)) | + | | | | | | AND | + | | | | | | ((end > DTSTART) OR (end >= DTEND)) | + +---+---+---+---+---+-----------------------------------------------+ + | Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | Y | * | * | (start < DTEND) AND (end >= DTEND) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))| + | | | | | | AND | + | | | | | | ((end >= CREATED) OR (end >= COMPLETED))| + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | N | Y | (end > CREATED) | + +---+---+---+---+---+-----------------------------------------------+ + | N | N | N | N | N | TRUE | + +---+---+---+---+---+-----------------------------------------------+ + + Figure 31 + +9. Security Considerations + + Applications using these property need to be aware of the risks + entailed in using the URIs provided as values. See [RFC3986] for a + discussion of the security considerations relating to URIs. + +10. IANA Considerations + + + + + + +York, et al. Expires 17 January 2021 [Page 56] + +Internet-Draft VPOLL July 2020 + + +10.1. Parameter Registrations + + This document defines the following new iCalendar property parameters + to be added to the registry defined in [RFC5545]: + + +--------------------+---------+---------------+ + | Property Parameter | Status | Reference | + +====================+=========+===============+ + | REQUIRED | Current | Section 5.4.1 | + +--------------------+---------+---------------+ + | STAY-INFORMED | Current | Section 5.4.2 | + +--------------------+---------+---------------+ + + Table 11 + +10.2. Property Registrations + + This document defines the following new iCalendar properties to be + added to the registry defined in [RFC5545]: + + +-----------------+---------+---------------+ + | Property | Status | Reference | + +=================+=========+===============+ + | ACCEPT-RESPONSE | Current | Section 5.5.7 | + +-----------------+---------+---------------+ + | POLL-ITEM-ID | Current | Section 5.5.3 | + +-----------------+---------+---------------+ + | POLL-MODE | Current | Section 5.5.4 | + +-----------------+---------+---------------+ + | POLL-PROPERTIES | Current | Section 5.5.5 | + +-----------------+---------+---------------+ + | POLL-WINNER | Current | Section 5.5.6 | + +-----------------+---------+---------------+ + | RESPONSE | Current | Section 5.5.8 | + +-----------------+---------+---------------+ + + Table 12 + +10.3. POLL-MODE Registration Template + + A poll mode is defined by completing the following template. + + Poll mode name The name of the poll mode. + + Purpose The purpose of the poll mode. Give a short but clear + description. + + Reference A reference to the RFC in which the poll mode is defined + + + +York, et al. Expires 17 January 2021 [Page 57] + +Internet-Draft VPOLL July 2020 + + +10.4. POLL-MODE Registrations + + This document defines the following registered poll modes. + + +-----------+---------------------------------------+-----------+ + | Poll mode | Purpose | Reference | + | name | | | + +===========+=======================================+===========+ + | BASIC | To provide simple voting for a single | Current | + | | outcome from a number of candidates. | | + +-----------+---------------------------------------+-----------+ + + Table 13 + +11. Normative References + + [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D. + Jensen, "HTTP Extensions for Distributed Authoring - + WEBDAV", IETF RFC 2518, IETF RFC 2518, + DOI 10.17487/RFC2518, February 1999, + . + + [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform + Resource Identifier (URI): Generic Syntax", IETF RFC 3986, + IETF RFC 3986, DOI 10.17487/RFC3986, January 2005, + . + + [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, + "Calendaring Extensions to WebDAV (CalDAV)", IETF RFC + 4791, IETF RFC 4791, DOI 10.17487/RFC4791, March 2007, + . + + [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and + Scheduling Core Object Specification (iCalendar)", IETF + RFC 5545, IETF RFC 5545, DOI 10.17487/RFC5545, September + 2009, . + + [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent + Interoperability Protocol (iTIP)", IETF RFC 5546, IETF RFC + 5546, DOI 10.17487/RFC5546, December 2009, + . + + [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based + Interoperability Protocol (iMIP)", IETF RFC 6047, IETF RFC + 6047, DOI 10.17487/RFC6047, December 2010, + . + + + + + +York, et al. Expires 17 January 2021 [Page 58] + +Internet-Draft VPOLL July 2020 + + + [RFC6638] Daboo, C. and B. Desruisseaux, "Scheduling Extensions to + CalDAV", IETF RFC 6638, IETF RFC 6638, + DOI 10.17487/RFC6638, June 2012, + . + + [I-D.draft-ietf-calext-eventpub-extensions] + "AUTOFILL", IETF IETF I-D.draft-ietf-calext-eventpub- + extensions, IETF IETF I-D.draft-ietf-calext-eventpub- + extensions. + +12. Bibliography + +Appendix A. Open issues + + public-comment: Not documented and was a parameter on something. + Really sounds like a PARTICIPANT or VOTE property + + Notifications: Need to do a section on what Notifications to support. + A. VPOLL is about to end and you haven't voted on it yet. Instead + reuse VALARMS to notify the user? + + Future: Restarting a confirmed/completed VPOLL What to do with + changes to STATUS:CONFIRMED? Allow them or not? What do to that + poll had a winning event or todo. Stress VPOLL UID MUST be unique + Changing status back from CONFIRMED MUST adjust status of any events + booked as a result of confirmation. MUST winning event be cancelled + for POLL-MODE basic? No - voter has indicated now unable to attend - + want to revote + + Future: Voting on a confirmed/completed VPOLL Can a voter vote after + completion? May be unable to attend and wants to indicate. Requires + retention of VPOLL retention period Removed status + + ORGANIZER/ATTENDEE validity Can a user create a poll with scheduled + events where that user's isn't the organizer of the poll? So is + there a requirement that the account that poll is on is able to + create each one of the resources in the poll? i.e. I can't create a + poll with a set of events where I am just the attendee of the events. + Are there any other restrictions for components in a VPOLL? Add to + security consideration + + Update to existing event after poll confirm When voting on existing + event - winning properties ONLY are merged in to the real event. + + Need to write down what isn't valid in a VPOLL a. Can't change POLL- + MODE + + Guide for ATTENDEE roles chair, NON-PARTICIPANT etc + + + +York, et al. Expires 17 January 2021 [Page 59] + +Internet-Draft VPOLL July 2020 + + + ? - some iTip notes On confirm - send itip if appropriate (PUBLISH) - + all non-participating - shared - feeds Organizer can specify where + result is? Confirm can specify that itip is sent - ITIP / NONE - + parameter ? on POLL-WINNER + + Need to add example of freebusy in response + + BEGIN:VCALENDAR + VERSION:2.0 + PRODID:-//BedeworkCaldavTest//BedeworkCaldavTest + METHOD: REPLY + BEGIN:VPOLL + ORGANIZER:mailto:douglm@mysite.edu + BEGIN:PARTICIPANT + PARTICIPANT-TYPE: VOTER + CALENDAR-ADDRESS:mailto:eric@example.com + UID:sched01-1234567890 + DTSTAMP:20120101T010000Z + SEQUENCE:0 + SUMMARY:What to do this week + BEGIN:VFREEBUSY + ....... + END:VFREEBUSY + END:PARTICIPANT + END:VPOLL + END:VCALENDAR + + Figure 32 + +Appendix B. Change log + + Calext V01: 2019-10-17 MD Replace VVOTER and VOTER with PARTICIPANT. + + Calext V00: 2019-05-17 MD First calext version. Moved source to + metanorma. No changes to specification. + + V03: 2014-10-28 MD * Add VVOTER and VOTE components. + + * Add RESPONSE property. + + * Remove RESPONSE parameter from VOTER. + + V03: 2014-05-12 MD * Add reply-url property and required parameter. + + * Fix ACCEPT-RESPONSE definition. + + V02: 2014-05-12 MD * Typos fixed, clarifications made. + + + + +York, et al. Expires 17 January 2021 [Page 60] + +Internet-Draft VPOLL July 2020 + + + * Removed spurious COMMENT param. Switched some + to PUBLIC-COMMENT + + * Changed STAY-INFORMED to remove boolean value + type and state explicit TRUE/FALSE values. + + * iTip: Allow VPOLL DTSTART to be optional and + allow VAVAILABILITY as subcomponent + + * iTip: fix broken table cells + + * Add POLL-PROPERTIES, POLL-WINNER to 5545 + extensions table + + * Added Caldav scheduling section + + V01: 2013-08-07 MD * Removed method CONFIRM + + * Removed pollitemid from VPOLL abnf. Added + text for pollwinner + + * Added POLL-WINNER and verbiage + + * Added STATUS values + + * Added RELTYPE=POLL + + * Added supported-vpoll-component-sets + + * Added CalDAV related parameters to VOTER + + * Removed bad CalDAV query example. State that + queries cannot target the sub-components. + + Initial version: 2012-11-02 MD + +Authors' Addresses + + Eric York + + Email: eric.york@gmail.com + + + Cyrus Daboo + + Email: cyrus@daboo.name + + + + + +York, et al. Expires 17 January 2021 [Page 61] + +Internet-Draft VPOLL July 2020 + + + Michael Douglass + + Email: mikeadouglass@gmail.com + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +York, et al. Expires 17 January 2021 [Page 62] diff --git a/sources/metadata.min.js b/sources/metadata.min.js new file mode 100644 index 0000000..e07b59f --- /dev/null +++ b/sources/metadata.min.js @@ -0,0 +1 @@ +async function addMetadata(){try{const e=document.styleSheets[0].cssRules;for(let t=0;t=0?document.URL.replace(/html$/,"json"):document.URL+".json";const o=await fetch(t);a=await o.json()}}if(!a)return;e.style.display="block";const s="",d="https://datatracker.ietf.org/doc",n="https://datatracker.ietf.org/ipr/search",c="https://www.rfc-editor.org/info",l=a.doc_id.toLowerCase(),i=a.doc_id.slice(0,3).toLowerCase(),f=a.doc_id.slice(3).replace(/^0+/,""),u={status:"Status",obsoletes:"Obsoletes",obsoleted_by:"Obsoleted By",updates:"Updates",updated_by:"Updated By",see_also:"See Also",errata_url:"Errata"};let h="
";["status","obsoletes","obsoleted_by","updates","updated_by","see_also","errata_url"].forEach(e=>{if("status"==e){a[e]=a[e].toLowerCase();var t=a[e].split(" "),o=t.length,w="",p=1;for(let e=0;e"+a[e][t].slice(3)+", ":m+""+a[e][t].slice(3)+"",b++);a[e]=m}else if("see_also"==e){var y,L="",C=1;y=a[e].length;for(let t=0;t"+_+" "+v+", ":L+""+v+", ":"RFC"!=_?L+""+_+" "+v+"":L+""+v+"",C++}a[e]=L}else if("errata_url"==e){var R="";R=a[e]?R+"Errata exist | Datatracker| IPR | Info page":"Datatracker | IPR | Info page",a[e]=R}""!=a[e]?"Errata"==u[e]?h+=`
More info:
${a[e]}
`:h+=`
${u[e]}:
${a[e]}
`:"Errata"==u[e]&&(h+=`
More info:
${a[e]}
`)}),h+="
",e.innerHTML=h}catch(e){console.log(e)}else console.log("Could not locate metadata
element");function r(e){return e.charAt(0).toUpperCase()+e.slice(1)}}window.removeEventListener("load",addMetadata),window.addEventListener("load",addMetadata); \ No newline at end of file