Aspose::Email::Mapi::MapiTask Class Reference

Represents the Outlook Task object. More...

Inherits Aspose::Email::Mapi::MapiMessageItemBase.

Public Member Functions

int32_t get_PercentComplete () const
 Gets the progress the user has made on a task. More...
 
void set_PercentComplete (int32_t value)
 Sets the progress the user has made on a task. More...
 
int32_t get_ActualEffort () const
 Gets the number of minutes that the user actually spent working on a task. More...
 
void set_ActualEffort (int32_t value)
 Sets the number of minutes that the user actually spent working on a task. More...
 
int32_t get_EstimatedEffort () const
 Gets the number of minutes that the user expects to work on a task. More...
 
void set_EstimatedEffort (int32_t value)
 Sets the number of minutes that the user expects to work on a task. More...
 
System::DateTime get_DueDate () const
 Gets the date by which the user expects work on the task to be complete. More...
 
void set_DueDate (System::DateTime value)
 Sets the date by which the user expects work on the task to be complete. More...
 
System::DateTime get_StartDate () const
 Gets the date on which the user expects work on the task to begin. More...
 
void set_StartDate (System::DateTime value)
 Sets the date on which the user expects work on the task to begin. More...
 
System::DateTime get_DateCompleted () const
 Gets the date when the user completed work on the task. More...
 
void set_DateCompleted (System::DateTime value)
 Sets the date when the user completed work on the task. More...
 
System::DateTime get_LastUpdate () const
 Gets the date and time of the most recent change made to the Task object. More...
 
void set_LastUpdate (System::DateTime value)
 Sets the date and time of the most recent change made to the Task object. More...
 
System::SharedPtr< MapiCalendarRecurrencePatternget_Recurrence () const
 Gets the recurrence properties. More...
 
void set_Recurrence (System::SharedPtr< MapiCalendarRecurrencePattern > value)
 Sets the recurrence properties. More...
 
MapiTaskHistory get_History ()
 Gets the type of change that was last made to the Task object. More...
 
void set_History (MapiTaskHistory value)
 Sets the type of change that was last made to the Task object. More...
 
System::SharedPtr< MapiTaskUsersget_Users () const
 Gets information about task users. More...
 
void set_Users (System::SharedPtr< MapiTaskUsers > value)
 Sets information about task users. More...
 
MapiTaskStatus get_Status ()
 Gets the status of the user's progress on the task. More...
 
void set_Status (MapiTaskStatus value)
 Sets the status of the user's progress on the task. More...
 
MapiTaskMode get_Mode ()
 Gets the assignment status of the Task object. More...
 
void set_Mode (MapiTaskMode value)
 Sets the assignment status of the Task object. More...
 
MapiTaskState get_State ()
 Gets the current assignment state of the Task object. More...
 
void set_State (MapiTaskState value)
 Sets the current assignment state of the Task object. More...
 
MapiTaskPriority get_Priority ()
 Gets the current Priority of the Task object. More...
 
void set_Priority (MapiTaskPriority value)
 Sets the current Priority of the Task object. More...
 
MapiTaskAcceptanceState get_AcceptanceState ()
 Gets the acceptance state of the task. More...
 
void set_AcceptanceState (MapiTaskAcceptanceState value)
 Sets the acceptance state of the task. More...
 
MapiTaskFlags get_Flags () const
 Gets the indication flags of the Task object. More...
 
void set_Flags (MapiTaskFlags value)
 Gets the indication flags of the Task object. More...
 
System::DateTime get_ReminderTime () const
 Gets the initial signal time for a reminder More...
 
void set_ReminderTime (System::DateTime value)
 Sets the initial signal time for a reminder More...
 
bool get_ReminderSet () const
 Gets a value indicating whether a reminder is set on the object More...
 
void set_ReminderSet (bool value)
 Sets a value indicating whether a reminder is set on the object More...
 
