RDOAppointmentItem object

 

RDOAppointmentItem object represents an "IPM.Appointment" message in one of Outlook's calendar folders. RDOAppointmentItem is derived from the RDOMail object and as such inherits all the properties, methods and events implemented by the RDOMail object and adds the following methods and properties

 

Everywhere RDOMail object is normally returned (RDOSession.GetMessageFromID, RDOFolder.Items, etc), RDOAppointmentItem will be returned if the message class is "IPM.Appointment".

 

 

The example below creates a new appointment, populates its properties, and sends a meeting request to the specified attendees:

set Session = CreateObject("Redemption.RDOSession")
Session.Logon
set Appt = Session.GetDefaultFolder(olFolderCalendar).Items.Add
Appt.SendAsICal = false 'send as RTF rather than iCal
Appt.Subject = "Test Redemption Appt"
Appt.Body = "Test Appt Body"
Appt.Start = #02/1/2007 9:30#
set Recip= Appt.Recipients.Add("user@domain.com")
Recip.Type =olTo 'required attendee
Appt.Recipients.ResolveAll

Appt.Save
Appt.Send

 

Properties

Methods

 


Derived from: RDOMail

In addition to all the properties and methods specific to RDOAppointmentItem, it also implements all properties, methods and events of the RDOMail object, from which it is derived.


Properties


AllDayEvent

True if the appointment is an all-day event (as opposed to a specified time). Read/write Boolean.

 

 

BusyStatus

Returns or sets an rdoBusyStatus constant indicating the busy status of the user for the appointment. Read/write.

BusyStatuscan be one of these rdoBusyStatus constants.
olBusy
olFree
olOutOfOffice
olTentative

 

 

ConferenceServerAllowExternal

Read/write, string. Reserved for future use, introduced for compatibility with the AppointmentItem object in the Outlook Object Model.

 

 

ConferenceServerPassword

Read/write, string. Reserved for future use, introduced for compatibility with the AppointmentItem object in the Outlook Object Model.

 

 

Duration

Returns or sets a Long indicating the duration (in minutes) of the appointment. Read/write.

 

 

End

Returns or sets a Date indicating the end date and time of an appointment. Read/write.

 

 

EndInEndTimeZone

Returns or sets a Date indicating the end date and time of an appointment in the Time Zone specified by the EndTimeZone property. Read/write.

 

 

 

EndTimeZone

Returns or sets RDOTimezone object corresponding to the appointment end time zone. This property can be set through the Outlook UI only in Outlook 2007 or higher. Redemption can handle this property in any version  of Outlook or Exchange, but only Outlook 2007 will use it.

 

set Session = CreateObject("Redemption.RDOSession")
Session.Logon
set Appt = Session.GetDefaultFolder(olFolderCalendar).Items.Add
Appt.Subject = "Test Redemption Timezones"
Appt.Start = Now
Appt.Duration = 20
set StartTZ = Session.Timezones("Eastern Standard Time")
set EndTZ = Session.Timezones("Pacific Standard Time")
Appt.StartTimezone = StartTZ
Appt.EndTimezone = EndTZ

Appt.Save

 

EndUTC

Returns or sets a Date indicating the end date and time of an appointment in the UTC (GMT) time zone.

 

ForceUpdateToAllAttendees

Read/write, boolean. If false, updates are sent only to the attendees affected by the change (e.g. Attendee added or removed).

 

 

GlobalAppointmentID

Read-only, string. Global appointment id used by Outlook to correlate meeting requests/updates/responses with the existing appointment items in the Calendar folder.

 

 

IsOnlineMeeting

True if this is an online meeting. Read/write Boolean.

 

 

IsRecurring

True if the appointment is a recurring appointment. Read-only, Boolean.

 

 

Location

Returns or sets a String representing the specific office location (for example, Building 1 Room 1 or Suite 123) for the appointment. This property corresponds to the MAPI property PR_OFFICE_LOCATION. Read/write.

 

 

MeetingStatus

Returns or sets an rdoMeetingStatus constant specifying the meeting status of the appointment. Use this property to make a MeetingItem object available for the appointment. Read/write.
MeetingStatus can be one of these rdoMeetingStatus constants.
olMeeting
olMeetingCanceled
olMeetingReceived
olNonMeeting
 

 

MeetingWorkspaceURL

Returns the URL for the Meeting Workspace that the meeting or appointment item is linked to. Read/write. A Meeting Workspace is a shared Web site for planning the meeting and tracking the results.
 

 

NetMeetingAutoStart

True if this online meeting starts automatically. Read/write Boolean.
 

 

NetMeetingDocPathName

Returns or sets a String representing the full path to the Microsoft Office document specified for a Microsoft NetMeeting online meeting. Read/write.
 

 

NetMeetingOrganizerAlias

Returns or sets a String representing the alias of the meeting organizer, if this is an online meeting. Read/write.

 

 

NetMeetingServer

Returns or sets a String specifying the name of the Microsoft NetMeeting server being used for an online meeting. Read/write.
 

 

