Commit 7afad369 authored by Mark Stenglein's avatar Mark Stenglein

DelegatorsParam: Add documentation from RFC5545

Adds the missing documentation to the DelegatorsParam file.
Signed-off-by: Mark Stenglein's avatarMark Stenglein <mark@stengle.in>
parent dac5f8b2
Pipeline #1139 passed with stage
in 24 seconds
......@@ -17,6 +17,33 @@
*/
import Parameter from "./Parameter";
/**
* DelegatorsParam Class (Chapter 3.2.4)
*
* - Purpose: To specify the calendar users that have delegated their
* participation to the calendar user specified by the property.
*
* - Format Definition: This property parameter is defined by the following
* notation:
*
* - delfromparam = "DELEGATED-FROM" "=" DQUOTE cal-address
* DQUOTE *("," DQUOTE cal-address DQUOTE)
*
* - Description:
* - The parameter is specified on properties of the CAL-ADDRESS value
* type.
* - TODO: Enforce this restriction on the type allowed to hold this parameter
* - This parameter specified those calendar users that have delegated their
* participation in a group-scheduled event or to-do to the calendar user
* specified by the property.
* - The individual calendar address parameter values MUST each be specified
* in a quoted-string.
*
* - Example:
*
* ATTENDEE;DELEGATED-FROM="mailto:jsmith@example.com":mailto:
* jdoe@example.com
*/
export default class DelegatorsParam extends Parameter {
private _delegators: string[];
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment