Go to Robotic Automation version 22.1 documentation

MicrosoftOutlookAppointment Connector

Use the MicrosoftOutlookAppointment connector in solutions to schedule appointments in Microsoft Outlook.

When you add this component to an automation, the system places it on the Global tab of the component tray. For more information, see Adding Global Components to an Automation. This component must be global to be referenced by other automations in the project.

For more information, see General Component Properties, Methods, and Events.

 

Properties

Property

Description

AllDayEvent

This Boolean value indicates whether an appointment is an all-day event.

AppointmentItem

This property shows the Microsoft Outlook Appointment Item COM instance.

Body

This string shows the clear-text body of the Outlook appointment.

BusyStatus

This property shows the busy status of the user for an appointment.

Categories

This string gets the categories assigned to the Outlook appointment as a string.

CreationTime

Sets the creation date and time for the appointment as DateTime.

DownloadState

Sets the download state of the appointment. Item returned as OIDownloadState.

Duration

This property lists the duration, in minutes, of the appointment.

End

This datetime lists the end date and time of the appointment.

Importance

This property indicates the relative level of importance for the Outlook appointment.

IsConflict

This Boolean value indicates whether or not the appointment is in conflict.

IsRecurring

This Boolean value indicates whether or not the appointment is recurring.

IsRunning

This Boolean value indicates whether or not the Microsoft Outlook is running.

LastModificationTime

This property lists the date and time the appointment was last modified.

Location

This property lists the specific office location, such as Building 1 Room 1 or Suite 123, for the appointment.

MeetingStatus

This property lists the meeting status of the appointment.

MeetingWorkplaceURL

This property lists the URL for the Meeting Workspace that the appointment to which the item is linked. This property is not supported in Office XP and should not be used.

OptionalAttendees

This property lists the optional attendees names for the appointment as a string.

Organizer

This property lists the name of the organizer of the appointment.

OutlookApplication

Microsoft Outlook COM instance.

OutlookAppointment

Microsoft Outlook Appointment item COM instance.

Recipients

This property lists the collection of all the recipients of the Outlook appointment.

RecurrenceState

This property lists the recurrence of the Outlook appointment.

ReminderMinutesBeforeStart

This property lists the number of minutes in which a reminder is sent before the appointment.

ReminderOverrideDefault

This property indicates if the reminder overrides the default reminder behavior for the appointment.

ReplyTime

This property lists the reply time for the appointment.

RequiredAttendees

This property lists the attendees required to attend the appointment. The list is returned as a semicolon-delimited string.

Resources

A semicolon-delimited string that contains the resource names for the meeting.

ResponseRequested.

Boolean. Indicates if the sender would like a response to the meeting request for the appointment.

ResponseStatus

Sets the overall status of the meeting for the current user for the appointment.

Saved

Boolean. Indicates whether the Outlook appointment has not been modified since the last save.

Sensitivity

Gets the sensitivity for the Outlook appointment.

Start

Gets the start date and time of an appointment.

Subject

Gets the subject for the Outlook appointment as a string.

SupportedName

Supported Microsoft Office name.

SupportedVersion

Supported Microsoft Office version as a string.

UnRead

Boolean. This property indicates whether Outlook appointment has not been opened (read).

Version

This property indicates the current version of Microsoft Office being used as a string.

 

Methods

Method

Description

Parameters

Result Type

ClearRecurrencePattern

This method removes the recurrence settings and restores the single-occurrence state for an appointment.

None

Void

Close (1 Parameter)

This method closes and optionally saves changes to the Outlook message.

OlInspectorClose saveMode

Void

Copy

 

This method creates another instance of this appointment.  

None

MicrosoftOutlookAppointment

Delete

Deletes instance of this appointment. No access to this appointment should be made after calling this method.

None

Void

Display (1 Parameter)

This method displays a new Inspector for the appointment.

Boolean modal

Void

Forward

This method forwards the appointment as a virtual calendar item.

None

MicrosoftOutlookMail

GetRecurrencePattern

This method returns a recurrence pattern of an appointment.

None

RecurrencePattern

Move (1 Parameter)

 

This method moves this appointment to a new folder. Use a slash ( \ ) to separate sub-folders.

String folder

AppointmentItem

New

This method creates a new appointment and assigns it to this instance.

None

Void

PrintOut

This method prints the Outlook appointment using all default settings.

None

Void

Respond (3 parameters)

This method responds to a meeting request.

OlMeetingResponse response, Object noUI, Object additionalTextDialog

MeetingItem

Save

This method saves this appointment to the current or pre-defined folder.

None

Void

Send

This method sends the appointment.

None

Void

ShowCategoriesDialog

This method displays the Show Categories dialog, allowing the user to select categories that correspond to the subject of this appointment.

None

Void

 

Related information

Using the MicrosoftOutlookAppointment Connector

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 01 July 2024

© 2016 - 2024 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label