Aspose::Email::Calendar::Appointment Class Reference

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

Inherits Object.

Public Member Functions
ASPOSE_EMAIL_SHARED_API 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...
ASPOSE_EMAIL_SHARED_API System::String	get_Location ()
	Gets the location. More...
ASPOSE_EMAIL_SHARED_API void	set_Location (System::String value)
	Sets the location. More...
ASPOSE_EMAIL_SHARED_API MSBusyStatus	get_MicrosoftBusyStatus () const
	Specifies the BUSY status of an appointment. More...
ASPOSE_EMAIL_SHARED_API void	set_MicrosoftBusyStatus (MSBusyStatus value)
	Specifies the BUSY status of an appointment. More...
ASPOSE_EMAIL_SHARED_API MSIntendedStatus	get_MicrosoftIntendedStatus () const
	Specifies the INTENDED status of an appointment. More...
ASPOSE_EMAIL_SHARED_API void	set_MicrosoftIntendedStatus (MSIntendedStatus value)
	Specifies the INTENDED status of an appointment. More...
ASPOSE_EMAIL_SHARED_API AppointmentTransparency	get_Transparency () const
	Specifies whether or not this appointment is intended to be visible in availability searches. More...
ASPOSE_EMAIL_SHARED_API void	set_Transparency (AppointmentTransparency value)
	Specifies whether or not this appointment is intended to be visible in availability searches. More...
ASPOSE_EMAIL_SHARED_API AppointmentStatus	get_Status () const
	Gets the overall status or confirmation for the object. More...
ASPOSE_EMAIL_SHARED_API void	set_Status (AppointmentStatus value)
	Sets the overall status or confirmation for the object. More...
ASPOSE_EMAIL_SHARED_API System::String	get_Summary ()
	Gets the summary. More...
ASPOSE_EMAIL_SHARED_API void	set_Summary (System::String value)
	Sets the summary. More...
ASPOSE_EMAIL_SHARED_API System::String	get_Description ()
	Gets the description. More...
ASPOSE_EMAIL_SHARED_API void	set_Description (System::String value)
	Sets the description. More...
ASPOSE_EMAIL_SHARED_API bool	get_IsDescriptionHtml () const
	Gets value which indicates if description is in HTML format More...
ASPOSE_EMAIL_SHARED_API void	set_IsDescriptionHtml (bool value)
	Sets value which indicates if description is in HTML format More...
ASPOSE_EMAIL_SHARED_API System::DateTime	get_StartDate () const
	Gets the start date. More...
ASPOSE_EMAIL_SHARED_API void	set_StartDate (System::DateTime value)
	Sets the start date. More...
ASPOSE_EMAIL_SHARED_API System::DateTime	get_EndDate () const
	Gets the end date. More...
ASPOSE_EMAIL_SHARED_API void	set_EndDate (System::DateTime value)
	Sets the end date. More...
ASPOSE_EMAIL_SHARED_API System::DateTime	get_CreatedDate () const
	Gets the date and time that calendar information was created. More...
ASPOSE_EMAIL_SHARED_API void	set_CreatedDate (System::DateTime value)
	Sets the date and time that calendar information was created. More...
ASPOSE_EMAIL_SHARED_API System::DateTime	get_LastModifiedDate () const
	Gets the date and time that calendar information was last revised. More...
ASPOSE_EMAIL_SHARED_API void	set_LastModifiedDate (System::DateTime value)
	Sets the date and time that calendar information was last revised. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressCollection >	get_Attendees () const
	Gets the attendees. More...
ASPOSE_EMAIL_SHARED_API void	set_Attendees (System::SharedPtr< MailAddressCollection > value)
	Sets the attendees. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressCollection >	get_OptionalAttendees () const
	Gets the optional attendees. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	get_Organizer () const
	Gets the organizer. More...
ASPOSE_EMAIL_SHARED_API void	set_Organizer (System::SharedPtr< MailAddress > value)
	Sets the organizer. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< Recurrences::RecurrencePattern >	get_Recurrence () const
	Gets the recurrence pattern. More...
ASPOSE_EMAIL_SHARED_API void	set_Recurrence (System::SharedPtr< Recurrences::RecurrencePattern > value)
	Sets the recurrence pattern. More...
ASPOSE_EMAIL_SHARED_API System::String	get_SequenceId () const
	Gets the sequence id. More...
ASPOSE_EMAIL_SHARED_API void	set_SequenceId (System::String value)
	Gets the sequence id. More...
ASPOSE_EMAIL_SHARED_API AppointmentFlags	get_Flags () const
	Gets appointment flags. More...
ASPOSE_EMAIL_SHARED_API void	set_Flags (AppointmentFlags value)
	Sets appointment flags. More...
ASPOSE_EMAIL_SHARED_API AppointmentMethodType	get_MethodType () const
	Gets the iCalendar object method type associated with the calendar object. More...
ASPOSE_EMAIL_SHARED_API void	set_MethodType (AppointmentMethodType value)
	Sets the iCalendar object method type associated with the calendar object. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AppointmentReminderCollection >	get_Reminders () const
	Contains collection of AppointmentReminder AppointmentReminder objects. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AttachmentCollection >	get_Attachments () const
	Gets the collection of attachments of appointment. More...
ASPOSE_EMAIL_SHARED_API System::String	get_StartTimeZone () const
	Start time zone More...
ASPOSE_EMAIL_SHARED_API void	set_StartTimeZone (System::String value)
	Start time zone More...
ASPOSE_EMAIL_SHARED_API System::String	get_EndTimeZone () const
	End time zone More...
ASPOSE_EMAIL_SHARED_API void	set_EndTimeZone (System::String value)
	End time zone More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< Aspose::Email::Common::TimeZone::Zone >	get_StartTimeZoneInfo ()
	Start time zone More...
ASPOSE_EMAIL_SHARED_API void	set_StartTimeZoneInfo (System::SharedPtr< Aspose::Email::Common::TimeZone::Zone > value)
	Start time zone More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< Aspose::Email::Common::TimeZone::Zone >	get_EndTimeZoneInfo ()
	End time zone More...
ASPOSE_EMAIL_SHARED_API void	set_EndTimeZoneInfo (System::SharedPtr< Aspose::Email::Common::TimeZone::Zone > value)
	End time zone More...
ASPOSE_EMAIL_SHARED_API AppointmentAction	get_Action () const
	Gets appointment action More...
ASPOSE_EMAIL_SHARED_API void	set_Action (AppointmentAction value)
	Sets appointment action More...
ASPOSE_EMAIL_SHARED_API 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...
ASPOSE_EMAIL_SHARED_API 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...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< ObjectIdentifier >	get_Id () const
	Object identifier More...
ASPOSE_EMAIL_SHARED_API	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...
ASPOSE_EMAIL_SHARED_API	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...
ASPOSE_EMAIL_SHARED_API	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...
ASPOSE_EMAIL_SHARED_API	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...
ASPOSE_EMAIL_SHARED_API	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...
ASPOSE_EMAIL_SHARED_API	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...
ASPOSE_EMAIL_SHARED_API	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...
ASPOSE_EMAIL_SHARED_API	Appointment ()
ASPOSE_EMAIL_SHARED_API void	ResetTimeZone ()
	Set local time zone More...
ASPOSE_EMAIL_SHARED_API void	SetTimeZone (System::String tzName)
	Set time zone More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AlternateView >	RequestApointment ()
	Requests the apointment. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AlternateView >	RequestApointment (int32_t seqId)
	Requests the apointment. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AlternateView >	CancelAppointment ()
	Cancels the appointment. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AlternateView >	CancelAppointment (int32_t seqId)
	Cancels the appointment. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AlternateView >	UpdateAppointment ()
	Updates the appointment. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< AlternateView >	UpdateAppointment (int32_t seqId)
	Updates the appointment. More...
ASPOSE_EMAIL_SHARED_API System::String	GetAppointmentHtml ()
	Gets the calendar HTML. More...
ASPOSE_EMAIL_SHARED_API System::String	GetAppointmentText ()
	Gets the calendar text. More...
ASPOSE_EMAIL_SHARED_API System::String	GetAppointmentText (System::SharedPtr< AppointmentFormattingOptions > formattingOptions)
	Gets the calendar text. More...
ASPOSE_EMAIL_SHARED_API void	Save (System::String filePath)
	Saves appointment to the file with iCalendar format using te default save options More...
ASPOSE_EMAIL_SHARED_API void	Save (System::String filePath, AppointmentSaveFormat saveFormat)
	Saves appointment to the file with specified format using te default save options More...
ASPOSE_EMAIL_SHARED_API void	Save (System::String filePath, System::SharedPtr< AppointmentSaveOptions > saveOptions)
	Saves appointment to the file with specified save options More...
ASPOSE_EMAIL_SHARED_API void	Save (System::SharedPtr< System::IO::Stream > stream)
	Saves appointment to the file with iCalendar format using te default save options More...
ASPOSE_EMAIL_SHARED_API void	Save (System::SharedPtr< System::IO::Stream > stream, AppointmentSaveFormat saveFormat)
	Saves appointment to the stream with specified format using te default save options More...
ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API System::SharedPtr< Appointment >	Load (System::String filePath)
	Loads Appointment from the file. Supported file formats: iCalendar More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< Appointment >	Load (System::String filePath, System::SharedPtr< AppointmentLoadOptions > options)
	Loads Appointment from the file. Supported file formats: iCalendar Parameters filePath A file path. options Represents appointment load optionsAppointmentLoadOptions. Returns A read Appointment. More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< Appointment >	Load (System::SharedPtr< System::IO::Stream > stream)
	Loads Appointment from the stream More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< Appointment >	Load (System::SharedPtr< System::IO::Stream > stream, bool applyLocalTimeZone)
	Loads Appointment from the stream More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< Appointment >	Load (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< AppointmentLoadOptions > options)
	Loads Appointment from the stream More...
static ASPOSE_EMAIL_SHARED_API System::String	GetMediaTypeValue (System::String method, System::String charset)

Public Attributes
System::SharedPtr< System::Collections::Generic::List< System::String > >	categories
System::SharedPtr< System::Collections::Generic::List< System::DateTime > >	exDates
System::DateTime	dateTimeStamp
System::SharedPtr< MailAddressCollection >	optionalAttendees
System::String	sequenceId
AppointmentMethodType	method
System::String	htmlContent
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 ASPOSE_EMAIL_SHARED_API	~Appointment ()

Friends
class	Aspose::Email::Calendar::CalendarWriter
class	Aspose::Email::Clients::Exchange::WebService::EWSClient2007
class	Aspose::Email::Clients::Exchange::WebService::CalendarEwsConverter
class	Aspose::Email::Common::CalendarConverter
class	Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentReader
class	Aspose::Email::Clients::Google::Commands::CalendarAPI::V3::Parsers::AppointmentWriter
class	Aspose::Email::AlternateView

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_SHARED_API 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

location	The location of the calendar event.
startDate	The start time of the calendar event.
endDate	The end time of the calendar event.
organizer	The organizer of the calendar event.
attendees	The attendees of th calendar event.

Appointment() [2/8]

ASPOSE_EMAIL_SHARED_API 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

location	The location of the calendar event.
summary	The summary of the calendar event.
description	The description of the calendar event.
startDate	The start time of the calendar event.
endDate	The end time of the calendar event.
organizer	The organizer of the calendar event.
attendees	The attendees of th calendar event.

Appointment() [3/8]

ASPOSE_EMAIL_SHARED_API 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

location	The location of the calendar event.
summary	The summary of the calendar event.
description	The description of the calendar event.
startDate	The start time of the calendar event.
endDate	The end time of the calendar event.
organizer	The organizer of the calendar event.
attendees	The attendees of th calendar event.
uid	The unique identifier of th calendar event.

Appointment() [4/8]

ASPOSE_EMAIL_SHARED_API 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

location	The location of the calendar event.
summary	The summary of the calendar event.
description	The description of the calendar event.
startDate	The start time of the calendar event.
endDate	The end time of the calendar event.
organizer	The organizer of the calendar event.
attendees	The attendees of th calendar event.
uid	The unique identifier of th calendar event.

