MapiCalendar

Inheritance: java.lang.Object, com.aspose.email.MapiPropertyContainer, com.aspose.email.MapiMessageItemBase

public final class MapiCalendar extends MapiMessageItemBase

Represents the mapi calendar object

Constructors

Constructor Description
MapiCalendar() Initializes a new instance of the MapiCalendar class
MapiCalendar(String location, String summary, String description, Date startDate, Date endDate) Initializes a new instance of the MapiCalendar class.
MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, String organizer, MapiRecipientCollection attendees) Initializes a new instance of the MapiCalendar class.
MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, MapiElectronicAddress organizer, MapiRecipientCollection attendees) Initializes a new instance of the MapiCalendar class.

Methods

Method Description
getOrganizer() Gets or sets the organizer.
setOrganizer(MapiElectronicAddress value) Gets or sets the organizer.
getReminderDelta() Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object
setReminderDelta(int value) Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object
getReminderSet() Gets or sets a value indicating whether a reminder is set on the object
setReminderSet(boolean value) Gets or sets a value indicating whether a reminder is set on the object
getReminderFileParameter() Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
setReminderFileParameter(String value) Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
getAppointmentCounterProposal() Gets or sets a value indicating whether a Meeting Response object is a counter proposal.
setAppointmentCounterProposal(boolean value) Gets or sets a value indicating whether a Meeting Response object is a counter proposal.
getClientIntent() Gets or sets the actions the user has taken on this Meeting object.
setClientIntent(int value) Gets or sets the actions the user has taken on this Meeting object.
getStartDateTimeZone() Gets or sets time zone information that indicates the time zone of the StartDate property
setStartDateTimeZone(MapiCalendarTimeZone value) Gets or sets time zone information that indicates the time zone of the StartDate property
getEndDateTimeZone() Gets or sets time zone information that indicates the time zone of the EndDate property
setEndDateTimeZone(MapiCalendarTimeZone value) Gets or sets time zone information that indicates the time zone of the EndDate property
getAttendees() Gets or sets the attendees
setAttendees(MapiCalendarAttendees value) Gets or sets the attendees
getRecurrence() Gets or sets the recurrence properties
setRecurrence(MapiCalendarEventRecurrence value) Gets or sets the recurrence properties
isAllDay() Gets or sets a value indicating whether the event is an all-day event
setAllDay(boolean value) Gets or sets a value indicating whether the event is an all-day event
getKeyWords() Gets or sets the categories of the calendar object
setKeyWords(String value) Gets or sets the categories of the calendar object
getStartDate() Gets or sets the start date and time of the event.
setStartDate(Date value) Gets or sets the start date and time of the event.
getEndDate() Gets or sets the end date and time of the event.
setEndDate(Date value) Gets or sets the end date and time of the event.
getSequence() Gets or sets the sequence number
setSequence(int value) Gets or sets the sequence number
getBusyStatus() Gets or sets the busy status
setBusyStatus(int value) Gets or sets the busy status
getLocation() Gets or sets the location of the event
setLocation(String value) Gets or sets the location of the event
getUid() Gets the unique identifier
setUid(String value) Gets the unique identifier
save(String filePath, MapiCalendarSaveOptions saveOptions) Saves calendar object to the file with specified format using te default save options
save(OutputStream stream, MapiCalendarSaveOptions saveOptions) Saves calendar to the stream with specified save options
save(String filePath) Saves calendar object to the file with iCalendar format using te default save options
save(String filePath, int saveFormat) Saves calendar object to the file with specified format using te default save options
save(OutputStream stream) Saves calendar object to the file with iCalendar format using te default save options
save(OutputStream stream, int saveFormat) Saves calendar object to the stream with specified format using te default save options
dispose() Releases all resources.

MapiCalendar()

public MapiCalendar()

Initializes a new instance of the MapiCalendar class

MapiCalendar(String location, String summary, String description, Date startDate, Date endDate)

public MapiCalendar(String location, String summary, String description, Date startDate, Date endDate)

Initializes a new instance of the MapiCalendar class.

Parameters:

Parameter Type Description
location java.lang.String The appointment location.
summary java.lang.String The appointment summary.
description java.lang.String The appointment description.
startDate java.util.Date The start date.
endDate java.util.Date The end date.

MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, String organizer, MapiRecipientCollection attendees)

public MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, String organizer, MapiRecipientCollection attendees)

Initializes a new instance of the MapiCalendar class.

Parameters:

Parameter Type Description
location java.lang.String The meeting location.
summary java.lang.String The meeting summary.
description java.lang.String The meeting description.
startDate java.util.Date The start date.
endDate java.util.Date The end date.
organizer java.lang.String The meeting organizer address.
attendees MapiRecipientCollection The meeting attendees.

MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, MapiElectronicAddress organizer, MapiRecipientCollection attendees)

public MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, MapiElectronicAddress organizer, MapiRecipientCollection attendees)

Initializes a new instance of the MapiCalendar class.

Parameters:

Parameter Type Description
location java.lang.String The meeting location.
summary java.lang.String The meeting summary.
description java.lang.String The meeting description.
startDate java.util.Date The start date.
endDate java.util.Date The end date.
organizer MapiElectronicAddress The meeting organizer.
attendees MapiRecipientCollection The meeting attendees.

getOrganizer()

public final MapiElectronicAddress getOrganizer()

Gets or sets the organizer.

Returns: MapiElectronicAddress

setOrganizer(MapiElectronicAddress value)

public final void setOrganizer(MapiElectronicAddress value)

Gets or sets the organizer.

Parameters:

Parameter Type Description
value MapiElectronicAddress

getReminderDelta()

public final int getReminderDelta()

Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object

Returns: int

setReminderDelta(int value)

public final void setReminderDelta(int value)

Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object

Parameters:

Parameter Type Description
value int

getReminderSet()

public final boolean getReminderSet()

Gets or sets a value indicating whether a reminder is set on the object

Returns: boolean

setReminderSet(boolean value)

public final void setReminderSet(boolean value)

Gets or sets a value indicating whether a reminder is set on the object

Parameters:

Parameter Type Description
value boolean

getReminderFileParameter()

public final String getReminderFileParameter()

Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.

Returns: java.lang.String

setReminderFileParameter(String value)

public final void setReminderFileParameter(String value)

Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.

Parameters:

Parameter Type Description
value java.lang.String

getAppointmentCounterProposal()

public final boolean getAppointmentCounterProposal()

Gets or sets a value indicating whether a Meeting Response object is a counter proposal.

Returns: boolean

setAppointmentCounterProposal(boolean value)

public final void setAppointmentCounterProposal(boolean value)

Gets or sets a value indicating whether a Meeting Response object is a counter proposal.

Parameters:

Parameter Type Description
value boolean

getClientIntent()

public final int getClientIntent()

Gets or sets the actions the user has taken on this Meeting object.

Returns: int

setClientIntent(int value)

public final void setClientIntent(int value)

Gets or sets the actions the user has taken on this Meeting object.

Parameters:

Parameter Type Description
value int

getStartDateTimeZone()

public final MapiCalendarTimeZone getStartDateTimeZone()

Gets or sets time zone information that indicates the time zone of the StartDate property

Returns: MapiCalendarTimeZone

setStartDateTimeZone(MapiCalendarTimeZone value)

public final void setStartDateTimeZone(MapiCalendarTimeZone value)

Gets or sets time zone information that indicates the time zone of the StartDate property

Parameters:

Parameter Type Description
value MapiCalendarTimeZone

getEndDateTimeZone()

public final MapiCalendarTimeZone getEndDateTimeZone()

Gets or sets time zone information that indicates the time zone of the EndDate property

Returns: MapiCalendarTimeZone

setEndDateTimeZone(MapiCalendarTimeZone value)

public final void setEndDateTimeZone(MapiCalendarTimeZone value)

Gets or sets time zone information that indicates the time zone of the EndDate property

Parameters:

Parameter Type Description
value MapiCalendarTimeZone

getAttendees()

public final MapiCalendarAttendees getAttendees()

Gets or sets the attendees

Returns: MapiCalendarAttendees

setAttendees(MapiCalendarAttendees value)

public final void setAttendees(MapiCalendarAttendees value)

Gets or sets the attendees

Parameters:

Parameter Type Description
value MapiCalendarAttendees

getRecurrence()

