Documentation

Introduction

Getting started

Code examples

FAQ

API Reference (JavaDoc)

Latest release

Version 3.0.4 (2013-06-07)

API Reference

Overview |

AddressEntriesCollection

AddressEntry

AddressList

AddressListsCollection

AttachmentsCollection

IAttachmentsContainer

ItemPropertiesCollection

LibraryNotFoundException

OutlookAppointmentRecipient

OutlookAttachment

OutlookBarGroup

OutlookBarGroupsCollection

OutlookBarPane

OutlookBarShortcut

OutlookBarShortcutsCollection

OutlookBarStorage

OutlookBarViewType

OutlookContact

OutlookDistributionList

OutlookJournalRecipient

OutlookMeetingRecipient

OutlookTaskRequestAccept

OutlookTaskRequestDecline

OutlookTaskRequestUpdate

UserPropertiesCollection

Class OutlookAppointment

java.lang.Object
  └ com.moyosoft.connector.ms.outlook.item.OutlookItem
      └ com.moyosoft.connector.ms.outlook.appointment.OutlookAppointment

Implemented Interfaces:

IAttachmentsContainer

public class OutlookAppointment extends OutlookItem implements IAttachmentsContainer

Represents an appointment or meeting item stored in the Outlook calendar.

A new appointment can be created by instantiating this class. To save the new appointment to the calendar, call the method save().

This class provides getter and setter methods to access or modify the appointment's properties.

See Also:

OutlookAppointment, save

Constructors

	public	OutlookAppointment (OutlookFolder folder)
		Creates a new appointment in the specified folder

	public	OutlookAppointment (Outlook outlookApplication)
		Creates a new appointment item in the default calendar folder

	public	OutlookAppointment (com.moyosoft.connector.com.Dispatch dispatch)