System::String get_ReminderFileParameter () const
 Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue. More...
 
void set_ReminderFileParameter (System::String value)
 Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue. More...
 
System::SharedPtr< MapiAttachmentCollectionget_Attachments () const
 Gets the attachments collection. More...
 
 MapiTask ()
 Initializes a new instance of the MapiTask class. More...
 
 MapiTask (System::String subject, System::String body, System::DateTime startDate, System::DateTime dueDate)
 Initializes a new instance of the MapiTask class. More...
 
 MapiTask (System::SharedPtr< MapiMessage > msg)
 Initializes a new instance of the MapiTask class. More...
 
System::SharedPtr< MapiMessageGetUnderlyingMessage ()
 Retrieves the underlying MapiMessage object. More...
 
void Save (System::SharedPtr< System::IO::Stream > stream, TaskSaveFormat saveFormat)
 Saves this MapiTask to the given stream using specified format. More...
 
void Save (System::String filePath, TaskSaveFormat saveFormat)
 Saves this MapiTask into file using specified format. More...
 
System::SharedPtr< MapiMessageConvertToMapiMessage () override
 Converts the task object to mapi message More...
 
MapiTaskFlags GetsFlags (System::SharedPtr< MapiMessage > msg)
 Gets the flags. More...
 
System::SharedPtr< Aspose::Email::Calendar::Model::CalendarObject > ToIcalendar (System::SharedPtr< Aspose::Email::Calendar::Model::Property::MethodProperty > method)
 
- Public Member Functions inherited from Aspose::Email::Mapi::MapiMessageItemBase
virtual System::String get_ItemId ()
 The item id, uses with a server More...
 
virtual void set_ItemId (System::String value)
 The item id, uses with a server More...
 
System::SharedPtr< MapiAttachmentCollectionget_Attachments ()
 Gets the attachments in the message. More...
 
void set_Attachments (System::SharedPtr< MapiAttachmentCollection > value)
 Gets the attachments in the message. More...
 
System::SharedPtr< MapiPropertyStreamget_PropertyStream ()
 Gets the property stream. More...
 
System::SharedPtr< MapiPropertyCollectionget_NamedProperties ()
 Gets the named properties of message. More...
 
System::SharedPtr< MapiRecipientCollectionget_Recipients ()
 Gets the recipients of the message. More...
 
void set_Recipients (System::SharedPtr< MapiRecipientCollection > value)
 Gets the recipients of the message. More...
 
System::SharedPtr< MapiPropertyCollectionget_SubStorages ()
 Gets the sub storages. More...
 
System::SharedPtr< MapiNamedPropertyMappingStorageget_NamedPropertyMapping ()
 Gets the named property mapping. More...
 
System::String get_SubjectPrefix ()
 Gets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding. More...
 
BodyContentType get_BodyType ()
 Gets the type of the body. More...
 
System::String get_BodyRtf ()
 Gets the RTF formatted message text. More...
 
void set_BodyRtf (System::String value)
 Sets the RTF formatted message text. More...
 
System::String get_BodyHtml ()
 Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. More...
 
System::ArrayPtr< System::String > get_Companies ()
 Contains the names of the companies that are associated with an item. More...
 
void set_Companies (System::ArrayPtr< System::String > value)
 Contains the names of the companies that are associated with an item. More...
 
System::ArrayPtr< System::String > get_Categories ()
 Contains keywords or categories for the message object. More...
 
void set_Categories (System::ArrayPtr< System::String > value)
 Contains keywords or categories for the message object. More...
 
System::String get_Mileage ()
 Contains the mileage information that is associated with an item. More...
 
void set_Mileage (System::String value)
 Contains the mileage information that is associated with an item. More...
 
System::String get_Billing ()
 Contains the billing information associated with an item. More...
 
void set_Billing (System::String value)
 Contains the billing information associated with an item. More...
 
