element <sendMeetingRequest> (global)
Namespace:
http://schemas.microsoft.com/hs/2001/10/myCalendar
Type:
anonymous complexType
Content:
complex, 5 attributes, 3 elements
Defined:
globally in myCalendar.xsd; see XML source
Includes:
definitions of 5 attributes, 3 elements
Used:
never
XML Representation Summary
<sendMeetingRequest
   
 = 
xsd:boolean
 = 
xsd:boolean
 = 
xsd:boolean
 = 
xsd:string
 = 
xsd:dateTime
   
>
   
Content: 
</sendMeetingRequest>
Content model elements (3):
invite (in sendMeetingRequest), replaceRequest (in sendMeetingRequest), uninvite (in sendMeetingRequest)
Annotation
The purpose of this method is for a meeting organizer to invite and uninvite (cancel) attendees to this event. sendMeeting also sends updated invitations to existing invitees. Inviting a user to a single instance of a recurring event will cause only that instance to be sent. However, future updates to that event will overwrite the existing instance, including the case where an update is the full recurring event. <br/>Meeting requests will be sent out as iCal attachments from an SMTP server unknown at this point in the design. <br/>When inviting or uninviting, .NET Calendar searches for these existing attendees by puid first, and then by email address such that the puid receives precedence in the search predication. .NET Calendar will not allow multiple meeting requests/cancellations to the same puid or email address within the scope of the same invite or uninvite block. However, an organizer may uninvite an attendee and then reinvite again (non-standard behavior).
XML Source (see within schema source)
<xsd:element name="sendMeetingRequest">
<xsd:annotation>
<xsd:documentation>
The purpose of this method is for a meeting organizer to invite and uninvite
(cancel) attendees to this event. sendMeeting also sends updated invitations
to existing invitees. Inviting a user to a single instance of a recurring
event will cause only that instance to be sent. However, future updates to
that event will overwrite the existing instance, including the case where an
update is the full recurring event.
<br/>
Meeting requests will be sent out as iCal attachments from an SMTP server
unknown at this point in the design.
<br/>
When inviting or uninviting, .NET Calendar searches for these existing
attendees by puid first, and then by email address such that the puid receives
precedence in the search predication. .NET Calendar will not allow multiple
meeting requests/cancellations to the same puid or email address within the
scope of the same invite or uninvite block. However, an organizer may uninvite
an attendee and then reinvite again (non-standard behavior).
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="eventId" type="hs:idRefType" use="required">
<xsd:annotation>
<xsd:documentation>
This is the puid of the event which to send meeting invitations
or cancellations to. This event must already exist within the
.NET Calendar service. Additional server constraints are
implemented which verify that potential updates to the attendee
tables occur for this event only. This is a required field.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="criticalChange" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
When this attribute is set to "true", &lt;lastUpdateTime&gt; is
updated when invitations are sent to the attendees. If "false",
&lt;lastUpdateTime&gt; remains untouched.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="recurrenceId" type="xsd:dateTime" use="optional">
<xsd:annotation>
<xsd:documentation>
The optional recurrenceId allows the meeting organizer to send
invitations for only a particular instance of a recurring event.
If the event is not a recurring event, or if recurrenceId does
not correspond to a valid instance/exception, sendMeetingRequest
will fail with an error.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="continueOnFailure" type="xsd:boolean" use="required">
<xsd:annotation>
<xsd:documentation>
Specifies to .NET Calendar to continue performing the
sendMeetingRequest even on a failure. Points of failure:
<li>
&lt;uninvite&gt; may delete attendees, and the HSDL delete may encounter errors
</li>
<li>&lt;updateRequest&gt; may encounter HSDL errors.</li>
<li>
The optional final delete of the event may encounter errors.
</li>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="deleteOnCompletion" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
This event will be deleted upon completion of this sendMeetingRequest.
This behavior is intended for deleting a meeting and sending cancellations.
If recurrenceId is present (and valid),
<b>
only this particular recurring
instance or exception is deleted
</b>
, in which case a new
&lt;deletedExceptionDate&gt; is added to the recurrence rule.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:sequence>
<xsd:element name="uninvite">
<xsd:complexType>
<xsd:attribute name="behavior" type="sendMeetingBehaviorEnum" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute will give the option to either choose to send
cancellations to "all" attendees in the event's attendee table,
or send to "none" of them. A third value of "default" would
give the default behavior of sending cancellations to all
attendees who are replaced in the &lt;replaceRequest&gt; block.
When this attribute is set, .NET Calendar will ignore anything
within the &lt;uninvite&gt; node.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="attendee" type="uninviteAttendeeType">
<xsd:annotation>
<xsd:documentation>
Contains a list of people to uninvite. Uninvited attendees must already exist
in the organizer's attendee table, or else these users are ignored.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="replaceRequest" type="hs:replaceRequestType">
<xsd:annotation>
<xsd:documentation>
This replace request can only affect the meeting invitation in question, and is
thus constrained to be only @select="/m:myCalendar/m:event[@id=@eventId]/...".
It will not be allowed to replace-on-null so that event creation cannot be a
side-effect.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="invite">
<xsd:complexType>
<xsd:attribute name="behavior" type="sendMeetingBehaviorEnum" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute will give the option to either choose to send
invitations to "all" attendees in the event's attendee table,
or send to "none" of them. A third value of "default" would
give the default behavior of sending invitations to only the
new attendees in the &lt;replaceRequest&gt; block. When this
attribute is set, .NET Calendar will ignore anything within
the &lt;invite&gt; node.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="attendee" type="hs:userReference">
<xsd:annotation>
<xsd:documentation>
Contains information about this attendee to be invited. An invited
attendee must already exist in the organizer's attendee table. This
attendee may originally be there prior to the sendMeetingRequest
method, or be the result of the update operation to this meeting.
<br/>
To change the attendee's inviteType, the update operation should
be used.
<br/>
When invitations are sent, the attendee's &lt;responseTime&gt;
is set to the current time (now) as a side-effect.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Attribute Detail (all declarations; 5/5)
continueOnFailure
Type:
xsd:boolean, predefined
Use:
required
Defined:
locally within (this) sendMeetingRequest element
Specifies to .NET Calendar to continue performing the sendMeetingRequest even on a failure. Points of failure: <li><uninvite> may delete attendees, and the HSDL delete may encounter errors</li> <li><updateRequest> may encounter HSDL errors.</li> <li>The optional final delete of the event may encounter errors.</li>
XML Source (see within schema source)
<xsd:attribute name="continueOnFailure" type="xsd:boolean" use="required">
<xsd:annotation>
<xsd:documentation>
Specifies to .NET Calendar to continue performing the
sendMeetingRequest even on a failure. Points of failure:
<li>
&lt;uninvite&gt; may delete attendees, and the HSDL delete may encounter errors
</li>
<li>&lt;updateRequest&gt; may encounter HSDL errors.</li>
<li>
The optional final delete of the event may encounter errors.
</li>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
criticalChange
Type:
xsd:boolean, predefined
Use:
optional
Defined:
locally within (this) sendMeetingRequest element
When this attribute is set to "true", <lastUpdateTime> is updated when invitations are sent to the attendees. If "false", <lastUpdateTime> remains untouched.
XML Source (see within schema source)
<xsd:attribute name="criticalChange" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
When this attribute is set to "true", &lt;lastUpdateTime&gt; is
updated when invitations are sent to the attendees. If "false",
&lt;lastUpdateTime&gt; remains untouched.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
deleteOnCompletion
Type:
xsd:boolean, predefined
Use:
optional
Defined:
locally within (this) sendMeetingRequest element
This event will be deleted upon completion of this sendMeetingRequest. This behavior is intended for deleting a meeting and sending cancellations. If recurrenceId is present (and valid), <b>only this particular recurring instance or exception is deleted</b>, in which case a new <deletedExceptionDate> is added to the recurrence rule.
XML Source (see within schema source)
<xsd:attribute name="deleteOnCompletion" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
This event will be deleted upon completion of this sendMeetingRequest.
This behavior is intended for deleting a meeting and sending cancellations.
If recurrenceId is present (and valid),
<b>
only this particular recurring
instance or exception is deleted
</b>
, in which case a new
&lt;deletedExceptionDate&gt; is added to the recurrence rule.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
eventId
Type:
hs:idRefType
Use:
required
Defined:
locally within (this) sendMeetingRequest element
This is the puid of the event which to send meeting invitations or cancellations to. This event must already exist within the .NET Calendar service. Additional server constraints are implemented which verify that potential updates to the attendee tables occur for this event only. This is a required field.
XML Source (see within schema source)
<xsd:attribute name="eventId" type="hs:idRefType" use="required">
<xsd:annotation>
<xsd:documentation>
This is the puid of the event which to send meeting invitations
or cancellations to. This event must already exist within the
.NET Calendar service. Additional server constraints are
implemented which verify that potential updates to the attendee
tables occur for this event only. This is a required field.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
recurrenceId
Type:
xsd:dateTime, predefined
Use:
optional
Defined:
locally within (this) sendMeetingRequest element
The optional recurrenceId allows the meeting organizer to send invitations for only a particular instance of a recurring event. If the event is not a recurring event, or if recurrenceId does not correspond to a valid instance/exception, sendMeetingRequest will fail with an error.
XML Source (see within schema source)
<xsd:attribute name="recurrenceId" type="xsd:dateTime" use="optional">
<xsd:annotation>
<xsd:documentation>
The optional recurrenceId allows the meeting organizer to send
invitations for only a particular instance of a recurring event.
If the event is not a recurring event, or if recurrenceId does
not correspond to a valid instance/exception, sendMeetingRequest
will fail with an error.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
Content Element Detail (all declarations; 3/3)
invite
Type:
anonymous complexType, complex content
Defined:
locally within (this) sendMeetingRequest element
XML Source (see within schema source)
<xsd:element name="invite">
<xsd:complexType>
<xsd:attribute name="behavior" type="sendMeetingBehaviorEnum" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute will give the option to either choose to send
invitations to "all" attendees in the event's attendee table,
or send to "none" of them. A third value of "default" would
give the default behavior of sending invitations to only the
new attendees in the &lt;replaceRequest&gt; block. When this
attribute is set, .NET Calendar will ignore anything within
the &lt;invite&gt; node.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="attendee" type="hs:userReference">
<xsd:annotation>
<xsd:documentation>
Contains information about this attendee to be invited. An invited
attendee must already exist in the organizer's attendee table. This
attendee may originally be there prior to the sendMeetingRequest
method, or be the result of the update operation to this meeting.
<br/>
To change the attendee's inviteType, the update operation should
be used.
<br/>
When invitations are sent, the attendee's &lt;responseTime&gt;
is set to the current time (now) as a side-effect.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
replaceRequest
Type:
hs:replaceRequestType, complex content
Defined:
locally within (this) sendMeetingRequest element
This replace request can only affect the meeting invitation in question, and is thus constrained to be only @select="/m:myCalendar/m:event[@id=@eventId]/...". It will not be allowed to replace-on-null so that event creation cannot be a side-effect.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="replaceRequest" type="hs:replaceRequestType">
<xsd:annotation>
<xsd:documentation>
This replace request can only affect the meeting invitation in question, and is
thus constrained to be only @select="/m:myCalendar/m:event[@id=@eventId]/...".
It will not be allowed to replace-on-null so that event creation cannot be a
side-effect.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
uninvite
Type:
anonymous complexType, complex content
Defined:
locally within (this) sendMeetingRequest element
XML Source (see within schema source)
<xsd:element name="uninvite">
<xsd:complexType>
<xsd:attribute name="behavior" type="sendMeetingBehaviorEnum" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute will give the option to either choose to send
cancellations to "all" attendees in the event's attendee table,
or send to "none" of them. A third value of "default" would
give the default behavior of sending cancellations to all
attendees who are replaced in the &lt;replaceRequest&gt; block.
When this attribute is set, .NET Calendar will ignore anything
within the &lt;uninvite&gt; node.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="attendee" type="uninviteAttendeeType">
<xsd:annotation>
<xsd:documentation>
Contains a list of people to uninvite. Uninvited attendees must already exist
in the organizer's attendee table, or else these users are ignored.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>