Appointment() [5/8]

ASPOSE_EMAIL_SHARED_API 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

location	The location of the calendar event.
summary	The summary of the calendar event.
description	The description of the calendar event.
startDate	The start time of the calendar event.
endDate	The end time of the calendar event.
organizer	The organizer of the calendar event.
attendees	The attendees of th calendar event.
recurrencePattern	The recurrence pattern.

Appointment() [6/8]

ASPOSE_EMAIL_SHARED_API 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

location	The location of the calendar event.
summary	The summary of the calendar event.
description	The description of the calendar event.
startDate	The start time of the calendar event.
endDate	The end time of the calendar event.
organizer	The organizer of the calendar event.
attendees	The attendees of th calendar event.
uid	The unique identifier of th calendar event.
recurrencePattern	The recurrence pattern.

Appointment() [7/8]

ASPOSE_EMAIL_SHARED_API 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

location	The location of the calendar event.
summary	The summary of the calendar event.
description	The description of the calendar event.
startDate	The start time of the calendar event.
endDate	The end time of the calendar event.
organizer	The organizer of the calendar event.
attendees	The attendees of th calendar event.
uid	The unique identifier of th calendar event.
recurrencePattern	The recurrence pattern.

Appointment() [8/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Calendar::Appointment::Appointment

(

)

~Appointment()

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

protectedvirtual

Member Function Documentation

CancelAppointment() [1/2]

ASPOSE_EMAIL_SHARED_API 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]

ASPOSE_EMAIL_SHARED_API System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::CancelAppointment

(

int32_t

seqId

)

Cancels the appointment.

Parameters

seqId

The sequence id.

Returns

AlternateViewAlternateView that represents the format to view an email message.

get_Action()

ASPOSE_EMAIL_SHARED_API AppointmentAction Aspose::Email::Calendar::Appointment::get_Action

(

)

const

Gets appointment action

get_Attachments()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<AttachmentCollection> Aspose::Email::Calendar::Appointment::get_Attachments

(

)

const

Gets the collection of attachments of appointment.

get_Attendees()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddressCollection> Aspose::Email::Calendar::Appointment::get_Attendees

(

)

const

Gets the attendees.

get_CreatedDate()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::get_Description

(

)

Gets the description.

get_EndDate()

ASPOSE_EMAIL_SHARED_API System::DateTime Aspose::Email::Calendar::Appointment::get_EndDate

(

)

const

Gets the end date.

get_EndTimeZone()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::get_EndTimeZone

(

)

const

End time zone

get_EndTimeZoneInfo()

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

(

)

End time zone

get_ExtendedProperties()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API AppointmentFlags Aspose::Email::Calendar::Appointment::get_Flags

(

)

const

Gets appointment flags.

get_Id()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<ObjectIdentifier> Aspose::Email::Calendar::Appointment::get_Id

(

)

const

Object identifier

get_IsDescriptionHtml()

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::Calendar::Appointment::get_IsDescriptionHtml

(

)

const

Gets value which indicates if description is in HTML format

get_LastModifiedDate()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::get_Location

(

)

Gets the location.

get_MethodType()

ASPOSE_EMAIL_SHARED_API AppointmentMethodType Aspose::Email::Calendar::Appointment::get_MethodType

(

)

const

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

get_MicrosoftBusyStatus()

ASPOSE_EMAIL_SHARED_API MSBusyStatus Aspose::Email::Calendar::Appointment::get_MicrosoftBusyStatus

(

)

const

Specifies the BUSY status of an appointment.

get_MicrosoftIntendedStatus()

ASPOSE_EMAIL_SHARED_API MSIntendedStatus Aspose::Email::Calendar::Appointment::get_MicrosoftIntendedStatus

(

)

const

Specifies the INTENDED status of an appointment.

get_OptionalAttendees()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddressCollection> Aspose::Email::Calendar::Appointment::get_OptionalAttendees

(

)

const

Gets the optional attendees.

The address collection of optional attendees.

get_Organizer()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::Calendar::Appointment::get_Organizer

(

)

const

Gets the organizer.

