com.aspose.email

Interfaces

Classes

Enums

Exceptions

java.lang.Object
- com.aspose.email.MapiPropertyContainer
- - com.aspose.email.MapiMessageItemBase
  - - com.aspose.email.MapiCalendar

All Implemented Interfaces:

IMapiMessageItem, com.aspose.ms.System.IDisposable
```
public final class MapiCalendar
extends MapiMessageItemBase
```
Represents the mapi calendar object

Field Summary
- Fields inherited from class com.aspose.email.MapiMessageItemBase
  attachments, namedPropertyMappingStorage, recipients

Constructor Summary

Constructors
Constructor and 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.

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapiCalendar
```
public MapiCalendar()
```
    Initializes a new instance of the MapiCalendar class
  - MapiCalendar
```
public MapiCalendar(String location,
            String summary,
            String description,
            Date startDate,
            Date endDate)
```
    Initializes a new instance of the MapiCalendar class.
    
    Parameters:
    location - The appointment location.
    summary - The appointment summary.
    description - The appointment description.
    startDate - The start date.
    endDate - The end date.
  - MapiCalendar
```
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:
    location - The meeting location.
    summary - The meeting summary.
    description - The meeting description.
    startDate - The start date.
    endDate - The end date.
    organizer - The meeting organizer address.
    attendees - The meeting attendees.
- Method Detail
  - 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
  - setReminderDelta
```
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
  - getReminderSet
```
public final boolean getReminderSet()
```
    Gets or sets a value indicating whether a reminder is set on the object
  - setReminderSet
```
public final void setReminderSet(boolean value)
```
    Gets or sets a value indicating whether a reminder is set on the object
  - getReminderFileParameter
```
public final String getReminderFileParameter()
```
    Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
  - setReminderFileParameter
```
public final void setReminderFileParameter(String value)
```
    Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
  - getAppointmentCounterProposal
```
public final boolean getAppointmentCounterProposal()
```
    Gets or sets a value indicating whether a Meeting Response object is a counter proposal.
  - setAppointmentCounterProposal
```
public final void setAppointmentCounterProposal(boolean value)
```
    Gets or sets a value indicating whether a Meeting Response object is a counter proposal.
  - getClientIntent
```
public final int getClientIntent()
```
    Gets or sets the actions the user has taken on this Meeting object.
  - setClientIntent
```
public final void setClientIntent(int value)
```
    Gets or sets the actions the user has taken on this Meeting object.
  - getStartDateTimeZone
```
public final MapiCalendarTimeZone getStartDateTimeZone()
```
    Gets or sets time zone information that indicates the time zone of the StartDate property
  - setStartDateTimeZone
```
public final void setStartDateTimeZone(MapiCalendarTimeZone value)
```
    Gets or sets time zone information that indicates the time zone of the StartDate property
  - getEndDateTimeZone
```
public final MapiCalendarTimeZone getEndDateTimeZone()
```
    Gets or sets time zone information that indicates the time zone of the EndDate property
  - setEndDateTimeZone
```
public final void setEndDateTimeZone(MapiCalendarTimeZone value)
```
    Gets or sets time zone information that indicates the time zone of the EndDate property
  - getAttendees
```
public final MapiCalendarAttendees getAttendees()
```
    Gets or sets the attendees
  - setAttendees
```
public final void setAttendees(MapiCalendarAttendees value)
```
    Gets or sets the attendees
  - getRecurrence
```
public final MapiCalendarEventRecurrence getRecurrence()
```
    Gets or sets the recurrence properties
  - setRecurrence
```
public final void setRecurrence(MapiCalendarEventRecurrence value)
```
    Gets or sets the recurrence properties
  - isAllDay
```
public final boolean isAllDay()
```
    Gets or sets a value indicating whether the event is an all-day event
  - setAllDay
```
public final void setAllDay(boolean value)
```
    Gets or sets a value indicating whether the event is an all-day event
  - getKeyWords
```
public final String getKeyWords()
```
    Gets or sets the categories of the calendar object
  - setKeyWords
```
public final void setKeyWords(String value)
```
    Gets or sets the categories of the calendar object
  - 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 Date is returned.
  - setStartDate
```
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 Date is returned.
  - 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 Date is returned.
  - setEndDate
```
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 Date is returned.
  - getSequence
```
public final int getSequence()
```
    Gets or sets the sequence number
  - setSequence
```
public final void setSequence(int value)
```
    Gets or sets the sequence number
  - getBusyStatus
```
public final int getBusyStatus()
```
    Gets or sets the busy status
  - setBusyStatus
```
public final void setBusyStatus(int value)
```
    Gets or sets the busy status
  - getLocation
```
public final String getLocation()
```
    Gets or sets the location of the event
  - setLocation
```
public final void setLocation(String value)
```
    Gets or sets the location of the event
  - getUid
```
public final String getUid()
```
    Gets the unique identifier
  - setUid
```
public final void setUid(String value)
```
    Gets the unique identifier
  - save
```
public final void save(String filePath)
```
    Saves calendar object to the file with iCalendar format using te default save options
    
    Parameters:
    filePath - A file path
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - filePath is null or empty
  - save
```
public final void save(String filePath,
        int saveFormat)
```
    Saves calendar object to the file with specified format using te default save options
    
    Parameters:
    filePath - A file path
    saveFormat - A save format
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - filePath is null or empty
    
    com.aspose.ms.System.NotSupportedException - The specified saveFormat is not supported
  - save
```
public final void save(OutputStream stream)
```
    Saves calendar object to the file with iCalendar format using te default save options
    
    Parameters:
    stream - A stream to save to
    
    Throws:
    
    com.aspose.ms.System.ArgumentNullException - stream is null
    
    com.aspose.ms.System.NotSupportedException - stream does not support writing
  - save
```
public final void save(OutputStream stream,
        int saveFormat)
```
    Saves calendar object to the stream with specified format using te default save options
    
    Parameters:
    stream - A stream to save to
    saveFormat - A save format
    
    Throws:
    
    com.aspose.ms.System.ArgumentNullException - stream is null
    
    com.aspose.ms.System.NotSupportedException - The specified saveFormat is not supported
    
    com.aspose.ms.System.NotSupportedException - stream does not support writing
  - dispose
```
public void dispose()
```
    Releases all resources.
    
    Specified by:
    
    dispose in interface com.aspose.ms.System.IDisposable
    
    Overrides:
    
    dispose in class MapiMessageItemBase

com.aspose.email

Interfaces

Classes

Enums

Exceptions

Class MapiCalendar

Field Summary

Fields inherited from class com.aspose.email.MapiMessageItemBase

Constructor Summary

Method Summary

Methods inherited from class com.aspose.email.MapiMessageItemBase

Methods inherited from class com.aspose.email.MapiPropertyContainer

Methods inherited from class java.lang.Object

Constructor Detail

MapiCalendar

MapiCalendar

MapiCalendar

Method Detail

getReminderDelta

setReminderDelta

getReminderSet

setReminderSet

getReminderFileParameter

setReminderFileParameter

getAppointmentCounterProposal

setAppointmentCounterProposal

getClientIntent

setClientIntent

getStartDateTimeZone

setStartDateTimeZone

getEndDateTimeZone

setEndDateTimeZone

getAttendees

setAttendees

getRecurrence

setRecurrence

isAllDay

setAllDay

getKeyWords

setKeyWords

getStartDate

setStartDate

getEndDate

setEndDate

getSequence

setSequence

getBusyStatus

setBusyStatus

getLocation

setLocation

getUid

setUid

save

save

save

save

dispose