IAppointment Interface

Article
08/20/2015

IAppointment Interface

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release. Provides properties and methods for defining and manipulating appointments.

CLSID

CD000120-8B95-11D1-82DB-00C04FB1625D

Extends

IDispatch

Type Library

Microsoft CDO for Exchange 2000 Library

DLL Implemented In

CDOEX.DLL

Member Summary

The following table lists the properties of the IAppointment interface.

Name Description

AllDayEvent Specifies TRUE or FALSE, depending on whether an event is scheduled for an entire day.

Attachments Returns the collection of attachments in a message. This property is read-only.

Attendees Returns the IAttendees interface on the implementing object. This property is read-only.

BodyPart Returns the IBodyPart interface on the implementing object. This property is read-only.

BusyStatus
Specifies how an appointment appears in the free/busy view.

Note that when there is more than one appointment during an interval, the free/busy status returned is the highest status for that interval. The status values ranked from highest to lowest are OOF, Busy, Tentative, and Free.

For more information about using free/busy information, see Checking Free/Busy Status.

Configuration Contains a Configuration object reference. This object defines the messaging configuration used by the Message object.

Contact Contains a person's name as a contact for an appointment.

ContactURL Contains a URL for accessing an alternative format of the contact information.

DataSource Returns the IDataSource interface on the implementing object. This property is read-only.

Duration Contains the duration of an appointment in seconds.
Either a Duration or an EndTime Property is required. Duration must be greater than or equal to zero if specified. If EndTime is specified, Duration is ignored.

EndTime Contains the time an appointment ends.
Either a Duration Property or an EndTime is required. EndTime must be greater than or equal to the StartTime Property. If EndTime is specified, Duration is ignored.

Exceptions Returns an IExceptions collection of exceptions for a recurring schedule of appointments. This property is read-only.

Fields Returns a Microsoft® ActiveX® Data Objects (ADO) Fields interface on an ADO Fields collection object. The object contains the resource fields associated with a message. This property is read-only.

GEOLatitude Contains the geographical latitude of an appointment's location.

GEOLongitude Contains the geographical longitude of an appointment's location.

Keywords Contains keywords identifying an appointment.

Location Contains an appointment's meeting location.

LocationURL Contains a URL for accessing an alternative format of the location information.

MeetingStatus Contains the status of an appointment: Tentative, Confirmed, or Cancelled.

Priority Contains the appointment's priority status: Normal, Urgent, or Nonurgent.

RecurrencePatterns Returns an IRecurrencePatterns collection of recurring information for a recurring appointment. This property is read-only.

ReplyTime Returns the time a recipient replied to a meeting request. This property is read-only.
This value is updated by Collaboration Data Objects (CDO) when the IAppointment::Accept, IAppointment::AcceptTentative, or IAppointment::Decline method is called. This value can be used to determine which response is the most recent if an attendee sends more than one response to a meeting request.

Resources Contains a list of supportive resources for the appointment. The resources are represented as mailto URIs and are separated by commas — for example, "conf42@example.com, video1@example.com".

ResponseRequested Indicates whether a response is requested for an appointment.

Sensitivity Contains the status for an appointment's sensitivity: Company-Confidential, Personal, or Private.

StartTime Contains the starting time for an appointment.

Subject Contains the topic for the appointment.

TextBody Contains the decoded text description of the appointment.

Transparent Contains whether the appointment appears in the free/busy string returned by the GetFreeBusy Method of the Addressee object. If the value of the Transparent property is "Transparent," the appointment does not appear in the free/busy string.
For more information about using free/busy information, see Checking Free/Busy Status.