get_Recurrence()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<Recurrences::RecurrencePattern> Aspose::Email::Calendar::Appointment::get_Recurrence

(

)

const

Gets the recurrence pattern.

The recurrence pattern.

get_Reminders()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<AppointmentReminderCollection> Aspose::Email::Calendar::Appointment::get_Reminders

(

)

const

Contains collection of AppointmentReminder AppointmentReminder objects.

get_SequenceId()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::get_SequenceId

(

)

const

Gets the sequence id.

The sequence id.

get_StartDate()

ASPOSE_EMAIL_SHARED_API System::DateTime Aspose::Email::Calendar::Appointment::get_StartDate

(

)

const

Gets the start date.

get_StartTimeZone()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::get_StartTimeZone

(

)

const

Start time zone

get_StartTimeZoneInfo()

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

(

)

Start time zone

get_Status()

ASPOSE_EMAIL_SHARED_API AppointmentStatus Aspose::Email::Calendar::Appointment::get_Status

(

)

const

Gets the overall status or confirmation for the object.

get_Summary()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::get_Summary

(

)

Gets the summary.

get_Transparency()

ASPOSE_EMAIL_SHARED_API AppointmentTransparency Aspose::Email::Calendar::Appointment::get_Transparency

(

)

const

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

get_UniqueId()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::GetAppointmentHtml

(

)

Gets the calendar HTML.

Returns

String value of calendar as HTML.

GetAppointmentText() [1/2]

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::GetAppointmentText

(

)

Gets the calendar text.

Returns

String value of calendar as plain text.

GetAppointmentText() [2/2]

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Calendar::Appointment::GetAppointmentText

(

System::SharedPtr< AppointmentFormattingOptions >

formattingOptions

)

Gets the calendar text.

Parameters

formattingOptions

AppointmentFormattingOptions that represents appointment formatting options.

Returns

The text representation of appointment.

Exceptions

ArgumentNullException

throws when formattingOptions is null.

GetMediaTypeValue()

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

static

Load() [1/5]

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

static

Loads Appointment from the stream

Parameters

stream

A stream to load from

Returns

A read Appointment

Exceptions

ArgumentNullException	stream is null
NotSupportedException	stream does not support reading

Load() [2/5]

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

static

Loads Appointment from the stream

Parameters

stream	A stream to load from
applyLocalTimeZone	Convert time to local timezone

Returns

A read Appointment

Exceptions

ArgumentNullException	stream is null
NotSupportedException	stream does not support reading

Load() [3/5]

static ASPOSE_EMAIL_SHARED_API 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

stream	A stream to load from
options	Represents appointment load options

Returns

A read Appointment

Exceptions

ArgumentNullException	stream is null
NotSupportedException	stream does not support reading

Load() [4/5]

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

static

Loads Appointment from the file. Supported file formats: iCalendar

Parameters

filePath

A file path

Returns

A read Appointment

Exceptions

ArgumentException

filePath is null or empty

Load() [5/5]

static ASPOSE_EMAIL_SHARED_API 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

filePath	A file path.
options	Represents appointment load optionsAppointmentLoadOptions.

Returns

A read Appointment.

RequestApointment() [1/2]

ASPOSE_EMAIL_SHARED_API 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]

ASPOSE_EMAIL_SHARED_API System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::RequestApointment

(

int32_t

seqId

)

Requests the apointment.

Parameters

seqId

The sequence id.

Returns

AlternateViewAlternateView that represents the format to view an email message.

ResetTimeZone()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::ResetTimeZone

(

)

Set local time zone

Save() [1/6]

ASPOSE_EMAIL_SHARED_API 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

stream

A stream to save to

Exceptions

ArgumentNullException	stream is null
NotSupportedException	stream does not support writing

Save() [2/6]

ASPOSE_EMAIL_SHARED_API 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

stream	A stream to save to
saveFormat	A save format

Exceptions

ArgumentNullException	stream is null
NotSupportedException	The specified save options are not supported
NotSupportedException	stream does not support writing

Save() [3/6]

ASPOSE_EMAIL_SHARED_API 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

stream	A stream to save to
saveOptions	A save options