public final MapiCalendarEventRecurrence getRecurrence()

Gets or sets the recurrence properties

Returns: MapiCalendarEventRecurrence

setRecurrence(MapiCalendarEventRecurrence value)

public final void setRecurrence(MapiCalendarEventRecurrence value)

Gets or sets the recurrence properties

Parameters:

Parameter Type Description
value MapiCalendarEventRecurrence

isAllDay()

public final boolean isAllDay()

Gets or sets a value indicating whether the event is an all-day event

Returns: boolean

setAllDay(boolean value)

public final void setAllDay(boolean value)

Gets or sets a value indicating whether the event is an all-day event

Parameters:

Parameter Type Description
value boolean

getKeyWords()

public final String getKeyWords()

Gets or sets the categories of the calendar object

Returns: java.lang.String

setKeyWords(String value)

public final void setKeyWords(String value)

Gets or sets the categories of the calendar object

Parameters:

Parameter Type Description
value java.lang.String

getStartDate()

public final Date getStartDate()

Gets or sets the start date and time of the event. If the date is not set, default value for java.util.Date is returned.

Returns: java.util.Date

setStartDate(Date value)

public final void setStartDate(Date value)

Gets or sets the start date and time of the event. If the date is not set, default value for java.util.Date is returned.

Parameters:

Parameter Type Description
value java.util.Date

getEndDate()

public final Date getEndDate()

Gets or sets the end date and time of the event. If the date is not set, default value for java.util.Date is returned.

Returns: java.util.Date

setEndDate(Date value)

public final void setEndDate(Date value)

Gets or sets the end date and time of the event. If the date is not set, default value for java.util.Date is returned.

Parameters:

Parameter Type Description
value java.util.Date

getSequence()

public final int getSequence()

Gets or sets the sequence number

Returns: int

setSequence(int value)

public final void setSequence(int value)

Gets or sets the sequence number

Parameters:

Parameter Type Description
value int

getBusyStatus()

public final int getBusyStatus()

Gets or sets the busy status

Returns: int

setBusyStatus(int value)

public final void setBusyStatus(int value)

Gets or sets the busy status

Parameters:

Parameter Type Description
value int

getLocation()

public final String getLocation()

Gets or sets the location of the event

Returns: java.lang.String

setLocation(String value)

public final void setLocation(String value)

Gets or sets the location of the event

Parameters:

Parameter Type Description
value java.lang.String

getUid()

public final String getUid()

Gets the unique identifier

Returns: java.lang.String

setUid(String value)

public final void setUid(String value)

Gets the unique identifier

Parameters:

Parameter Type Description
value java.lang.String

save(String filePath, MapiCalendarSaveOptions saveOptions)

public final void save(String filePath, MapiCalendarSaveOptions saveOptions)

Saves calendar object to the file with specified format using te default save options

Parameters:

Parameter Type Description
filePath java.lang.String A file path
saveOptions MapiCalendarSaveOptions A save options

save(OutputStream stream, MapiCalendarSaveOptions saveOptions)

public final void save(OutputStream stream, MapiCalendarSaveOptions saveOptions)

Saves calendar to the stream with specified save options

Parameters:

Parameter Type Description
stream java.io.OutputStream A stream to save to
saveOptions MapiCalendarSaveOptions A save options

save(String filePath)

public final void save(String filePath)

Saves calendar object to the file with iCalendar format using te default save options

Parameters:

Parameter Type Description
filePath java.lang.String A file path

save(String filePath, int saveFormat)

public final void save(String filePath, int saveFormat)

Saves calendar object to the file with specified format using te default save options

Parameters:

Parameter Type Description
filePath java.lang.String A file path
saveFormat int A save format

save(OutputStream stream)

public final void save(OutputStream stream)

Saves calendar object to the file with iCalendar format using te default save options

Parameters:

Parameter Type Description
stream java.io.OutputStream A stream to save to

save(OutputStream stream, int saveFormat)

public final void save(OutputStream stream, int saveFormat)

Saves calendar object to the stream with specified format using te default save options

Parameters:

Parameter Type Description
stream java.io.OutputStream A stream to save to
saveFormat int A save format

dispose()

public void dispose()

Releases all resources.