public class Appointment extends Item implements ICalendarActionProvider
Constructor and Description |
---|
Appointment(ExchangeService service)
Initializes an unsaved local instance of Appointment".
|
Appointment(ItemAttachment parentAttachment,
boolean isNew)
Initializes a new instance of Appointment.
|
Modifier and Type | Method and Description |
---|---|
CalendarActionResults |
accept(boolean sendResponse)
Accepts the meeting.
|
CalendarActionResults |
acceptTentatively(boolean sendResponse)
Tentatively accepts the meeting.
|
static Appointment |
bind(ExchangeService service,
ItemId id)
Binds to an existing appointment and loads its first class property.
|
static Appointment |
bind(ExchangeService service,
ItemId id,
PropertySet propertySet)
Binds to an existing appointment and loads the specified set of
property.
|
static Appointment |
bindToOccurrence(ExchangeService service,
ItemId recurringMasterId,
int occurenceIndex)
Binds to an existing appointment and loads its first class property.
|
static Appointment |
bindToOccurrence(ExchangeService service,
ItemId recurringMasterId,
int occurenceIndex,
PropertySet propertySet)
Binds to an existing appointment and loads its first class property.
|
static Appointment |
bindToRecurringMaster(ExchangeService service,
ItemId occurrenceId)
Binds to the master appointment of a recurring series and loads its first
class property.
|
static Appointment |
bindToRecurringMaster(ExchangeService service,
ItemId occurrenceId,
PropertySet propertySet)
Binds to the master appointment of a recurring series and loads its first
class property.
|
CalendarActionResults |
cancelMeeting()
Cancels the meeting and sends cancellation messages to all attendees.
|
CalendarActionResults |
cancelMeeting(String cancellationMessageText)
Cancels the meeting and sends cancellation messages to all attendees.
|
AcceptMeetingInvitationMessage |
createAcceptMessage(boolean tentative)
Creates a local meeting acceptance message that can be customized and
sent.
|
CancelMeetingMessage |
createCancelMeetingMessage()
Creates a local meeting acceptance message that can be customized and
sent.
|
DeclineMeetingInvitationMessage |
createDeclineMessage()
Creates a local meeting declination message that can be customized and
sent.
|
ResponseMessage |
createForward()
Creates a forward message from this appointment.
|
ResponseMessage |
createReply(boolean replyAll)
Creates a reply response to the organizer and/or attendees of the
meeting.
|
CalendarActionResults |
decline(boolean sendResponse)
Declines the meeting invitation.
|
void |
delete(DeleteMode deleteMode,
SendCancellationsMode sendCancellationsMode)
Deletes this appointment.
|
void |
forward(MessageBody bodyPrefix,
EmailAddress... toRecipients)
Forwards the appointment.
|
void |
forward(MessageBody bodyPrefix,
Iterable<EmailAddress> toRecipients)
Forwards the appointment.
|
Integer |
getAdjacentMeetingCount()
Gets the number of calendar entries that are adjacent to this appointment
in the authenticated user's calendar.
|
ItemCollection<Appointment> |
getAdjacentMeetings()
Gets a list of meetings that conflict with this appointment in the
authenticated user's calendar.
|
Boolean |
getAllowNewTimeProposal()
Gets a value indicating whether new time proposals are allowed
for attendees of this meeting.
|
Date |
getAppointmentReplyTime()
Gets the time when the attendee replied to the meeting request.
|
Integer |
getAppointmentSequenceNumber()
Gets the sequence number of this appointment.
|
Integer |
getAppointmentState()
Gets the state of this appointment.
|
AppointmentType |
getAppointmentType()
Gets a value indicating the type of this appointment.
|
Integer |
getConferenceType()
Gets the type of conferencing that will be used during the
meeting.
|
Integer |
getConflictingMeetingCount()
Gets the number of calendar entries that conflict with this appointment
in the authenticated user's calendar.
|
ItemCollection<Appointment> |
getConflictingMeetings()
Gets a list of meetings that conflict with this appointment in the
authenticated user's calendar.
|
protected SendCancellationsMode |
getDefaultSendCancellationsMode()
Gets the default setting for sending cancellations on Delete.
|
protected SendInvitationsMode |
getDefaultSendInvitationsMode()
Gets the default settings for sending invitations on Save.
|
protected SendInvitationsOrCancellationsMode |
getDefaultSendInvitationsOrCancellationsMode()
Gets the default settings for sending invitations on Save.
|
DeletedOccurrenceInfoCollection |
getDeletedOccurrences()
Gets a list of deleted occurrences for this meeting.
|
TimeSpan |
getDuration()
Gets the duration of this appointment.
|
Date |
getEnd()
Gets or sets the end time of the appointment.
|
TimeZoneDefinition |
getEndTimeZone()
Gets the start time zone.
|
OccurrenceInfo |
getFirstOccurrence()
Gets an OccurrenceInfo identifying the first occurrence of this meeting.
|
Date |
getICalDateTimeStamp()
Gets the ICalendar DateTimeStamp.
|
Date |
getICalRecurrenceId()
Gets the ICalendar RecurrenceId.
|
String |
getICalUid()
Gets the ICalendar Uid.
|
Boolean |
getIsAllDayEvent()
Gets a value indicating whether this appointment is an all day
event.
|
Boolean |
getIsCancelled()
Gets a value indicating whether the appointment has been cancelled.
|
protected boolean |
getIsCustomDateTimeScopingRequired()
Determines whether property defined with
ScopedDateTimePropertyDefinition require custom time zone scoping.
|
Boolean |
getIsMeeting()
Gets a value indicating whether the appointment is a meeting.
|
Boolean |
getIsOnlineMeeting()
Gets a value indicating whether this is an online meeting.
|
Boolean |
getIsRecurring()
Gets a value indicating whether the appointment is recurring.
|
Boolean |
getIsResponseRequested()
Gets a value indicating whether response are requested when
invitations are sent for this meeting.
|
OccurrenceInfo |
getLastOccurrence()
Gets an OccurrenceInfo identifying the first occurrence of this meeting.
|
LegacyFreeBusyStatus |
getLegacyFreeBusyStatus()
Gets a value indicating the free/busy status of the owner of this
appointment.
|
String |
getLocation()
Gets the location of this appointment.
|
Boolean |
getMeetingRequestWasSent()
Gets a value indicating whether the meeting request has already been
sent.
|
String |
getMeetingWorkspaceUrl()
Gets the URL of the meeting workspace.
|
ExchangeVersion |
getMinimumRequiredServerVersion()
Gets the minimum required server version.
|
OccurrenceInfoCollection |
getModifiedOccurrences()
Gets a list of modified occurrences for this meeting.
|
MeetingResponseType |
getMyResponseType()
Gets a value indicating what was the last response of the user that
loaded this meeting.
|
String |
getNetShowUrl()
Gets the URL of the Microsoft NetShow online meeting.
|
AttendeeCollection |
getOptionalAttendees()
Gets a list of optional attendeed for this meeting.
|
EmailAddress |
getOrganizer()
Gets the organizer of this meeting.
|
Date |
getOriginalStart()
Gets the original start time of this appointment.
|
Recurrence |
getRecurrence()
Gets the recurrence pattern for this appointment.
|
AttendeeCollection |
getRequiredAttendees()
Gets a list of required attendees for this meeting.
|
AttendeeCollection |
getResources()
Gets a list of resources for this meeting.
|
ServiceObjectSchema |
getSchema()
Internal method to return the schema associated with this type of object.
|
Date |
getStart()
Gets the start time of the appointment.
|
TimeZoneDefinition |
getStartTimeZone()
Gets the start time zone.
|
String |
getTimeZone()
Gets the name of the time zone this appointment is defined in.
|
String |
getWhen()
Gets a text indicating when this appointment occurs.
|
protected CalendarActionResults |
internalAccept(boolean tentative,
boolean sendResponse)
Accepts the meeting.
|
void |
reply(MessageBody bodyPrefix,
boolean replyAll)
Replies to the organizer and/or the attendees of the meeting.
|
void |
save(FolderId destinationFolderId,
SendInvitationsMode sendInvitationsMode)
Saves this appointment in the specified folder.
|
void |
save(SendInvitationsMode sendInvitationsMode)
Saves this appointment in the Calendar folder.
|
void |
save(WellKnownFolderName destinationFolderName,
SendInvitationsMode sendInvitationsMode)
Saves this appointment in the specified folder.
|
void |
setAllowNewTimeProposal(Boolean value)
Sets the allow new time proposal.
|
void |
setConferenceType(Integer value)
Sets the conference type.
|
void |
setEnd(Date value)
Sets the end.
|
void |
setEndTimeZone(TimeZoneDefinition value)
Sets the start time zone.
|
void |
setICalUid(String value)
Sets the ICalendar Uid.
|
void |
setIsAllDayEvent(Boolean value)
Sets the checks if is all day event.
|
void |
setIsOnlineMeeting(Boolean value)
Sets the checks if is online meeting.
|
void |
setIsResponseRequested(Boolean value)
Sets the checks if is response requested.
|
void |
setLegacyFreeBusyStatus(LegacyFreeBusyStatus value)
Sets the legacy free busy status.
|
void |
setLocation(String value)
Sets the location.
|
void |
setMeetingWorkspaceUrl(String value)
Sets the meeting workspace url.
|
void |
setNetShowUrl(String value)
Sets the net show url.
|
void |
setRecurrence(Recurrence value)
Sets the recurrence.
|
void |
setStart(Date value)
Sets the start.
|
void |
setStartTimeZone(TimeZoneDefinition value)
Sets the start time zone.
|
void |
update(ConflictResolutionMode conflictResolutionMode,
SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
Applies the local changes that have been made to this appointment.
|
void |
validate()
Validates this instance.
|
copy, copy, delete, getAllowedResponseActions, getAttachments, getBody, getCategories, getConversationId, getCulture, getDateTimeCreated, getDateTimeReceived, getDateTimeSent, getDefaultAffectedTaskOccurrences, getDisplayCc, getDisplayTo, getEffectiveRights, getExtendedProperties, getHasAttachments, getId, getIdPropertyDefinition, getImportance, getInReplyTo, getInternetMessageHeaders, getIsAssociated, getIsDraft, getIsFromMe, getIsNew, getIsReminderSet, getIsResend, getIsSubmitted, getIsTimeZoneHeaderRequired, getIsUnmodified, getItemClass, getLastModifiedName, getLastModifiedTime, getMimeContent, getParentAttachment, getParentFolderId, getReminderDueBy, getReminderMinutesBeforeStart, getRootItemId, getSensitivity, getSize, getSubject, getUniqueBody, getWebClientEditFormQueryString, getWebClientReadFormQueryString, hasUnprocessedAttachmentChanges, internalCreate, internalDelete, internalLoad, internalUpdate, isAttachment, move, move, removeExtendedProperty, save, save, save, setBody, setCategories, setCulture, setExtendedProperty, setImportance, setInReplyTo, setIsReminderSet, setItemClass, setMimeContent, setReminderDueBy, setReminderMinutesBeforeStart, setSensitivity, setSubject, throwIfThisIsAttachment, update
addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getChangeXmlElementName, getDeleteFieldXmlElementName, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getSetFieldXmlElementName, getXmlElementName, getXmlElementNameOverride, isDirty, isNew, load, load, loadFromXml, loadFromXml, removeServiceObjectChangedEvent, schema, setService, throwIfThisIsNew, throwIfThisIsNotNew, tryGetExtendedProperty, tryGetProperty, tryGetProperty, writeToXml, writeToXmlForUpdate
public Appointment(ExchangeService service) throws Exception
service
- The ExchangeService instance to which this appointmtnt is
bound.Exception
- the exceptionpublic Appointment(ItemAttachment parentAttachment, boolean isNew) throws Exception
parentAttachment
- the parent attachmentisNew
- If true, attachment is new.Exception
- the exceptionpublic static Appointment bind(ExchangeService service, ItemId id, PropertySet propertySet) throws Exception
service
- the serviceid
- the idpropertySet
- the property setException
- the exceptionpublic static Appointment bind(ExchangeService service, ItemId id) throws Exception
service
- the serviceid
- the idException
- the exceptionpublic static Appointment bindToOccurrence(ExchangeService service, ItemId recurringMasterId, int occurenceIndex) throws Exception
service
- the servicerecurringMasterId
- the recurring master idoccurenceIndex
- the occurence indexException
- the exceptionpublic static Appointment bindToOccurrence(ExchangeService service, ItemId recurringMasterId, int occurenceIndex, PropertySet propertySet) throws Exception
service
- the servicerecurringMasterId
- the recurring master idoccurenceIndex
- the occurence indexpropertySet
- the property setException
- the exceptionpublic static Appointment bindToRecurringMaster(ExchangeService service, ItemId occurrenceId) throws Exception
service
- the serviceoccurrenceId
- the occurrence idException
- the exceptionpublic static Appointment bindToRecurringMaster(ExchangeService service, ItemId occurrenceId, PropertySet propertySet) throws Exception
service
- the serviceoccurrenceId
- the occurrence idpropertySet
- the property setException
- the exceptionpublic ServiceObjectSchema getSchema()
public ExchangeVersion getMinimumRequiredServerVersion()
getMinimumRequiredServerVersion
in class Item
protected boolean getIsCustomDateTimeScopingRequired()
getIsCustomDateTimeScopingRequired
in class ServiceObject
public ResponseMessage createReply(boolean replyAll) throws Exception
replyAll
- the reply allException
- the exceptionpublic void reply(MessageBody bodyPrefix, boolean replyAll) throws Exception
bodyPrefix
- the body prefixreplyAll
- the reply allException
- the exceptionpublic ResponseMessage createForward() throws Exception
Exception
- the exceptionpublic void forward(MessageBody bodyPrefix, EmailAddress... toRecipients) throws Exception
bodyPrefix
- the body prefixtoRecipients
- the to recipientsException
- the exceptionpublic void forward(MessageBody bodyPrefix, Iterable<EmailAddress> toRecipients) throws Exception
bodyPrefix
- the body prefixtoRecipients
- the to recipientsException
- the exceptionpublic void save(WellKnownFolderName destinationFolderName, SendInvitationsMode sendInvitationsMode) throws Exception
destinationFolderName
- the destination folder namesendInvitationsMode
- the send invitations modeException
- the exceptionpublic void save(FolderId destinationFolderId, SendInvitationsMode sendInvitationsMode) throws Exception
destinationFolderId
- the destination folder idsendInvitationsMode
- the send invitations modeException
- the exceptionpublic void save(SendInvitationsMode sendInvitationsMode) throws Exception
sendInvitationsMode
- the send invitations modeException
- the exceptionpublic void update(ConflictResolutionMode conflictResolutionMode, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode) throws Exception
conflictResolutionMode
- the conflict resolution modesendInvitationsOrCancellationsMode
- the send invitations or cancellations modeException
- the exceptionpublic void delete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode) throws Exception
deleteMode
- the delete modesendCancellationsMode
- the send cancellations modeException
- the exceptionpublic AcceptMeetingInvitationMessage createAcceptMessage(boolean tentative) throws Exception
createAcceptMessage
in interface ICalendarActionProvider
tentative
- the tentativeException
- the exceptionpublic CancelMeetingMessage createCancelMeetingMessage() throws Exception
Exception
- the exceptionpublic DeclineMeetingInvitationMessage createDeclineMessage() throws Exception
createDeclineMessage
in interface ICalendarActionProvider
Exception
- the exceptionpublic CalendarActionResults accept(boolean sendResponse) throws Exception
accept
in interface ICalendarActionProvider
sendResponse
- the send responseException
- the exceptionpublic CalendarActionResults acceptTentatively(boolean sendResponse) throws Exception
acceptTentatively
in interface ICalendarActionProvider
sendResponse
- the send responseException
- the exceptionprotected CalendarActionResults internalAccept(boolean tentative, boolean sendResponse) throws Exception
tentative
- the tentativesendResponse
- the send responseException
- the exceptionpublic CalendarActionResults cancelMeeting() throws Exception
Exception
- the exceptionpublic CalendarActionResults cancelMeeting(String cancellationMessageText) throws Exception
cancellationMessageText
- the cancellation message textException
- the exceptionpublic CalendarActionResults decline(boolean sendResponse) throws Exception
decline
in interface ICalendarActionProvider
sendResponse
- the send responseException
- the exceptionprotected SendCancellationsMode getDefaultSendCancellationsMode()
getDefaultSendCancellationsMode
in class Item
protected SendInvitationsMode getDefaultSendInvitationsMode()
getDefaultSendInvitationsMode
in class Item
protected SendInvitationsOrCancellationsMode getDefaultSendInvitationsOrCancellationsMode()
getDefaultSendInvitationsOrCancellationsMode
in class Item
public Date getStart() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setStart(Date value) throws Exception
value
- the new startException
- the exceptionpublic Date getEnd() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setEnd(Date value) throws Exception
value
- the new endException
- the exceptionpublic Date getOriginalStart() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Boolean getIsAllDayEvent() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setIsAllDayEvent(Boolean value) throws Exception
value
- the new checks if is all day eventException
- the exceptionpublic LegacyFreeBusyStatus getLegacyFreeBusyStatus() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setLegacyFreeBusyStatus(LegacyFreeBusyStatus value) throws Exception
value
- the new legacy free busy statusException
- the exceptionpublic String getLocation() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setLocation(String value) throws Exception
value
- the new locationException
- the exceptionpublic String getWhen() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Boolean getIsMeeting() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Boolean getIsCancelled() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Boolean getIsRecurring() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Boolean getMeetingRequestWasSent() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Boolean getIsResponseRequested() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setIsResponseRequested(Boolean value) throws Exception
value
- the new checks if is response requestedException
- the exceptionpublic AppointmentType getAppointmentType() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic MeetingResponseType getMyResponseType() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic EmailAddress getOrganizer() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic AttendeeCollection getRequiredAttendees() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic AttendeeCollection getOptionalAttendees() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic AttendeeCollection getResources() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Integer getConflictingMeetingCount() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Integer getAdjacentMeetingCount() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ItemCollection<Appointment> getConflictingMeetings() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ItemCollection<Appointment> getAdjacentMeetings() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic TimeSpan getDuration() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic String getTimeZone() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Date getAppointmentReplyTime() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Integer getAppointmentSequenceNumber() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Integer getAppointmentState() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Recurrence getRecurrence() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setRecurrence(Recurrence value) throws Exception
value
- the new recurrenceException
- the exceptionpublic OccurrenceInfo getFirstOccurrence() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic OccurrenceInfo getLastOccurrence() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic OccurrenceInfoCollection getModifiedOccurrences() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic DeletedOccurrenceInfoCollection getDeletedOccurrences() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic TimeZoneDefinition getStartTimeZone() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setStartTimeZone(TimeZoneDefinition value) throws Exception
value
- the new start time zoneException
- the exceptionpublic TimeZoneDefinition getEndTimeZone() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setEndTimeZone(TimeZoneDefinition value) throws Exception
value
- the new end time zoneException
- the exceptionpublic Integer getConferenceType() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setConferenceType(Integer value) throws Exception
value
- the new conference typeException
- the exceptionpublic Boolean getAllowNewTimeProposal() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setAllowNewTimeProposal(Boolean value) throws Exception
value
- the new allow new time proposalException
- the exceptionpublic Boolean getIsOnlineMeeting() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setIsOnlineMeeting(Boolean value) throws Exception
value
- the new checks if is online meetingException
- the exceptionpublic String getMeetingWorkspaceUrl() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setMeetingWorkspaceUrl(String value) throws Exception
value
- the new meeting workspace urlException
- the exceptionpublic String getNetShowUrl() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setNetShowUrl(String value) throws Exception
value
- the new net show urlException
- the exceptionpublic String getICalUid() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setICalUid(String value) throws Exception
value
- the i cal uidException
public Date getICalRecurrenceId() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Date getICalDateTimeStamp() throws ServiceLocalException
ServiceLocalException
- the service local exceptionCopyright © 2012–2015 Microsoft. All rights reserved.