Name	Description
AllDayEvent	Specifies TRUE or FALSE, depending on whether an event is scheduled for an entire day.
Attachments	Returns the collection of attachments in a message. This property is read-only.
Attendees	Returns the IAttendees interface on the implementing object. This property is read-only.
BodyPart	Returns the IBodyPart interface on the implementing object. This property is read-only.
BusyStatus	Specifies how an appointment appears in the free/busy view. Note that when there is more than one appointment during an interval, the free/busy status returned is the highest status for that interval. The status values ranked from highest to lowest are OOF, Busy, Tentative, and Free. For more information about using free/busy information, see Checking Free/Busy Status.
Configuration	Contains a Configuration object reference. This object defines the messaging configuration used by the Message object.
Contact	Contains a person's name as a contact for an appointment.
ContactURL	Contains a URL for accessing an alternative format of the contact information.
DataSource	Returns the IDataSource interface on the implementing object. This property is read-only.
Duration	Contains the duration of an appointment in seconds. Either a Duration or an EndTime Property is required. Duration must be greater than or equal to zero if specified. If EndTime is specified, Duration is ignored.
EndTime	Contains the time an appointment ends. Either a Duration Property or an EndTime is required. EndTime must be greater than or equal to the StartTime Property. If EndTime is specified, Duration is ignored.
Exceptions	Returns an IExceptions collection of exceptions for a recurring schedule of appointments. This property is read-only.
Fields	Returns a Microsoft® ActiveX® Data Objects (ADO) Fields interface on an ADO Fields collection object. The object contains the resource fields associated with a message. This property is read-only.
GEOLatitude	Contains the geographical latitude of an appointment's location.
GEOLongitude	Contains the geographical longitude of an appointment's location.
Keywords	Contains keywords identifying an appointment.
Location	Contains an appointment's meeting location.
LocationURL	Contains a URL for accessing an alternative format of the location information.
MeetingStatus	Contains the status of an appointment: Tentative, Confirmed, or Cancelled.
Priority	Contains the appointment's priority status: Normal, Urgent, or Nonurgent.
RecurrencePatterns	Returns an IRecurrencePatterns collection of recurring information for a recurring appointment. This property is read-only.
ReplyTime	Returns the time a recipient replied to a meeting request. This property is read-only. This value is updated by Collaboration Data Objects (CDO) when the IAppointment::Accept, IAppointment::AcceptTentative, or IAppointment::Decline method is called. This value can be used to determine which response is the most recent if an attendee sends more than one response to a meeting request.
Resources	Contains a list of supportive resources for the appointment. The resources are represented as mailto URIs and are separated by commas — for example, "conf42@example.com, video1@example.com".
ResponseRequested	Indicates whether a response is requested for an appointment.
Sensitivity	Contains the status for an appointment's sensitivity: Company-Confidential, Personal, or Private.
StartTime	Contains the starting time for an appointment.
Subject	Contains the topic for the appointment.
TextBody	Contains the decoded text description of the appointment.
Transparent	Contains whether the appointment appears in the free/busy string returned by the GetFreeBusy Method of the Addressee object. If the value of the Transparent property is "Transparent," the appointment does not appear in the free/busy string. For more information about using free/busy information, see Checking Free/Busy Status.

The following table lists the methods of the IAppointment interface.

Name Description

Accept Prepares and returns a CalendarMessage object for accepting a meeting request.

AcceptTentative Prepares and returns a CalendarMessage object for tentatively accepting a meeting request.

Cancel Prepares and returns a CalendarMessage object for canceling a meeting. You can also remove specific attendees without canceling the entire meeting.

CreateRequest Prepares and returns a CalendarMessage object for sending a meeting request.

Decline Prepares and returns a CalendarMessage object for declining a meeting request.

GetFirstInstance Returns the first instance of a recurring appointment.

GetInterface Returns the specified dual interface on the object.

GetNextInstance Returns the next instance of a recurring appointment based on the start and end times from the GetFirstInstance Method. Returns the first instance of a recurring appointment if not preceded by GetFirstInstance Method or another call to GetNextInstance.

GetRecurringMaster Returns the master recurring appointment for an exception or instance of the master appointment.

Invite This method returns a calendar message used to forward the appointment to another recipient.

Publish Returns a calendar message for the appointment with the method value set to "Publish." Published appointments do not have attendees. To send the calendar message, you need to add recipients using the IMessage interface of the calendar message.

Name	Description
Accept	Prepares and returns a CalendarMessage object for accepting a meeting request.
AcceptTentative	Prepares and returns a CalendarMessage object for tentatively accepting a meeting request.
Cancel	Prepares and returns a CalendarMessage object for canceling a meeting. You can also remove specific attendees without canceling the entire meeting.
CreateRequest	Prepares and returns a CalendarMessage object for sending a meeting request.
Decline	Prepares and returns a CalendarMessage object for declining a meeting request.
GetFirstInstance	Returns the first instance of a recurring appointment.
GetInterface	Returns the specified dual interface on the object.
GetNextInstance	Returns the next instance of a recurring appointment based on the start and end times from the GetFirstInstance Method. Returns the first instance of a recurring appointment if not preceded by GetFirstInstance Method or another call to GetNextInstance.
GetRecurringMaster	Returns the master recurring appointment for an exception or instance of the master appointment.
Invite	This method returns a calendar message used to forward the appointment to another recipient.
Publish	Returns a calendar message for the appointment with the method value set to "Publish." Published appointments do not have attendees. To send the calendar message, you need to add recipients using the IMessage interface of the calendar message.

Send us your feedback about the Microsoft Exchange Server 2003 SDK.

Build: June 2007 (2007.618.1)

Share via

IAppointment Interface

IAppointment Interface

Additional resources