Aspose::Email::Storage::Pst::MapiSensitivity get_Sensitivity ()
 Gets the Sensitivity. More...
 
void set_Sensitivity (Aspose::Email::Storage::Pst::MapiSensitivity value)
 Gets the Sensitivity. More...
 
System::String get_MessageClass () override
 Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message. More...
 
void set_MessageClass (System::String value)
 Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message. More...
 
MapiItemType get_SupportedType () override
 Gets the supported item type. More...
 
System::String get_Body () override
 Gets the message text. More...
 
void set_Body (System::String value) override
 Gets the message text. More...
 
System::String get_Subject () override
 Gets the subject of the message. More...
 
void set_Subject (System::String value) override
 Sets the subject of the message. More...
 
System::SharedPtr< System::Object > get_VentureLicenseObj () const
 This stores the venture licensing state instead of 2 obvious fields such as string value for watermark and some value indicating license is set or not. More...
 
System::SharedPtr< MapiPropertyGetProperty (System::SharedPtr< PropertyDescriptor > pd) override
 Gets MAPI property by property descriptor. More...
 
bool TryGetNamedProperty (System::SharedPtr< MapiProperty > mapiProperty, System::SharedPtr< MapiNamedProperty > &mapiNamedProperty) override
 If MapiNamedPropertyMappingStorage is available, initializes and returns MapiNamedProperty, otherwise null. More...
 
void SetProperty (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value) override
 Sets MAPI property. More...
 
void SetStringNamedProperty (System::String value, MapiNamedPropertyId nameId, System::Guid psetId)
 
void SetsIMapiMessageItemMembers (System::String messageClass, System::String body, System::String subject)
 Sets MessageClass,Body and Subject. More...
 
void Dispose () override
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
void SetNamedPropertyMapping (System::SharedPtr< MapiNamedPropertyMappingStorage > value)
 Sets the named property mapping. More...
 
int64_t GetTagFromNamedProperty (MapiNamedPropertyId propertyId)
 Gets the tag from named property. More...
 
int64_t GetTagFromNamedProperty (System::String name)
 Gets the tag from named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid)
 Adds the named property. More...
 
void AddNamedProperty (System::SharedPtr< MapiAttachment > attachment, MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid)
 Adds the named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> mvEntries)
 Adds the named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
 Adds the named property. More...
 
void AddNamedProperty (System::SharedPtr< MapiAttachment > attachment, MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
 Adds the named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> mvEntries)
 Adds the named property. More...
 
int64_t AddNamedPropertyToEmbeddedMsg (System::SharedPtr< MapiMessage > msg, MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::SharedPtr< System::Object > nameId, System::Guid guid)
 Adds the named property to embedded message. More...
 
void SetBodyRtf (System::String content, bool compression)
 Gets or sets the RTF formatted message text. More...
 
virtual void SetBodyContent (System::String content, BodyContentType contentType)
 Sets the content of the body. More...
 
virtual void SetBodyContent (System::String content, BodyContentType contentType, bool compression)
 Sets the content of the body. More...
 
void SetMessageFlags (MapiMessageFlags flags)
 Sets the message flags. More...
 
void RemoveProperty (int64_t tag)
 Provides correctly removing property from all collections. More...
 
void SetVentureLicense (System::SharedPtr< System::Object > ventureLicense)
 All Aspose products should implement this method. It is called by a GroupDocs product to indicate whether GroupDocs itself is licensed or not and specify a custom watermark. When GroupDocs is licensed, this document instance should behave as licensed too even if the Aspose product is not licensed. More...
 
void UpdateHasAttach ()
 Updates the PR_HASATTACH property value. More...
 
MapiMessageFlags GetFlags ()
 
void UpdateDisplayNames (MapiRecipientType recipientType)
 Updates the display names. More...
 
void AddNamedProperty (System::DateTime value, int64_t nameId, System::Guid guid)
 Adds the named datetime property. More...
 
void AddNamedProperty (System::DateTime value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named datetime property. More...
 
void AddNamedProperty (bool value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named bool property. More...
 
void AddNamedProperty (bool value, int64_t nameId, System::Guid guid)
 Adds the named bool property. More...
 
void AddNamedPropertyLong (int64_t value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named long property. More...
 
void AddNamedPropertyLong (int64_t value, int64_t nameId, System::Guid guid)
 Adds the named long property. More...
 
void AddNamedProperty (System::String value, OutlookMessageFormat format, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named string property. More...
 
void AddNamedProperty (System::String value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named string property. More...
 
void AddNamedProperty (System::String value, OutlookMessageFormat format, int64_t nameId, System::Guid guid)
 Adds the named string property. More...
 
void AddNamedProperty (System::ArrayPtr< uint8_t > value, int64_t nameId, System::Guid guid)
 Adds the named binary property. More...
 
void AddNamedProperty (System::ArrayPtr< uint8_t > value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named binary property. More...
 
- Public Member Functions inherited from Aspose::Email::Mapi::MapiPropertyContainer
virtual System::SharedPtr< MapiPropertyCollectionget_Properties ()
 Gets the collection of properties. More...
 
virtual int32_t get_CodePage ()
 Gets the code page. More...
 
System::SharedPtr< System::Text::Encoding > get_CurrentEncoding ()
 
 MapiPropertyContainer ()
 Initializes a new instance of the MapiPropertyContainer class. More...
 
 MapiPropertyContainer (System::SharedPtr< MapiPropertyCollection > properties)
 Initializes a new instance of the MapiPropertyContainer class. More...
 
System::SharedPtr< MapiPropertyCollectionGetSubStorages ()
 
System::String TryGetPropertyString (int64_t tag, int32_t codepage)
 Try to get a property data as string with specified tag and code page. More...
 
System::ArrayPtr< uint8_t > TryGetPropertyData (int64_t tag)
 Try to get the property data with specified tag key. More...
 
System::String TryGetPropertyString (int64_t tag)
 Try to get a property data as string with specified tag. More...
 
System::String GetPropertyString (int64_t tag, int32_t codepage)
 Gets the string value of the property specified by tag. More...
 
System::String GetPropertyString (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
System::ArrayPtr< uint8_t > GetPropertyBytes (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
virtual void SetProperty (System::SharedPtr< MapiProperty > value)
 Sets the property. More...
 
System::Nullable< int32_t > GetPropertyInt32 (int64_t tag)
 Gets the int32 value of the property specified by tag. More...
 
System::Nullable< int64_t > GetPropertyLong (int64_t tag)
 Gets the value of the property specified by tag as Long (int64) type. More...
 
System::Nullable< int16_t > GetPropertyShort (int64_t tag)
 Gets the value of the property specified by tag as Short type. More...
 
System::Nullable< bool > GetPropertyBoolean (int64_t tag)
 Gets the value of the property specified by tag as Boolean type. More...
 
System::Nullable< System::DateTime > GetPropertyDateTime (int64_t key)
 Gets the value of the property specified by tag as DateTime type. More...
 
bool IsStoreUnicodeOk ()
 Determines if string properties are Unicode encoded or not. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value, int32_t codepage)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyDateTime (int64_t tag, System::DateTime &value)
 Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyLong (int64_t tag, int64_t &value)
 Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyInt32 (int64_t tag, int32_t &value)
 Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded. More...
 
virtual System::SharedPtr< Nodes::IMapiNode > CreateMapiNode (System::String key)
 Creates the mapi node. More...
 
void SetProperty (int64_t tag, System::ArrayPtr< uint8_t > data)
 Set the property. More...
 
void SetProperty (int64_t tag, System::String value, OutlookMessageFormat format)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, bool isUnicode)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, System::SharedPtr< System::Text::Encoding > nonUnicodeEncoding)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value)
 Set the string property with CurrentEncoding More...
 
void SetProperty (int64_t tag, System::DateTime dateTime)
 Set the datetime property. More...
 
void SetPropertyLong (int64_t tag, int64_t value)
 Set the long property. More...
 

Static Public Member Functions

static System::SharedPtr< MapiTaskFromVTodo (System::String filePath)
 Creates an instance of MapiTask from the specified .ics file. More...
 
static System::SharedPtr< MapiTaskFromVTodo (System::String filePath, bool detectEncoding)
 Creates an instance of MapiTask from the specified .ics file. More...
 
static System::SharedPtr< MapiTaskFromVTodo (System::SharedPtr< System::IO::Stream > stream)
 Creates an instance of MapiTask from the specified stream. More...
 
static System::SharedPtr< MapiTaskFromVTodo (System::SharedPtr< System::IO::Stream > stream, bool detectEncoding)
 Creates an instance of MapiTask from the specified stream. More...
 
- Static Public Member Functions inherited from Aspose::Email::Mapi::MapiMessageItemBase
static void SetPriority (System::SharedPtr< MapiMessageItemBase > message, MailPriority priority)
 Sets MailPriority value for MapiMessageItemBase See more PidTagPriority mapi property: https://msdn.microsoft.com/en-us/library/ee159473(v=exchg.80).aspx See more PidTagImportance mapi property: https://msdn.microsoft.com/en-us/library/ee237166(v=exchg.80).aspx More...
 
static int64_t GetTagFromNamedProperty (MapiNamedPropertyId propertyId, System::SharedPtr< MapiPropertyCollection > namedProperties)
 
static int64_t GetTagFromNamedProperty (System::String name, System::SharedPtr< MapiPropertyCollection > namedProperties)
 

Friends

class Aspose::Email::Clients::Exchange::WebService::TaskEwsConverter
 
class Aspose::Email::Tools::TaskConverter
 
class Aspose::Email::Mapi::TaskMailMessageInterpretor
 
class Aspose::Email::Mapi::MapiMessage
 

Additional Inherited Members

- Public Attributes inherited from Aspose::Email::Mapi::MapiMessageItemBase
System::SharedPtr< MapiNamedPropertyMappingStoragenamedPropertyMappingStorage
 The named property mapping storage. More...
 
- Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
int32_t codePage
 The code page. More...
 
System::SharedPtr< MapiPropertyCollectionpropertyDictionary
 The property dictionary. More...
 
- Static Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
static const int32_t DefaultCodePage
 
- Protected Member Functions inherited from Aspose::Email::Mapi::MapiMessageItemBase
 MapiMessageItemBase ()
 Initializes a new instance of the MapiMessageItemBase class. More...
 
 MapiMessageItemBase (System::SharedPtr< MapiPropertyCollection > properties)
 Initializes a new instance of the MapiMessageItemBase class. More...
 
void CheckIsDisposed ()
 Checks if the object is disposed and raised exception in this case. More...
 
void InitNamedPropertyMappingStorage ()
 Inits the named property mapping storage. More...
 
System::SharedPtr< MapiNamedPropertyCreateNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
 
virtual ~MapiMessageItemBase ()
 
- Protected Member Functions inherited from Aspose::Email::Mapi::MapiPropertyContainer
virtual ~MapiPropertyContainer ()
 
- Protected Attributes inherited from Aspose::Email::Mapi::MapiMessageItemBase
System::SharedPtr< MapiAttachmentCollectionattachments
 The collection of attachments. More...
 
System::SharedPtr< MapiRecipientCollectionrecipients
 The collection of recipients. More...
 

Detailed Description

Represents the Outlook Task object.

Constructor & Destructor Documentation

◆ MapiTask() [1/3]

Aspose::Email::Mapi::MapiTask::MapiTask ( )

Initializes a new instance of the MapiTask class.

◆ MapiTask() [2/3]

Aspose::Email::Mapi::MapiTask::MapiTask ( System::String  subject,
System::String  body,
System::DateTime  startDate,
System::DateTime  dueDate 
)

Initializes a new instance of the MapiTask class.

Parameters
subjectThe subject.
bodyThe message body.
startDateThe start date.
dueDateThe due date.

◆ MapiTask() [3/3]

Aspose::Email::Mapi::MapiTask::MapiTask ( System::SharedPtr< MapiMessage msg)

Initializes a new instance of the MapiTask class.

Parameters
msgThe MapiMessage that represents IPM.Task message class.
Exceptions
ArgumentExceptionthrows when message class has unexpected value.
ArgumentNullExceptionthrows when msg is null.

Member Function Documentation

◆ ConvertToMapiMessage()

System::SharedPtr<MapiMessage> Aspose::Email::Mapi::MapiTask::ConvertToMapiMessage ( )
overridevirtual

Converts the task object to mapi message

Returns
MapiMessage that represents a MAPI message

Reimplemented from Aspose::Email::Mapi::MapiMessageItemBase.

◆ FromVTodo() [1/4]

static System::SharedPtr<MapiTask> Aspose::Email::Mapi::MapiTask::FromVTodo ( System::SharedPtr< System::IO::Stream >  stream)
static

Creates an instance of MapiTask from the specified stream.

Parameters
streamThe stream to be loaded.
Returns
Returns a MapiTask instance which is loaded from the specified stream.

◆ FromVTodo() [2/4]

static System::SharedPtr<MapiTask> Aspose::Email::Mapi::MapiTask::FromVTodo ( System::SharedPtr< System::IO::Stream >  stream,
bool  detectEncoding 
)
static

Creates an instance of MapiTask from the specified stream.

Parameters
streamThe stream to be loaded.
detectEncodingDetermines a data encoding by analyzing its byte order mark (BOM)
Returns
Returns a MapiTask instance which is loaded from the specified stream.

◆ FromVTodo() [3/4]

static System::SharedPtr<MapiTask> Aspose::Email::Mapi::MapiTask::FromVTodo ( System::String  filePath)
static

Creates an instance of MapiTask from the specified .ics file.

Parameters
filePathThe path to the file to be loaded.
Returns
Returns a MapiTask instance which is loaded from the specified file.

◆ FromVTodo() [4/4]

static System::SharedPtr<MapiTask> Aspose::Email::Mapi::MapiTask::FromVTodo ( System::String  filePath,
bool  detectEncoding 
)
static

Creates an instance of MapiTask from the specified .ics file.

Parameters
filePathThe path to the file to be loaded.
detectEncodingDetermines a data encoding by analyzing its byte order mark (BOM)
Returns
Returns a MapiTask instance which is loaded from the specified file.

◆ get_AcceptanceState()

MapiTaskAcceptanceState Aspose::Email::Mapi::MapiTask::get_AcceptanceState ( )

Gets the acceptance state of the task.

◆ get_ActualEffort()

int32_t Aspose::Email::Mapi::MapiTask::get_ActualEffort ( ) const

Gets the number of minutes that the user actually spent working on a task.

◆ get_Attachments()

System::SharedPtr<MapiAttachmentCollection> Aspose::Email::Mapi::MapiTask::get_Attachments ( ) const

Gets the attachments collection.

◆ get_DateCompleted()

System::DateTime Aspose::Email::Mapi::MapiTask::get_DateCompleted ( ) const

Gets the date when the user completed work on the task.

Exceptions
ArgumentExceptiontrows when start date is less than date completed.

◆ get_DueDate()

System::DateTime Aspose::Email::Mapi::MapiTask::get_DueDate ( ) const

Gets the date by which the user expects work on the task to be complete.

◆ get_EstimatedEffort()

int32_t Aspose::Email::Mapi::MapiTask::get_EstimatedEffort ( ) const

Gets the number of minutes that the user expects to work on a task.

◆ get_Flags()

MapiTaskFlags Aspose::Email::Mapi::MapiTask::get_Flags ( ) const

Gets the indication flags of the Task object.

◆ get_History()

MapiTaskHistory Aspose::Email::Mapi::MapiTask::get_History ( )

Gets the type of change that was last made to the Task object.

◆ get_LastUpdate()

System::DateTime Aspose::Email::Mapi::MapiTask::get_LastUpdate ( ) const

Gets the date and time of the most recent change made to the Task object.

◆ get_Mode()

MapiTaskMode Aspose::Email::Mapi::MapiTask::get_Mode ( )

Gets the assignment status of the Task object.

◆ get_PercentComplete()

int32_t Aspose::Email::Mapi::MapiTask::get_PercentComplete ( ) const

Gets the progress the user has made on a task.

◆ get_Priority()

MapiTaskPriority Aspose::Email::Mapi::MapiTask::get_Priority ( )

Gets the current Priority of the Task object.

◆ get_Recurrence()

System::SharedPtr<MapiCalendarRecurrencePattern> Aspose::Email::Mapi::MapiTask::get_Recurrence ( ) const

Gets the recurrence properties.

◆ get_ReminderFileParameter()

System::String Aspose::Email::Mapi::MapiTask::get_ReminderFileParameter ( ) const

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

◆ get_ReminderSet()

bool Aspose::Email::Mapi::MapiTask::get_ReminderSet ( ) const

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

◆ get_ReminderTime()

System::DateTime Aspose::Email::Mapi::MapiTask::get_ReminderTime ( ) const

Gets the initial signal time for a reminder

◆ get_StartDate()

System::DateTime Aspose::Email::Mapi::MapiTask::get_StartDate ( ) const

Gets the date on which the user expects work on the task to begin.

Exceptions
ArgumentExceptiontrows when start date is greater than date completed.

◆ get_State()

MapiTaskState Aspose::Email::Mapi::MapiTask::get_State ( )

Gets the current assignment state of the Task object.

◆ get_Status()

MapiTaskStatus Aspose::Email::Mapi::MapiTask::get_Status ( )

Gets the status of the user's progress on the task.

◆ get_Users()

System::SharedPtr<MapiTaskUsers> Aspose::Email::Mapi::MapiTask::get_Users ( ) const

Gets information about task users.

◆ GetsFlags()

MapiTaskFlags Aspose::Email::Mapi::MapiTask::GetsFlags ( System::SharedPtr< MapiMessage msg)

Gets the flags.

Parameters
msgThe MapiMessage.
Returns
The MapiTaskFlags.

◆ GetUnderlyingMessage()

System::SharedPtr<MapiMessage> Aspose::Email::Mapi::MapiTask::GetUnderlyingMessage ( )

Retrieves the underlying MapiMessage object.

Returns
The MapiMessage object.

◆ Save() [1/2]

void Aspose::Email::Mapi::MapiTask::Save ( System::SharedPtr< System::IO::Stream >  stream,
TaskSaveFormat  saveFormat 
)

Saves this MapiTask to the given stream using specified format.

The supported save format is MSG.

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

◆ Save() [2/2]

void Aspose::Email::Mapi::MapiTask::Save ( System::String  filePath,
TaskSaveFormat  saveFormat 
)

Saves this MapiTask into file using specified format.

The supported save format is MSG.

Parameters
filePathA file name.
saveFormatA save format.
Exceptions
ArgumentExceptionfilePath is null or empty.
NotSupportedExceptionsome save option is not supported

◆ set_AcceptanceState()

void Aspose::Email::Mapi::MapiTask::set_AcceptanceState ( MapiTaskAcceptanceState  value)

Sets the acceptance state of the task.

◆ set_ActualEffort()

void Aspose::Email::Mapi::MapiTask::set_ActualEffort ( int32_t  value)

Sets the number of minutes that the user actually spent working on a task.

◆ set_DateCompleted()

void Aspose::Email::Mapi::MapiTask::set_DateCompleted ( System::DateTime  value)

Sets the date when the user completed work on the task.

Exceptions
ArgumentExceptiontrows when start date is less than date completed.

◆ set_DueDate()

void Aspose::Email::Mapi::MapiTask::set_DueDate ( System::DateTime  value)

Sets the date by which the user expects work on the task to be complete.

◆ set_EstimatedEffort()

void Aspose::Email::Mapi::MapiTask::set_EstimatedEffort ( int32_t  value)

Sets the number of minutes that the user expects to work on a task.

◆ set_Flags()

void Aspose::Email::Mapi::MapiTask::set_Flags ( MapiTaskFlags  value)

Gets the indication flags of the Task object.

◆ set_History()

void Aspose::Email::Mapi::MapiTask::set_History ( MapiTaskHistory  value)

Sets the type of change that was last made to the Task object.

◆ set_LastUpdate()

void Aspose::Email::Mapi::MapiTask::set_LastUpdate ( System::DateTime  value)

Sets the date and time of the most recent change made to the Task object.

◆ set_Mode()

void Aspose::Email::Mapi::MapiTask::set_Mode ( MapiTaskMode  value)

Sets the assignment status of the Task object.

◆ set_PercentComplete()

void Aspose::Email::Mapi::MapiTask::set_PercentComplete ( int32_t  value)

Sets the progress the user has made on a task.

◆ set_Priority()

void Aspose::Email::Mapi::MapiTask::set_Priority ( MapiTaskPriority  value)

Sets the current Priority of the Task object.

◆ set_Recurrence()

void Aspose::Email::Mapi::MapiTask::set_Recurrence ( System::SharedPtr< MapiCalendarRecurrencePattern value)

Sets the recurrence properties.

◆ set_ReminderFileParameter()

void Aspose::Email::Mapi::MapiTask::set_ReminderFileParameter ( System::String  value)

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

◆ set_ReminderSet()

void Aspose::Email::Mapi::MapiTask::set_ReminderSet ( bool  value)

Sets a value indicating whether a reminder is set on the object

◆ set_ReminderTime()

void Aspose::Email::Mapi::MapiTask::set_ReminderTime ( System::DateTime  value)

Sets the initial signal time for a reminder

◆ set_StartDate()

void Aspose::Email::Mapi::MapiTask::set_StartDate ( System::DateTime  value)

Sets the date on which the user expects work on the task to begin.

Exceptions
ArgumentExceptiontrows when start date is greater than date completed.

◆ set_State()

void Aspose::Email::Mapi::MapiTask::set_State ( MapiTaskState  value)

Sets the current assignment state of the Task object.

◆ set_Status()

void Aspose::Email::Mapi::MapiTask::set_Status ( MapiTaskStatus  value)

Sets the status of the user's progress on the task.

◆ set_Users()

void Aspose::Email::Mapi::MapiTask::set_Users ( System::SharedPtr< MapiTaskUsers value)

Sets information about task users.

◆ ToIcalendar()

System::SharedPtr<Aspose::Email::Calendar::Model::CalendarObject> Aspose::Email::Mapi::MapiTask::ToIcalendar ( System::SharedPtr< Aspose::Email::Calendar::Model::Property::MethodProperty >  method)

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::WebService::TaskEwsConverter

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

◆ Aspose::Email::Mapi::MapiMessage

friend class Aspose::Email::Mapi::MapiMessage
friend

◆ Aspose::Email::Mapi::TaskMailMessageInterpretor

friend class Aspose::Email::Mapi::TaskMailMessageInterpretor
friend

◆ Aspose::Email::Tools::TaskConverter

friend class Aspose::Email::Tools::TaskConverter
friend