Exceptions

ArgumentNullException	saveOptions or stream is null
NotSupportedException	the specified save options are not supported
NotSupportedException	stream does not support writing

Save() [4/6]

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::Save

(

System::String

filePath

)

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

Parameters

filePath

A file path

Exceptions

ArgumentOutOfRangeException

filePath is null or empty

Save() [5/6]

ASPOSE_EMAIL_SHARED_API 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

filePath	A file path
saveFormat	A save format

Exceptions

ArgumentOutOfRangeException	filePath is null or empty
NotSupportedException	The specified save options are not supported

Save() [6/6]

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

Saves appointment to the file with specified save options

Parameters

filePath	A file path
saveOptions	A save options

Exceptions

ArgumentOutOfRangeException	filePath is null or empty
ArgumentNullException	saveOptions is null
NotSupportedException	The specified save options are not supported

set_Action()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Action

(

AppointmentAction

value

)

Sets appointment action

set_Attendees()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Attendees

(

System::SharedPtr< MailAddressCollection >

value

)

Sets the attendees.

set_CreatedDate()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Description

(

System::String

value

)

Sets the description.

set_EndDate()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_EndDate

(

System::DateTime

value

)

Sets the end date.

set_EndTimeZone()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_EndTimeZone

(

System::String

value

)

End time zone

set_EndTimeZoneInfo()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_EndTimeZoneInfo

(

System::SharedPtr< Aspose::Email::Common::TimeZone::Zone >

value

)

End time zone

set_Flags()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Flags

(

AppointmentFlags

value

)

Sets appointment flags.

set_IsDescriptionHtml()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_IsDescriptionHtml

(

bool

value

)

Sets value which indicates if description is in HTML format

set_LastModifiedDate()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Location

(

System::String

value

)

Sets the location.

set_MethodType()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_MethodType

(

AppointmentMethodType

value

)

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

set_MicrosoftBusyStatus()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_MicrosoftBusyStatus

(

MSBusyStatus

value

)

Specifies the BUSY status of an appointment.

set_MicrosoftIntendedStatus()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_MicrosoftIntendedStatus

(

MSIntendedStatus

value

)

Specifies the INTENDED status of an appointment.

set_Organizer()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Organizer

(

System::SharedPtr< MailAddress >

value

)

Sets the organizer.

set_Recurrence()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Recurrence

(

System::SharedPtr< Recurrences::RecurrencePattern >

value

)

Sets the recurrence pattern.

The recurrence pattern.

set_SequenceId()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_SequenceId

(

System::String

value

)

Gets the sequence id.

The sequence id.

set_StartDate()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_StartDate

(

System::DateTime

value

)

Sets the start date.

set_StartTimeZone()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_StartTimeZone

(

System::String

value

)

Start time zone

set_StartTimeZoneInfo()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_StartTimeZoneInfo

(

System::SharedPtr< Aspose::Email::Common::TimeZone::Zone >

value

)

Start time zone

set_Status()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Status

(

AppointmentStatus

value

)

Sets the overall status or confirmation for the object.

set_Summary()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::set_Summary

(

System::String

value

)

Sets the summary.

set_Transparency()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Calendar::Appointment::SetTimeZone

(

System::String

tzName

)

Set time zone

Parameters

tzName

The time zone name, for sample "America/New_York"

UpdateAppointment() [1/2]

ASPOSE_EMAIL_SHARED_API 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]

ASPOSE_EMAIL_SHARED_API System::SharedPtr<AlternateView> Aspose::Email::Calendar::Appointment::UpdateAppointment

(

int32_t

seqId

)

Updates the appointment.

Parameters

seqId

The 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

friend class Aspose::Email::Calendar::CalendarWriter

friend

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::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::Common::CalendarConverter

friend class Aspose::Email::Common::CalendarConverter

friend

Member Data Documentation

categories

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

dateTimeStamp

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

exDates

System::SharedPtr<System::Collections::Generic::List<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

htmlContent

System::String Aspose::Email::Calendar::Appointment::htmlContent

isLoaded

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

method

AppointmentMethodType Aspose::Email::Calendar::Appointment::method

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