|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.email.Appointment
public class Appointment
Represents a calendar to an e-mail.
This example demonstrates how to add a calendar to an E-Mail message.
[Java]
MailMessage msg = new MailMessage(); //attendees for the event MailAddressCollection attendees = new MailAddressCollection(); attendees.add(new MailAddress("person1@domain.com")); attendees.add(new MailAddress("person2@domain.com")); attendees.add(new MailAddress("person3@domain.com")); //create appointment Appointment app = new Appointment("Room 112", new Date(2006,7,17,13,0,0), new Date(2006,7,17,14,0,0), new MailAddress("somebody@domain.com"), attendees ); app.setSummary("Release Meetting"); app.setDescription("Discuss for the next release"); //add calendar to the message msg.addAlternateView(app.requestApointment());
Constructor Summary | |
---|---|
Appointment(String location,
Date startDate,
Date endDate,
MailAddress organizer,
MailAddressCollection attendees)
|
|
Appointment(String location,
String summary,
String description,
Date startDate,
Date endDate,
MailAddress organizer,
MailAddressCollection attendees)
|
|
Appointment(String location,
String summary,
String description,
Date startDate,
Date endDate,
MailAddress organizer,
MailAddressCollection attendees,
CalendarRecurrencePattern recurrencePattern)
|
|
Appointment(String location,
String summary,
String description,
Date startDate,
Date endDate,
MailAddress organizer,
MailAddressCollection attendees,
String uid)
|
|
Appointment(String location,
String summary,
String description,
Date startDate,
Date endDate,
MailAddress organizer,
MailAddressCollection attendees,
String uid,
CalendarRecurrencePattern recurrencePattern)
|
Method Summary | |
---|---|
AlternateView |
cancelAppointment()
Cancels the appointment. |
AlternateView |
cancelAppointment(int sequenceId)
Cancels the appointment. |
String |
getAppointmentHtml()
|
String |
getAppointmentText()
Gets the calendar text. |
String |
getAppointmentText(AppointmentFormattingOptions formattingOptions)
Gets the calendar text. |
MailAddressCollection |
getAttendees()
Gets or sets the attendees. |
String |
getDescription()
Gets or sets the description. |
Date |
getEndDate()
|
String |
getEndTimeZone()
End time zone |
int |
getFlags()
Gets or sets appointment flags. |
String |
getLocation()
Gets or sets the location. |
MailAddressCollection |
getOptionalAttendees()
Gets the optional attendees. |
MailAddress |
getOrganizer()
Gets or sets the organizer. |
CalendarRecurrencePattern |
getRecurrencePattern()
Gets or sets the recurrence pattern. |
String |
getSequenceId()
Gets the sequence id. |
Date |
getStartDate()
|
String |
getStartTimeZone()
Start time zone |
String |
getSummary()
Gets or sets the summary. |
String |
getUniqueId()
Gets or sets the unique id. |
static Appointment |
load(InputStream stream)
|
static Appointment |
load(InputStream stream,
boolean applyLocalTZ)
|
static Appointment |
load(String filePath)
Loads Appointment from the file. |
AlternateView |
requestApointment()
Requests the apointment. |
AlternateView |
requestApointment(int sequenceId)
Requests the apointment. |
void |
resetTimeZone()
Set local time zone |
void |
save(OutputStream stream)
|
void |
save(OutputStream stream,
AppointmentSaveOptions saveOptions)
|
void |
save(OutputStream stream,
int saveFormat)
|
void |
save(String filePath)
Saves appointment to the file with iCalendar format using te default save options |
void |
save(String filePath,
AppointmentSaveOptions saveOptions)
Saves appointment to the file with specified save options |
void |
save(String filePath,
int saveFormat)
Saves appointment to the file with specified format using te default save options |
void |
setAttendees(MailAddressCollection value)
|
void |
setDescription(String value)
|
void |
setEndDate(Date value)
|
void |
setEndTimeZone(String value)
|
void |
setFlags(int value)
|
void |
setLocation(String value)
|
void |
setOrganizer(MailAddress value)
|
void |
setRecurrencePattern(CalendarRecurrencePattern value)
|
void |
setStartDate(Date value)
|
void |
setStartTimeZone(String value)
|
void |
setSummary(String value)
|
void |
setTimeZone(String tzName)
Set time zone |
void |
setUniqueId(String value)
|
AlternateView |
updateAppointment()
Updates the appointment. |
AlternateView |
updateAppointment(int sequenceId)
Updates the appointment. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Appointment(String location, Date startDate, Date endDate, MailAddress organizer, MailAddressCollection attendees)
public Appointment(String location, String summary, String description, Date startDate, Date endDate, MailAddress organizer, MailAddressCollection attendees)
public Appointment(String location, String summary, String description, Date startDate, Date endDate, MailAddress organizer, MailAddressCollection attendees, String uid)
public Appointment(String location, String summary, String description, Date startDate, Date endDate, MailAddress organizer, MailAddressCollection attendees, CalendarRecurrencePattern recurrencePattern)
public Appointment(String location, String summary, String description, Date startDate, Date endDate, MailAddress organizer, MailAddressCollection attendees, String uid, CalendarRecurrencePattern recurrencePattern)
Method Detail |
---|
public String getLocation()
Gets or sets the location.
public void setLocation(String value)
public String getSummary()
Gets or sets the summary.
public void setSummary(String value)
public String getDescription()
Gets or sets the description.
public void setDescription(String value)
public Date getStartDate()
public void setStartDate(Date value)
public Date getEndDate()
public void setEndDate(Date value)
public MailAddressCollection getAttendees()
Gets or sets the attendees.
public void setAttendees(MailAddressCollection value)
public MailAddressCollection getOptionalAttendees()
Gets the optional attendees.
Value: The address collection of optional attendees.
public MailAddress getOrganizer()
Gets or sets the organizer.
public void setOrganizer(MailAddress value)
public CalendarRecurrencePattern getRecurrencePattern()
Gets or sets the recurrence pattern.
Value: The recurrence pattern.
public void setRecurrencePattern(CalendarRecurrencePattern value)
public String getUniqueId()
Gets or sets the unique id.
Value: The unique id.
public void setUniqueId(String value)
public String getSequenceId()
Gets the sequence id.
Value: The sequence id.
public int getFlags()
Gets or sets appointment flags.
public void setFlags(int value)
public String getStartTimeZone()
Start time zone
public void setStartTimeZone(String value)
public String getEndTimeZone()
End time zone
public void setEndTimeZone(String value)
public void resetTimeZone()
Set local time zone
public void setTimeZone(String tzName)
Set time zone
tzName
- The time zone name, for sample "America/New_York"public AlternateView requestApointment()
Requests the apointment.
public AlternateView requestApointment(int sequenceId)
Requests the apointment.
sequenceId
- The sequence id.
public AlternateView cancelAppointment()
Cancels the appointment.
public AlternateView cancelAppointment(int sequenceId)
Cancels the appointment.
sequenceId
- The sequence id.
public AlternateView updateAppointment()
Updates the appointment.
public AlternateView updateAppointment(int sequenceId)
Updates the appointment.
sequenceId
- The sequence id.
public String getAppointmentHtml()
public String getAppointmentText()
Gets the calendar text.
public String getAppointmentText(AppointmentFormattingOptions formattingOptions)
Gets the calendar text.
formattingOptions
- AppointmentFormattingOptions
that represents appointment formatting options.
com.aspose.email.ms.System.IllegalArgumentException
- throws when formattingOptions
is null
.public void save(String filePath)
Saves appointment to the file with iCalendar format using te default save options
filePath
- A file path
com.aspose.email.ms.System.IllegalArgumentException
- filePath
is null
or empty
public void save(String filePath, int saveFormat)
Saves appointment to the file with specified format using te default save options
filePath
- A file pathsaveFormat
- A save format
com.aspose.email.ms.System.IllegalArgumentException
- filePath
is null
or empty
UnsupportedOperationException
- The specified save options are not supportedpublic void save(String filePath, AppointmentSaveOptions saveOptions)
Saves appointment to the file with specified save options
filePath
- A file pathsaveOptions
- A save options
com.aspose.email.ms.System.IllegalArgumentException
- filePath
is null
or empty
com.aspose.email.ms.System.IllegalArgumentException
- saveOptions
is null
UnsupportedOperationException
- The specified save options are not supportedpublic void save(OutputStream stream)
public void save(OutputStream stream, int saveFormat)
public void save(OutputStream stream, AppointmentSaveOptions saveOptions)
public static Appointment load(String filePath)
Loads Appointment
from the file.
Supported file formats: iCalendar
filePath
- A file path
Appointment
com.aspose.email.ms.System.IllegalArgumentException
- filePath
is null
or empty
public static Appointment load(InputStream stream)
public static Appointment load(InputStream stream, boolean applyLocalTZ)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |