Represents a calendar to an e-mail. More...

Inherits Object.

Public Member Functions

System::SharedPtr< System::Collections::Generic::Dictionary< System::SharedPtr< Aspose::Email::Mapi::PropertyDescriptor >, System::SharedPtr< System::Object > > > get_ExtendedProperties () const
 Gets extended properties of an item. More...
 
System::String get_Location ()
 Gets the location. More...
 
void set_Location (System::String value)
 Sets the location. More...
 
AppointmentClass get_Class () const
 Specifies the access classification for the appointment. More...
 
void set_Class (AppointmentClass value)
 Specifies the access classification for the appointment. More...
 
MSImportance get_MicrosoftImportance () const
 Specifies the importance of an appointment. More...
 
void set_MicrosoftImportance (MSImportance value)
 Specifies the importance of an appointment. More...
 
MSBusyStatus get_MicrosoftBusyStatus () const
 Specifies the BUSY status of an appointment. More...
 
void set_MicrosoftBusyStatus (MSBusyStatus value)
 Specifies the BUSY status of an appointment. More...
 
MSIntendedStatus get_MicrosoftIntendedStatus () const
 Specifies the INTENDED status of an appointment. More...
 
void set_MicrosoftIntendedStatus (MSIntendedStatus value)
 Specifies the INTENDED status of an appointment. More...
 
AppointmentTransparency get_Transparency () const
 Specifies whether or not this appointment is intended to be visible in availability searches. More...
 
void set_Transparency (AppointmentTransparency value)
 Specifies whether or not this appointment is intended to be visible in availability searches. More...
 
AppointmentStatus get_Status () const
 Gets the overall status or confirmation for the object. More...
 
void set_Status (AppointmentStatus value)
 Sets the overall status or confirmation for the object. More...
 
System::String get_Summary ()
 Gets the summary. More...
 
void set_Summary (System::String value)
 Sets the summary. More...
 
System::String get_Description ()
 Gets the description. More...
 
void set_Description (System::String value)
 Sets the description. More...
 
System::String get_HtmlDescription () const
 Gets html representation of description. More...
 
void set_HtmlDescription (System::String value)
 Sets html representation of description. More...
 
bool get_IsDescriptionHtml () const
 Gets value which indicates if description is in HTML format More...
 
void set_IsDescriptionHtml (bool value)
 Sets value which indicates if description is in HTML format More...
 
System::DateTime get_StartDate () const
 Gets the start date. More...
 
void set_StartDate (System::DateTime value)
 Sets the start date. More...
 
System::DateTime get_EndDate () const
 Gets the end date. More...
 
void set_EndDate (System::DateTime value)
 Sets the end date. More...
 
System::DateTime get_CreatedDate () const
 Gets the date and time that calendar information was created. More...
 
void set_CreatedDate (System::DateTime value)
 Sets the date and time that calendar information was created. More...
 
System::DateTime get_LastModifiedDate () const
 Gets the date and time that calendar information was last revised. More...
 
void set_LastModifiedDate (System::DateTime value)
 Sets the date and time that calendar information was last revised. More...
 
System::SharedPtr< MailAddressCollectionget_Attendees () const
 Gets the attendees. More...
 
void set_Attendees (System::SharedPtr< MailAddressCollection > value)
 Sets the attendees. More...
 
System::SharedPtr< MailAddressCollectionget_OptionalAttendees () const
 Gets the optional attendees. More...
 
System::SharedPtr< MailAddressget_Organizer () const
 Gets the organizer. More...
 
void set_Organizer (System::SharedPtr< MailAddress > value)
 Sets the organizer. More...
 
System::SharedPtr< Recurrences::RecurrencePatternget_Recurrence () const
 Gets the recurrence pattern. More...
 
void set_Recurrence (System::SharedPtr< Recurrences::RecurrencePattern > value)
 Sets the recurrence pattern. More...
 
System::String get_SequenceId () const
 Gets the sequence id. More...
 
void set_SequenceId (System::String value)
 Gets the sequence id. More...
 
AppointmentFlags get_Flags () const
 Gets appointment flags. More...
 
void set_Flags (AppointmentFlags value)
 Sets appointment flags. More...
 
AppointmentMethodType get_MethodType () const
 Gets the iCalendar object method type associated with the calendar object. More...
 
void set_MethodType (AppointmentMethodType value)
 Sets the iCalendar object method type associated with the calendar object. More...
 
System::SharedPtr< AppointmentReminderCollectionget_Reminders () const
 Contains collection of AppointmentReminder AppointmentReminder objects. More...
 
System::SharedPtr< AttachmentCollectionget_Attachments () const
 Gets the collection of attachments of appointment. More...
 
System::String get_StartTimeZone () const
 Start time zone More...
 
void set_StartTimeZone (System::String value)
 Start time zone More...
 
System::String get_EndTimeZone () const
 End time zone More...
 
void set_EndTimeZone (System::String value)
 End time zone More...
 
System::SharedPtr< Aspose::Email::Common::TimeZone::Zone > get_StartTimeZoneInfo ()
 Start time zone More...
 
void set_StartTimeZoneInfo (System::SharedPtr< Aspose::Email::Common::TimeZone::Zone > value)
 Start time zone More...
 
System::SharedPtr< Aspose::Email::Common::TimeZone::Zone > get_EndTimeZoneInfo ()
 End time zone More...
 
void set_EndTimeZoneInfo (System::SharedPtr< Aspose::Email::Common::TimeZone::Zone > value)
 End time zone More...
 
AppointmentAction get_Action () const
 Gets appointment action More...
 
void set_Action (AppointmentAction value)
 Sets appointment action More...
 
System::String get_UniqueId ()
 Gets a string value that contains the GUID for the calendar item. In MS Exchange this is PidLidGlobalObjectId mapi property. More...
 
void set_UniqueId (System::String value)
 Sets a string value that contains the GUID for the calendar item. In MS Exchange this is PidLidGlobalObjectId mapi property. More...
 
System::SharedPtr< ObjectIdentifierget_Id () const
 Object identifier More...
 
 Appointment (System::String location, System::DateTime startDate, System::DateTime endDate, System::SharedPtr< MailAddress > organizer, System::SharedPtr< MailAddressCollection > attendees)
 Initialize a new instance of the Appointment class. More...
 
 Appointment (System::String location, System::String summary, System::String description, System::DateTime startDate, System::DateTime endDate, System::SharedPtr< MailAddress > organizer, System::SharedPtr< MailAddressCollection > attendees)
 Initialize a new instance of the Appointment class. More...
 
 Appointment (System::String location, System::String summary, System::String description, System::DateTime startDate, System::DateTime endDate, System::SharedPtr< MailAddress > organizer, System::SharedPtr< MailAddressCollection > attendees, System::String uid)
 Initialize a new instance of the Appointment class. More...
 
 Appointment (System::SharedPtr< Model::Property::LocationProperty > location, System::SharedPtr< Model::Property::SummaryProperty > summary, System::SharedPtr< Model::Property::DescriptionProperty > description, System::DateTime startDate, System::DateTime endDate, System::SharedPtr< MailAddress > organizer, System::SharedPtr< MailAddressCollection > attendees, System::String uid)
 Initialize a new instance of the Appointment class. More...
 
 Appointment (System::String location, System::String summary, System::String description, System::DateTime startDate, System::DateTime endDate, System::SharedPtr< MailAddress > organizer, System::SharedPtr< MailAddressCollection > attendees, System::SharedPtr< Recurrences::RecurrencePattern > recurrencePattern)
 Initialize a new instance of the Appointment class. More...
 
 Appointment (System::String location, System::String summary, System::String description, System::DateTime startDate, System::DateTime endDate, System::SharedPtr< MailAddress > organizer, System::SharedPtr< MailAddressCollection > attendees, System::String uid, System::SharedPtr< Recurrences::RecurrencePattern > recurrencePattern)
 Initialize a new instance of the Appointment class. More...
 
 Appointment (System::SharedPtr< Model::Property::LocationProperty > location, System::SharedPtr< Model::Property::SummaryProperty > summary, System::SharedPtr< Model::Property::DescriptionProperty > description, System::DateTime startDate, System::DateTime endDate, System::SharedPtr< MailAddress > organizer, System::SharedPtr< MailAddressCollection > attendees, System::String uid, System::SharedPtr< Recurrences::RecurrencePattern > recurrencePattern)
 Initialize a new instance of the Appointment class. More...
 
 Appointment ()
 
void ResetTimeZone ()
 Set local time zone More...
 
void SetTimeZone (System::String tzName)
 Set time zone More...
 
System::SharedPtr< AlternateViewRequestApointment ()
 Requests the apointment. More...
 
System::SharedPtr< AlternateViewRequestApointment (int32_t seqId)
 Requests the apointment. More...
 
System::SharedPtr< AlternateViewCancelAppointment ()
 Cancels the appointment. More...
 
System::SharedPtr< AlternateViewCancelAppointment (int32_t seqId)
 Cancels the appointment. More...
 
System::SharedPtr< AlternateViewUpdateAppointment ()
 Updates the appointment. More...
 
System::SharedPtr< AlternateViewUpdateAppointment (int32_t seqId)
 Updates the appointment. More...
 
System::String GetAppointmentHtml ()
 Gets the calendar HTML. More...
 
System::String GetAppointmentText ()
 Gets the calendar text. More...
 
System::String GetAppointmentText (System::SharedPtr< AppointmentFormattingOptions > formattingOptions)
 Gets the calendar text. More...
 
void Save (System::String filePath)
 Saves appointment to the file with iCalendar format using te default save options More...
 
void Save (System::String filePath, AppointmentSaveFormat saveFormat)
 Saves appointment to the file with specified format using te default save options More...
 
void Save (System::String filePath, System::SharedPtr< AppointmentSaveOptions > saveOptions)
 Saves appointment to the file with specified save options More...
 
void Save (System::SharedPtr< System::IO::Stream > stream)
 Saves appointment to the file with iCalendar format using te default save options More...
 
void Save (System::SharedPtr< System::IO::Stream > stream, AppointmentSaveFormat saveFormat)
 Saves appointment to the stream with specified format using te default save options More...
 
void Save (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< AppointmentSaveOptions > saveOptions)
 Saves appointment to the stream with specified save options More...
 

Static Public Member Functions

static System::SharedPtr< AppointmentLoad (System::String filePath)
 Loads Appointment from the file. Supported file formats: iCalendar More...
 
static System::SharedPtr< AppointmentLoad (System::String filePath, System::SharedPtr< AppointmentLoadOptions > options)
 Loads Appointment from the file. Supported file formats: iCalendar
Parameters
filePathA file path.
optionsRepresents appointment load optionsAppointmentLoadOptions.
Returns
A read Appointment.
More...
 
static System::SharedPtr< AppointmentLoad (System::SharedPtr< System::IO::Stream > stream)
 Loads Appointment from the stream More...
 
static System::SharedPtr< AppointmentLoad (System::SharedPtr< System::IO::Stream > stream, bool applyLocalTimeZone)
 Loads Appointment from the stream More...
 
static System::SharedPtr< AppointmentLoad (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< AppointmentLoadOptions > options)
 Loads Appointment from the stream More...
 
static System::String GetMediaTypeValue (System::String method, System::String charset)
 

Public Attributes

System::SharedPtr< System::Collections::Generic::ListExt< System::String > > categories
 
System::SharedPtr< System::Collections::Generic::ListExt< System::DateTime > > exDates
 
System::DateTime dateTimeStamp
 
System::SharedPtr< MailAddressCollectionoptionalAttendees
 
System::String sequenceId
 
int32_t sequence
 
bool isLoaded
 
System::SharedPtr< System::Collections::Generic::Dictionary< System::SharedPtr< Aspose::Email::Mapi::PropertyDescriptor >, System::SharedPtr< System::Object > > > extendedProperties
 
System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Model::Component::EventComponent > > > recurrenceSpecialCases
 

Protected Member Functions

virtual ~Appointment ()
 

Friends

class Aspose::Email::AlternateView
 
class Aspose::Email::Calendar::CalendarWriter
 
class Aspose::Email::Clients::Exchange::WebService::CalendarEwsConverter
 
class Aspose::Email::Tools::CalendarConverter
 
class Aspose::Email::Clients::Exchange::WebService::EWSClient2007
 
class Aspose::Email::Clients::Exchange::WebService::Implementation::Appointments::Create::EwsClientAppointmentCreate
 
class Aspose::Email::Clients::Exchange::WebService::Implementation::Appointments::Send::EwsClientAppointmentSend
 
class Aspose::Email::Clients::Exchange::WebService::Models::EwsArchiveItems
 
class Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentReader
 
class Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentWriter
 
class Aspose::Email::Storage::Zimbra::ZimbraCalendar
 

Detailed Description

Represents a calendar to an e-mail.

This example demonstrates how to add a calendar to an E-Mail message.

[C#]

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 DateTime(2006,7,17,13,0,0),new DateTime(2006,7,17,14,0,0),new MailAddress("somebody@domain.com"), attendees );
cal.Summary = "Release Meetting";
cal.Description = "Discuss for the next release";
//add calendar to the message
msg.AddAlternateView(app.RequestApointment());
//send the email message
SmtpClient smtp= new SmtpClient("smtp.server.com", 25, "user", "password");
smtp.Send(msg);

[Visual Basic]

Dim msg As MailMessage = New MailMessage()
'attendees for the event
Dim attendees As MailAddressCollection = New MailAddressCollection()
attendees.Add(New MailAddress("person1@domain.com"))
attendees.Add(New MailAddress("person2@domain.com"))
attendees.Add(New MailAddress("person3@domain.com"))
'create calendar
Dim cal As Appointment = New Appointment("Room 112",New DateTime(2006,7,17,13,0,0),New DateTime(2006,7,17,14,0,0),New MailAddress("somebody@domain.com"),attendees)
cal.Summary = "Release Meetting"
cal.Description = "Discuss for the next release"
'add calendar to the message
msg.AddAlternateView(app.RequestApointment())

Constructor & Destructor Documentation

◆ Appointment() [1/8]

Aspose::Email::Calendar::Appointment::Appointment ( System::String  location,
System::DateTime  startDate,
System::DateTime  endDate,
System::SharedPtr< MailAddress organizer,
System::SharedPtr< MailAddressCollection attendees 
)

Initialize a new instance of the Appointment class.

Parameters
locationThe location of the calendar event.
startDateThe start time of the calendar event.
endDateThe end time of the calendar event.
organizerThe organizer of the calendar event.
attendeesThe attendees of th calendar event.

◆ Appointment() [2/8]

Aspose::Email::Calendar::Appointment::Appointment ( System::String  location,
System::String  summary,
System::String  description,
System::DateTime  startDate,
System::DateTime  endDate,
System::SharedPtr< MailAddress organizer,
System::SharedPtr< MailAddressCollection attendees 
)

Initialize a new instance of the Appointment class.

Parameters
locationThe location of the calendar event.
summaryThe summary of the calendar event.
descriptionThe description of the calendar event.
startDateThe start time of the calendar event.
endDateThe end time of the calendar event.
organizerThe organizer of the calendar event.
attendeesThe attendees of th calendar event.

◆ Appointment() [3/8]

Aspose::Email::Calendar::Appointment::Appointment ( System::String  location,
System::String  summary,
System::String  description,
System::DateTime  startDate,
System::DateTime  endDate,
System::SharedPtr< MailAddress organizer,
System::SharedPtr< MailAddressCollection attendees,
System::String  uid 
)

Initialize a new instance of the Appointment class.

Parameters
locationThe location of the calendar event.
summaryThe summary of the calendar event.
descriptionThe description of the calendar event.
startDateThe start time of the calendar event.
endDateThe end time of the calendar event.
organizerThe organizer of the calendar event.
attendeesThe attendees of th calendar event.
uidThe unique identifier of th calendar event.

◆ Appointment() [4/8]

Aspose::Email::Calendar::Appointment::Appointment ( System::SharedPtr< Model::Property::LocationProperty >  location,
System::SharedPtr< Model::Property::SummaryProperty >  summary,
System::SharedPtr< Model::Property::DescriptionProperty >  description,
System::DateTime  startDate,
System::DateTime  endDate,
System::SharedPtr< MailAddress organizer,
System::SharedPtr< MailAddressCollection attendees,
System::String  uid 
)

Initialize a new instance of the Appointment class.

Parameters
locationThe location of the calendar event.
summaryThe summary of the calendar event.
descriptionThe description of the calendar event.
startDateThe start time of the calendar event.
endDateThe end time of the calendar event.
organizerThe organizer of the calendar event.
attendeesThe attendees of th calendar event.
uidThe unique identifier of th calendar event.

◆ Appointment() [5/8]

Aspose::Email::Calendar::Appointment::Appointment ( System::String  location,
System::String  summary,
System::String  description,
System::DateTime  startDate,
System::DateTime  endDate,
System::SharedPtr< MailAddress organizer,
System::SharedPtr< MailAddressCollection attendees,
System::SharedPtr< Recurrences::RecurrencePattern recurrencePattern 
)

Initialize a new instance of the Appointment class.

Parameters
locationThe location of the calendar event.
summaryThe summary of the calendar event.
descriptionThe description of the calendar event.
startDateThe start time of the calendar event.
endDateThe end time of the calendar event.
organizerThe organizer of the calendar event.
attendeesThe attendees of th calendar event.
recurrencePatternThe recurrence pattern.

◆ Appointment() [6/8]

Aspose::Email::Calendar::Appointment::Appointment ( System::String  location,
System::String  summary,
System::String  description,
System::DateTime  startDate,
System::DateTime  endDate,
System::SharedPtr< MailAddress organizer,
System::SharedPtr< MailAddressCollection attendees,
System::String  uid,
System::SharedPtr< Recurrences::RecurrencePattern recurrencePattern 
)

Initialize a new instance of the Appointment class.

Parameters
locationThe location of the calendar event.
summaryThe summary of the calendar event.
descriptionThe description of the calendar event.
startDateThe start time of the calendar event.
endDateThe end time of the calendar event.
organizerThe organizer of the calendar event.
attendeesThe attendees of th calendar event.
uidThe unique identifier of th calendar event.
recurrencePatternThe recurrence pattern.

◆ Appointment() [7/8]

Aspose::Email::Calendar::Appointment::Appointment ( System::SharedPtr< Model::Property::LocationProperty >  location,
System::SharedPtr< Model::Property::SummaryProperty >  summary,
System::SharedPtr< Model::Property::DescriptionProperty >  description,
System::DateTime  startDate,
System::DateTime  endDate,
System::SharedPtr< MailAddress organizer,
System::SharedPtr< MailAddressCollection attendees,
System::String  uid,
System::SharedPtr< Recurrences::RecurrencePattern recurrencePattern 
)

Initialize a new instance of the Appointment class.

Parameters
locationThe location of the calendar event.
summaryThe summary of the calendar event.
descriptionThe description of the calendar event.
startDateThe start time of the calendar event.
endDateThe end time of the calendar event.
organizerThe organizer of the calendar event.
attendeesThe attendees of th calendar event.
uidThe unique identifier of th calendar event.
recurrencePatternThe recurrence pattern.

◆ Appointment() [8/8]

Aspose::Email::Calendar::Appointment::Appointment ( )

◆ ~Appointment()

virtual Aspose::Email::Calendar::Appointment::~Appointment ( )
protectedvirtual

Member Function Documentation

◆ CancelAppointment() [1/2]

System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::CancelAppointment ( )

Cancels the appointment.

Returns
AlternateViewAlternateView that represents the format to view an email message.

◆ CancelAppointment() [2/2]

System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::CancelAppointment ( int32_t  seqId)

Cancels the appointment.

Parameters
seqIdThe sequence id.
Returns
AlternateViewAlternateView that represents the format to view an email message.

◆ get_Action()

AppointmentAction Aspose::Email::Calendar::Appointment::get_Action ( ) const

Gets appointment action

◆ get_Attachments()

System::SharedPtr<AttachmentCollection> Aspose::Email::Calendar::Appointment::get_Attachments ( ) const

Gets the collection of attachments of appointment.

◆ get_Attendees()

System::SharedPtr<MailAddressCollection> Aspose::Email::Calendar::Appointment::get_Attendees ( ) const

Gets the attendees.

◆ get_Class()

AppointmentClass Aspose::Email::Calendar::Appointment::get_Class ( ) const

Specifies the access classification for the appointment.

◆ get_CreatedDate()

System::DateTime Aspose::Email::Calendar::Appointment::get_CreatedDate ( ) const

Gets the date and time that calendar information was created.

The System::DateTime that represents creation date and time.

◆ get_Description()

System::String Aspose::Email::Calendar::Appointment::get_Description ( )

Gets the description.

◆ get_EndDate()

System::DateTime Aspose::Email::Calendar::Appointment::get_EndDate ( ) const

Gets the end date.

◆ get_EndTimeZone()

System::String Aspose::Email::Calendar::Appointment::get_EndTimeZone ( ) const

End time zone

◆ get_EndTimeZoneInfo()

System::SharedPtr<Aspose::Email::Common::TimeZone::Zone> Aspose::Email::Calendar::Appointment::get_EndTimeZoneInfo ( )

End time zone

◆ get_ExtendedProperties()

System::SharedPtr<System::Collections::Generic::Dictionary<System::SharedPtr<Aspose::Email::Mapi::PropertyDescriptor>, System::SharedPtr<System::Object> > > Aspose::Email::Calendar::Appointment::get_ExtendedProperties ( ) const

Gets extended properties of an item.

◆ get_Flags()

AppointmentFlags Aspose::Email::Calendar::Appointment::get_Flags ( ) const

Gets appointment flags.

◆ get_HtmlDescription()

System::String Aspose::Email::Calendar::Appointment::get_HtmlDescription ( ) const

Gets html representation of description.

◆ get_Id()

System::SharedPtr<ObjectIdentifier> Aspose::Email::Calendar::Appointment::get_Id ( ) const

Object identifier

◆ get_IsDescriptionHtml()

bool Aspose::Email::Calendar::Appointment::get_IsDescriptionHtml ( ) const

Gets value which indicates if description is in HTML format

Deprecated:
Since HtmlDescription appeared in Appointment this flag has no sense.

◆ get_LastModifiedDate()

System::DateTime Aspose::Email::Calendar::Appointment::get_LastModifiedDate ( ) const

Gets the date and time that calendar information was last revised.

The System::DateTime that represents modification date and time.

◆ get_Location()

System::String Aspose::Email::Calendar::Appointment::get_Location ( )

Gets the location.

◆ get_MethodType()

AppointmentMethodType Aspose::Email::Calendar::Appointment::get_MethodType ( ) const

Gets the iCalendar object method type associated with the calendar object.

◆ get_MicrosoftBusyStatus()

MSBusyStatus Aspose::Email::Calendar::Appointment::get_MicrosoftBusyStatus ( ) const

Specifies the BUSY status of an appointment.

◆ get_MicrosoftImportance()

MSImportance Aspose::Email::Calendar::Appointment::get_MicrosoftImportance ( ) const

Specifies the importance of an appointment.

◆ get_MicrosoftIntendedStatus()

MSIntendedStatus Aspose::Email::Calendar::Appointment::get_MicrosoftIntendedStatus ( ) const

Specifies the INTENDED status of an appointment.

◆ get_OptionalAttendees()

System::SharedPtr<MailAddressCollection> Aspose::Email::Calendar::Appointment::get_OptionalAttendees ( ) const

Gets the optional attendees.

The address collection of optional attendees.

◆ get_Organizer()

System::SharedPtr<MailAddress> Aspose::Email::Calendar::Appointment::get_Organizer ( ) const

Gets the organizer.

◆ get_Recurrence()

System::SharedPtr<Recurrences::RecurrencePattern> Aspose::Email::Calendar::Appointment::get_Recurrence ( ) const

Gets the recurrence pattern.

The recurrence pattern.

◆ get_Reminders()

System::SharedPtr<AppointmentReminderCollection> Aspose::Email::Calendar::Appointment::get_Reminders ( ) const

Contains collection of AppointmentReminder AppointmentReminder objects.

◆ get_SequenceId()

System::String Aspose::Email::Calendar::Appointment::get_SequenceId ( ) const

Gets the sequence id.

The sequence id.

◆ get_StartDate()

System::DateTime Aspose::Email::Calendar::Appointment::get_StartDate ( ) const

Gets the start date.

◆ get_StartTimeZone()

System::String Aspose::Email::Calendar::Appointment::get_StartTimeZone ( ) const

Start time zone

◆ get_StartTimeZoneInfo()

System::SharedPtr<Aspose::Email::Common::TimeZone::Zone> Aspose::Email::Calendar::Appointment::get_StartTimeZoneInfo ( )

Start time zone

◆ get_Status()

AppointmentStatus Aspose::Email::Calendar::Appointment::get_Status ( ) const

Gets the overall status or confirmation for the object.

◆ get_Summary()

System::String Aspose::Email::Calendar::Appointment::get_Summary ( )

Gets the summary.

◆ get_Transparency()

AppointmentTransparency Aspose::Email::Calendar::Appointment::get_Transparency ( ) const

Specifies whether or not this appointment is intended to be visible in availability searches.

◆ get_UniqueId()

System::String Aspose::Email::Calendar::Appointment::get_UniqueId ( )

Gets a string value that contains the GUID for the calendar item. In MS Exchange this is PidLidGlobalObjectId mapi property.

The unique id.

◆ GetAppointmentHtml()

System::String Aspose::Email::Calendar::Appointment::GetAppointmentHtml ( )

Gets the calendar HTML.

Returns
String value of calendar as HTML.

◆ GetAppointmentText() [1/2]

System::String Aspose::Email::Calendar::Appointment::GetAppointmentText ( )

Gets the calendar text.

Returns
String value of calendar as plain text.

◆ GetAppointmentText() [2/2]

System::String Aspose::Email::Calendar::Appointment::GetAppointmentText ( System::SharedPtr< AppointmentFormattingOptions formattingOptions)

Gets the calendar text.

Parameters
formattingOptionsAppointmentFormattingOptions that represents appointment formatting options.
Returns
The text representation of appointment.
Exceptions
ArgumentNullExceptionthrows when formattingOptions is null.

◆ GetMediaTypeValue()

static System::String Aspose::Email::Calendar::Appointment::GetMediaTypeValue ( System::String  method,
System::String  charset 
)
static

◆ Load() [1/5]

static System::SharedPtr<Appointment> Aspose::Email::Calendar::Appointment::Load ( System::SharedPtr< System::IO::Stream >  stream)
static

Loads Appointment from the stream

Parameters
streamA stream to load from
Returns
A read Appointment
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support reading

◆ Load() [2/5]

static System::SharedPtr<Appointment> Aspose::Email::Calendar::Appointment::Load ( System::SharedPtr< System::IO::Stream >  stream,
bool  applyLocalTimeZone 
)
static

Loads Appointment from the stream

Parameters
streamA stream to load from
applyLocalTimeZoneConvert time to local timezone
Returns
A read Appointment
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support reading

◆ Load() [3/5]

static System::SharedPtr<Appointment> Aspose::Email::Calendar::Appointment::Load ( System::SharedPtr< System::IO::Stream >  stream,
System::SharedPtr< AppointmentLoadOptions options 
)
static

Loads Appointment from the stream

Parameters
streamA stream to load from
optionsRepresents appointment load options
Returns
A read Appointment
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support reading

◆ Load() [4/5]

static System::SharedPtr<Appointment> Aspose::Email::Calendar::Appointment::Load ( System::String  filePath)
static

Loads Appointment from the file. Supported file formats: iCalendar

Parameters
filePathA file path
Returns
A read Appointment
Exceptions
ArgumentExceptionfilePath is null or empty

◆ Load() [5/5]

static System::SharedPtr<Appointment> Aspose::Email::Calendar::Appointment::Load ( System::String  filePath,
System::SharedPtr< AppointmentLoadOptions options 
)
static

Loads Appointment from the file. Supported file formats: iCalendar

Parameters
filePathA file path.
optionsRepresents appointment load optionsAppointmentLoadOptions.
Returns
A read Appointment.

◆ RequestApointment() [1/2]

System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::RequestApointment ( )

Requests the apointment.

Returns
AlternateViewAlternateView that represents the format to view an email message.

◆ RequestApointment() [2/2]

System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::RequestApointment ( int32_t  seqId)

Requests the apointment.

Parameters
seqIdThe sequence id.
Returns
AlternateViewAlternateView that represents the format to view an email message.

◆ ResetTimeZone()

void Aspose::Email::Calendar::Appointment::ResetTimeZone ( )

Set local time zone

◆ Save() [1/6]

void Aspose::Email::Calendar::Appointment::Save ( System::SharedPtr< System::IO::Stream >  stream)

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

Parameters
streamA stream to save to
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support writing

◆ Save() [2/6]

void Aspose::Email::Calendar::Appointment::Save ( System::SharedPtr< System::IO::Stream >  stream,
AppointmentSaveFormat  saveFormat 
)

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

Parameters
streamA stream to save to
saveFormatA save format
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionThe specified save options are not supported
NotSupportedExceptionstream does not support writing

◆ Save() [3/6]

void Aspose::Email::Calendar::Appointment::Save ( System::SharedPtr< System::IO::Stream >  stream,
System::SharedPtr< AppointmentSaveOptions saveOptions 
)

Saves appointment to the stream with specified save options

Parameters
streamA stream to save to
saveOptionsA save options
Exceptions
ArgumentNullExceptionsaveOptions or stream is null
NotSupportedExceptionthe specified save options are not supported
NotSupportedExceptionstream does not support writing

◆ Save() [4/6]

void Aspose::Email::Calendar::Appointment::Save ( System::String  filePath)

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

Parameters
filePathA file path
Exceptions
ArgumentOutOfRangeExceptionfilePath is null or empty

◆ Save() [5/6]

void Aspose::Email::Calendar::Appointment::Save ( System::String  filePath,
AppointmentSaveFormat  saveFormat 
)

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

Parameters
filePathA file path
saveFormatA save format
Exceptions
ArgumentOutOfRangeExceptionfilePath is null or empty
NotSupportedExceptionThe specified save options are not supported

◆ Save() [6/6]

void Aspose::Email::Calendar::Appointment::Save ( System::String  filePath,
System::SharedPtr< AppointmentSaveOptions saveOptions 
)

Saves appointment to the file with specified save options

Parameters
filePathA file path
saveOptionsA save options
Exceptions
ArgumentOutOfRangeExceptionfilePath is null or empty
ArgumentNullExceptionsaveOptions is null
NotSupportedExceptionThe specified save options are not supported

◆ set_Action()

void Aspose::Email::Calendar::Appointment::set_Action ( AppointmentAction  value)

Sets appointment action

◆ set_Attendees()

void Aspose::Email::Calendar::Appointment::set_Attendees ( System::SharedPtr< MailAddressCollection value)

Sets the attendees.

◆ set_Class()

void Aspose::Email::Calendar::Appointment::set_Class ( AppointmentClass  value)

Specifies the access classification for the appointment.

◆ set_CreatedDate()

void Aspose::Email::Calendar::Appointment::set_CreatedDate ( System::DateTime  value)

Sets the date and time that calendar information was created.

The System::DateTime that represents creation date and time.

◆ set_Description()

void Aspose::Email::Calendar::Appointment::set_Description ( System::String  value)

Sets the description.

◆ set_EndDate()

void Aspose::Email::Calendar::Appointment::set_EndDate ( System::DateTime  value)

Sets the end date.

◆ set_EndTimeZone()

void Aspose::Email::Calendar::Appointment::set_EndTimeZone ( System::String  value)

End time zone

◆ set_EndTimeZoneInfo()

void Aspose::Email::Calendar::Appointment::set_EndTimeZoneInfo ( System::SharedPtr< Aspose::Email::Common::TimeZone::Zone >  value)

End time zone

◆ set_Flags()

void Aspose::Email::Calendar::Appointment::set_Flags ( AppointmentFlags  value)

Sets appointment flags.

◆ set_HtmlDescription()

void Aspose::Email::Calendar::Appointment::set_HtmlDescription ( System::String  value)

Sets html representation of description.

◆ set_IsDescriptionHtml()

void Aspose::Email::Calendar::Appointment::set_IsDescriptionHtml ( bool  value)

Sets value which indicates if description is in HTML format

Deprecated:
Since HtmlDescription appeared in Appointment this flag has no sense.

◆ set_LastModifiedDate()

void Aspose::Email::Calendar::Appointment::set_LastModifiedDate ( System::DateTime  value)

Sets the date and time that calendar information was last revised.

The System::DateTime that represents modification date and time.

◆ set_Location()

void Aspose::Email::Calendar::Appointment::set_Location ( System::String  value)

Sets the location.

◆ set_MethodType()

void Aspose::Email::Calendar::Appointment::set_MethodType ( AppointmentMethodType  value)

Sets the iCalendar object method type associated with the calendar object.

◆ set_MicrosoftBusyStatus()

void Aspose::Email::Calendar::Appointment::set_MicrosoftBusyStatus ( MSBusyStatus  value)

Specifies the BUSY status of an appointment.

◆ set_MicrosoftImportance()

void Aspose::Email::Calendar::Appointment::set_MicrosoftImportance ( MSImportance  value)

Specifies the importance of an appointment.

◆ set_MicrosoftIntendedStatus()

void Aspose::Email::Calendar::Appointment::set_MicrosoftIntendedStatus ( MSIntendedStatus  value)

Specifies the INTENDED status of an appointment.

◆ set_Organizer()

void Aspose::Email::Calendar::Appointment::set_Organizer ( System::SharedPtr< MailAddress value)

Sets the organizer.

◆ set_Recurrence()

void Aspose::Email::Calendar::Appointment::set_Recurrence ( System::SharedPtr< Recurrences::RecurrencePattern value)

Sets the recurrence pattern.

The recurrence pattern.

◆ set_SequenceId()

void Aspose::Email::Calendar::Appointment::set_SequenceId ( System::String  value)

Gets the sequence id.

The sequence id.

◆ set_StartDate()

void Aspose::Email::Calendar::Appointment::set_StartDate ( System::DateTime  value)

Sets the start date.

◆ set_StartTimeZone()

void Aspose::Email::Calendar::Appointment::set_StartTimeZone ( System::String  value)

Start time zone

◆ set_StartTimeZoneInfo()

void Aspose::Email::Calendar::Appointment::set_StartTimeZoneInfo ( System::SharedPtr< Aspose::Email::Common::TimeZone::Zone >  value)

Start time zone

◆ set_Status()

void Aspose::Email::Calendar::Appointment::set_Status ( AppointmentStatus  value)

Sets the overall status or confirmation for the object.

◆ set_Summary()

void Aspose::Email::Calendar::Appointment::set_Summary ( System::String  value)

Sets the summary.

◆ set_Transparency()

void Aspose::Email::Calendar::Appointment::set_Transparency ( AppointmentTransparency  value)

Specifies whether or not this appointment is intended to be visible in availability searches.

◆ set_UniqueId()

void Aspose::Email::Calendar::Appointment::set_UniqueId ( System::String  value)

Sets a string value that contains the GUID for the calendar item. In MS Exchange this is PidLidGlobalObjectId mapi property.

The unique id.

◆ SetTimeZone()

void Aspose::Email::Calendar::Appointment::SetTimeZone ( System::String  tzName)

Set time zone

Parameters
tzNameThe time zone name, for sample "America/New_York"

◆ UpdateAppointment() [1/2]

System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::UpdateAppointment ( )

Updates the appointment.

Returns
AlternateViewAlternateView that represents the format to view an email message.

◆ UpdateAppointment() [2/2]

System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::UpdateAppointment ( int32_t  seqId)

Updates the appointment.

Parameters
seqIdThe sequence id.
Returns
AlternateViewAlternateView that represents the format to view an email message.

Friends And Related Function Documentation

◆ Aspose::Email::AlternateView

friend class Aspose::Email::AlternateView
friend

◆ Aspose::Email::Calendar::CalendarWriter

◆ Aspose::Email::Clients::Exchange::WebService::CalendarEwsConverter

friend class Aspose::Email::Clients::Exchange::WebService::CalendarEwsConverter
friend

◆ Aspose::Email::Clients::Exchange::WebService::EWSClient2007

friend class Aspose::Email::Clients::Exchange::WebService::EWSClient2007
friend

◆ Aspose::Email::Clients::Exchange::WebService::Implementation::Appointments::Create::EwsClientAppointmentCreate

friend class Aspose::Email::Clients::Exchange::WebService::Implementation::Appointments::Create::EwsClientAppointmentCreate
friend

◆ Aspose::Email::Clients::Exchange::WebService::Implementation::Appointments::Send::EwsClientAppointmentSend

friend class Aspose::Email::Clients::Exchange::WebService::Implementation::Appointments::Send::EwsClientAppointmentSend
friend

◆ Aspose::Email::Clients::Exchange::WebService::Models::EwsArchiveItems

◆ Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentReader

friend class Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentReader
friend

◆ Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentWriter

friend class Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentWriter
friend

◆ Aspose::Email::Storage::Zimbra::ZimbraCalendar

friend class Aspose::Email::Storage::Zimbra::ZimbraCalendar
friend

◆ Aspose::Email::Tools::CalendarConverter

friend class Aspose::Email::Tools::CalendarConverter
friend

Member Data Documentation

◆ categories

System::SharedPtr<System::Collections::Generic::ListExt<System::String> > Aspose::Email::Calendar::Appointment::categories

◆ dateTimeStamp

System::DateTime Aspose::Email::Calendar::Appointment::dateTimeStamp

◆ exDates

System::SharedPtr<System::Collections::Generic::ListExt<System::DateTime> > Aspose::Email::Calendar::Appointment::exDates

◆ extendedProperties

System::SharedPtr<System::Collections::Generic::Dictionary<System::SharedPtr<Aspose::Email::Mapi::PropertyDescriptor>, System::SharedPtr<System::Object> > > Aspose::Email::Calendar::Appointment::extendedProperties

◆ isLoaded

bool Aspose::Email::Calendar::Appointment::isLoaded

◆ optionalAttendees

System::SharedPtr<MailAddressCollection> Aspose::Email::Calendar::Appointment::optionalAttendees

◆ recurrenceSpecialCases

System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Model::Component::EventComponent> > > Aspose::Email::Calendar::Appointment::recurrenceSpecialCases

◆ sequence

int32_t Aspose::Email::Calendar::Appointment::sequence

◆ sequenceId

System::String Aspose::Email::Calendar::Appointment::sequenceId
Appointment()