Methods

	void	clearRecurrencePattern ()

	void	close (InspectorClose saveMode)

	OutlookAttachment	createAttachment (java.io.File pAttachmentFile, AttachmentType pType)

	OutlookMail	forwardAsVcal ()

	AttachmentsCollection	getAttachments ()

	int	getAttachmentsCount ()

	String	getBillingInformation ()

	String	getBody ()

	BusyStatus	getBusyStatus ()

	String	getCategories ()

	int	getColorLabel ()

	String	getCompanies ()

	String	getConferenceServerPassword ()

	ConflictsCollection	getConflicts ()

	String	getConversationIndex ()

	String	getConversationTopic ()

	DownloadState	getDownloadState ()

	int	getDuration ()

	java.util.Date	getEnd ()

	FormDescription	getFormDescription ()

	String	getGlobalAppointmentId ()

	ImportanceType	getImportance ()

	Inspector	getInspector ()

	int	getInternetCodepage ()
		The 'InternetCodepage' property is only supported by Outlook 2002 or higher. With other versions this method will throw an ComponentObjectModelException.

	boolean	getIsRecurring ()
		Deprecated - Use the isRecurring() method instead.

	ItemPropertiesCollection	getItemProperties ()

	String	getLocation ()

	RemoteStatus	getMarkForDownload ()

	MeetingStatus	getMeetingStatus ()

	String	getMeetingWorkspaceURL ()
		The 'MeetingWorkspaceURL' property is only supported by Outlook 2003 or higher. With other versions this method will throw an ComponentObjectModelException.

	String	getMessageClass ()

	String	getMileage ()

	String	getNetMeetingDocPathName ()

	String	getNetMeetingOrganizerAlias ()

	String	getNetMeetingServer ()

	NetMeetingType	getNetMeetingType ()

	String	getNetShowURL ()

	String	getOptionalAttendees ()

	String	getOrganizer ()

	RecipientsCollection	getRecipients ()

	RecurrencePattern	getRecurrencePattern ()

	RecurrenceState	getRecurrenceState ()

	int	getReminderMinutesBeforeStart ()

	String	getReminderSoundFile ()

	java.util.Date	getReplyTime ()

	String	getRequiredAttendees ()

	String	getResources ()

	ResponseStatus	getResponseStatus ()

	Account	getSendUsingAccount ()
		Returns the account used when sending this message. The accounts are only supported by Outlook 2007 or later; with other versions this method will throw an ComponentObjectModelException. This method is only available in the Professional edition of Java Outlook Connector.

	SensitivityType	getSensitivity ()

	int	getSize ()

	java.util.Date	getStart ()

	String	getSubject ()

	OutlookItemType	getType ()

	UserPropertiesCollection	getUserProperties ()

	boolean	isAllDayEvent ()

	boolean	isAutoResolvedWinner ()

	boolean	isConferenceServerAllowExternal ()

	boolean	isConflict ()

	boolean	isNetMeetingAutoStart ()

	boolean	isNoAging ()

	boolean	isOnlineMeeting ()

	boolean	isRecurring ()

	boolean	isReminderOverrideDefault ()

	boolean	isReminderPlaySound ()

	boolean	isReminderSet ()

	boolean	isResponseRequested ()

	boolean	isSaved ()

	boolean	isUnRead ()

	OutlookMeeting	respond (MeetingResponse response)

	OutlookMeeting	respond (MeetingResponse response, boolean dontDisplayDialogBox)

	OutlookMeeting	respond (MeetingResponse response, boolean dontDisplayDialogBox, boolean promptUser)

	void	send ()

	void	setAllDayEvent (boolean value)

	void	setBillingInformation (String value)

	void	setBody (String value)

	void	setBusyStatus (BusyStatus value)

	void	setCategories (String value)

	void	setColorLabel (int value)

	void	setCompanies (String value)

	void	setConferenceServerAllowExternal (boolean value)

	void	setConferenceServerPassword (String value)

	void	setDuration (int value)

	void	setEnd (java.util.Date value)

	void	setImportance (ImportanceType value)

	void	setInternetCodepage (int value)
		The 'InternetCodepage' property is only supported by Outlook 2002 or higher. With other versions this method will throw an ComponentObjectModelException.

	void	setIsOnlineMeeting (boolean value)

	void	setLocation (String value)

	void	setMarkForDownload (RemoteStatus value)

	void	setMeetingStatus (MeetingStatus value)

	void	setMessageClass (String value)

	void	setMileage (String value)

	void	setNetMeetingAutoStart (boolean value)

	void	setNetMeetingDocPathName (String value)

	void	setNetMeetingOrganizerAlias (String value)

	void	setNetMeetingServer (String value)

	void	setNetMeetingType (NetMeetingType value)

	void	setNetShowURL (String value)

	void	setNoAging (boolean value)

	void	setOptionalAttendees (String value)

	void	setReminderMinutesBeforeStart (int value)

	void	setReminderOverrideDefault (boolean value)

	void	setReminderPlaySound (boolean value)

	void	setReminderSet (boolean value)

	void	setReminderSoundFile (String value)

	void	setReplyTime (java.util.Date value)

	void	setRequiredAttendees (String value)

	void	setResources (String value)

	void	setResponseRequested (boolean value)

	void	setSendUsingAccount (Account account)
		Define the account to be used when sending this message. The accounts are only supported by Outlook 2007 or later; with other versions this method will throw an ComponentObjectModelException. This method is only available in the Professional edition of Java Outlook Connector.

	void	setSensitivity (SensitivityType value)

	void	setStart (java.util.Date value)

	void	setSubject (String value)

	void	setUnRead (boolean value)

	void	showCategoriesDialog ()

Inherited methods

Community comments

Write a comment >

Recurring appointment

Vote up | Vote down

Here's how to create a recurring appointment:

Calendar calendar = Calendar.getInstance();
Outlook outlookApplication = new Outlook();

// Create a new appointment object:
OutlookAppointment appointment = new OutlookAppointment(outlookApplication.getDefaultFolder(FolderType.CALENDAR));

// Start the appointment now:
appointment.setStart(calendar.getTime());
            
// Set subject and duration:
appointment.setSubject("My appointment");
appointment.setDuration(30);

// Get the recurrence pattern:
RecurrencePattern pattern = appointment.getRecurrencePattern();

// Set as a daily recurring appointment:
pattern.setRecurrenceType(RecurrenceType.RECURS_DAILY);
pattern.setInterval(1); // Occurs every day

// End the recurrence pattern in 3 days (4 occurrences will exist):
calendar.add(Calendar.DAY_OF_MONTH, 3);
pattern.setPatternEndDate(calendar.getTime());

// Need to save for the modification to take effect:
appointment.save();
            
// Once saved, the appointment is recurring:
System.out.println("Is recurring: " + appointment.isRecurring());
            
outlookApplication.dispose();