NetMeetingType

Sets or returns an OlNetMeetingType constant specifying the type of Microsoft NetMeeting. Read/write.

OlNetMeetingType can be one of these OlNetMeetingType constants.
olChat
olNetMeeting
olNetShow
 

 

NetShowURL

Returns or sets a String specifying the URL for a Microsoft NetShow online meeting. Read/write.
 

 

OptionalAttendees

Returns or sets a String representing the display string of optional attendees names for the appointment. This property corresponds to the MAPI property PR_DISPLAY_CC. Read/write.
 

 

Organizer

Returns a String representing the name of the organizer of the appointment. Read-only.

 

 

RecurrenceState

Returns an rdoRecurrenceState constant indicating the recurrence property of the specified object. Read-only.

RecurrenceState can be one of these rdoRecurrenceState constants.
olApptException
olApptMaster
olApptNotRecurring
olApptOccurrence
 

 

ReminderMinutesBeforeStart

Returns or sets a Long indicating the number of minutes the reminder should occur prior to the start of the appointment. Read/write.
 

 

ReplyTime

Returns or sets a Date indicating the reply time for the appointment. Read/write.
 

 

RequiredAttendees

Returns a semicolon-delimited String of required attendee names for the meeting appointment. This property only contains the display names for the required attendees. The attendee list should be set by using the Recipients collection. Read/write.
 

 

Resources

Returns a semicolon-delimited String of resource names for the meeting. This property contains the display names only. The Recipients collection should be used to modify the resource recipients. Resources are added as BCC recipients to the collection. Read/write.
 

 

ResponseRequested

True if the sender would like a response to the meeting request for the appointment. Read/write Boolean.

 

 

ResponseStatus

Returns an rdoResponseStatus constant indicating the overall status of the meeting for the current user for the appointment. Read-only.

ResponseStatus can be one of these rdoResponseStatus constants.
olResponseAccepted
olResponseDeclined
olResponseNone
olResponseNotResponded
olResponseOrganized
olResponseTentative
 

 

SendAsICal

If true, meeting request/updates will be sent in thee iCal format. If false, RTF format (TNEF) will be used. Read/write, Boolean.

 

 

Start

Returns or sets a Date indicating the starting date and time for the appointment. Read/write.
 

 

StartInStartTimeZone

Returns or sets a Date indicating the start date and time of an appointment in the Time Zone specified by the StartTimeZone property

 

 

StartTimeZone

Returns or sets RDOTimezone object corresponding to the appointment start time zone. This property can be set through the Outlook UI only in Outlook 2007 or higher. Redemption can handle this property in any version  of Outlook or Exchange, but only Outlook 2007 will use it.

 

see EndTimeZone example above

StartUTC

Returns or sets a Date indicating the start date and time of an appointment in the UTC (GMT) time zone.

 

 


Methods


ClearRecurrencePattern

Removes the recurrence settings and restores the single-occurrence state for an appointment.

 

 

GetRecurrencePattern

Returns an RDORecurrencePattern object that represents the recurrence attributes of an appointment. If there is no existing recurrence pattern, a new empty RDORecurrencePattern object is returned.

 

set Session = CreateObject("Redemption.RDOSession")
Session.Logon

set Appt = Session.GetDefaultFolder(olFolderCalendar).Items.Add
Appt.Subject = "Test Redemption Appt"
Appt.Body = "Test Appt Body"
Appt.Start = #02/1/2007 9:30#
Set myRecurrPatt = Appt.GetRecurrencePattern
myRecurrPatt.RecurrenceType = olRecursDaily
myRecurrPatt.Interval = 3
myRecurrPatt.PatternStartDate = #5/1/2006#
myRecurrPatt.PatternEndDate = #5/1/2007#
Appt.Save 

 

Respond(Response, fNoUI, fAdditionalTextDialog)

Responds to a meeting request for the RDOAppointmentItem object.

The original appointment is either marked appropriately (if accepted or tentatively accepted) or deletes the appointment (if declined).

Returns RDOMeetingItem object. To send the response, call RDOMeetingItem.Send (see example).

Response Required rdoMeetingResponse. The response to the request.


olMeetingTentative = 2
olMeetingAccepted = 3
olMeetingDeclined = 4

fNoUI - Introduced for compatibility with the Outlook Object Model. This argument is not used in the current version.

fAdditionalTextDialog - Introduced for compatibility with the Outlook Object Model. This argument is not used in the current version.
 

 

 
set Session = CreateObject("Redemption.RDOSession")
Session.Logon
set myFolder = Session.GetDefaultFolder(olFolderInbox)
Set myMtgReq = myFolder.Items.Find("MessageClass = 'IPM.Schedule.Meeting.Request'")
If TypeName(myMtgReq) <> "Nothing" Then
    Set myAppt = myMtgReq.GetAssociatedAppointment(True)
    Set myMtg = myAppt.Respond(olResponseAccepted)
    myMtg.Send
End If