Packages

com.aspose.email

Interfaces

Classes

Enums

Exceptions

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

All Implemented Interfaces:

IMapiMessageItem, com.aspose.ms.System.IDisposable
```
public class MapiTask
extends MapiMessageItemBase
```
Represents the Outlook Task object.

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

Constructor Summary

Constructors
Constructor and Description
`MapiTask()` Initializes a new instance of the `MapiTask` class.
`MapiTask(String subject, String body, Date startDate, Date dueDate)` Initializes a new instance of the `MapiTask` class.

Method Summary

Methods
Modifier and Type	Method and Description
`static MapiTask`	`fromVTodo(InputStream stream)` Creates an instance of MapiTask from the specified stream.
`static MapiTask`	`fromVTodo(InputStream stream, boolean detectEncoding)` Creates an instance of MapiTask from the specified stream.
`static MapiTask`	`fromVTodo(String filePath)` Creates an instance of MapiTask from the specified .ics file.
`static MapiTask`	`fromVTodo(String filePath, boolean detectEncoding)` Creates an instance of MapiTask from the specified .ics file.
`int`	`getAcceptanceState()` Gets or sets the acceptance state of the task.
`int`	`getActualEffort()` Gets or sets the number of minutes that the user actually spent working on a task.
`Date`	`getDateCompleted()` Gets or sets the date when the user completed work on the task.
`Date`	`getDueDate()` Gets or sets the date by which the user expects work on the task to be complete.
`int`	`getEstimatedEffort()` Gets or sets the number of minutes that the user expects to work on a task.
`int`	`getFlags()` Gets the indication flags of the Task object.
`int`	`getHistory()` Gets or sets the type of change that was last made to the Task object.
`Date`	`getLastUpdate()` Gets or sets the date and time of the most recent change made to the Task object.
`int`	`getMode()` Gets or sets the assignment status of the Task object.
`int`	`getPercentComplete()` Gets or sets the progress the user has made on a task.
`MapiCalendarRecurrencePattern`	`getRecurrence()` Gets or sets the recurrence properties.
`String`	`getReminderFileParameter()` Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
`boolean`	`getReminderSet()` Gets or sets a value indicating whether a reminder is set on the object
`Date`	`getReminderTime()` Gets or sets the initial signal time for a reminder
`Date`	`getStartDate()` Gets or sets the date on which the user expects work on the task to begin.
`int`	`getState()` Gets or sets the current assignment state of the Task object.
`int`	`getStatus()` Gets or sets the status of the user's progress on the task.
`MapiTaskUsers`	`getUsers()` Gets or sets information about task users.
`void`	`save(OutputStream stream, int saveFormat)` Saves this `MapiTask` to the given stream using specified format.
`void`	`save(String filePath, int saveFormat)` Saves this `MapiTask` into file using specified format.
`void`	`setAcceptanceState(int value)` Gets or sets the acceptance state of the task.
`void`	`setActualEffort(int value)` Gets or sets the number of minutes that the user actually spent working on a task.
`void`	`setDateCompleted(Date value)` Gets or sets the date when the user completed work on the task.
`void`	`setDueDate(Date value)` Gets or sets the date by which the user expects work on the task to be complete.
`void`	`setEstimatedEffort(int value)` Gets or sets the number of minutes that the user expects to work on a task.
`void`	`setHistory(int value)` Gets or sets the type of change that was last made to the Task object.
`void`	`setLastUpdate(Date value)` Gets or sets the date and time of the most recent change made to the Task object.
`void`	`setMode(int value)` Gets or sets the assignment status of the Task object.
`void`	`setPercentComplete(int value)` Gets or sets the progress the user has made on a task.
`void`	`setRecurrence(MapiCalendarRecurrencePattern value)` Gets or sets the recurrence properties.
`void`	`setReminderFileParameter(String value)` Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
`void`	`setReminderSet(boolean value)` Gets or sets a value indicating whether a reminder is set on the object
`void`	`setReminderTime(Date value)` Gets or sets the initial signal time for a reminder
`void`	`setStartDate(Date value)` Gets or sets the date on which the user expects work on the task to begin.
`void`	`setState(int value)` Gets or sets the current assignment state of the Task object.
`void`	`setStatus(int value)` Gets or sets the status of the user's progress on the task.
`void`	`setUsers(MapiTaskUsers value)` Gets or sets information about task users.

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

- Constructor Detail
  - MapiTask
```
public MapiTask()
```
    Initializes a new instance of the MapiTask class.
  - MapiTask
```
public MapiTask(String subject,
        String body,
        Date startDate,
        Date dueDate)
```
    Initializes a new instance of the MapiTask class.
    
    Parameters:
    subject - The subject.
    body - The message body.
    startDate - The start date.
    dueDate - The due date.
- Method Detail
  - getPercentComplete
```
public final int getPercentComplete()
```
    Gets or sets the progress the user has made on a task.
  - setPercentComplete
```
public final void setPercentComplete(int value)
```
    Gets or sets the progress the user has made on a task.
  - getActualEffort
```
public final int getActualEffort()
```
    Gets or sets the number of minutes that the user actually spent working on a task.
  - setActualEffort
```
public final void setActualEffort(int value)
```
    Gets or sets the number of minutes that the user actually spent working on a task.
  - getEstimatedEffort
```
public final int getEstimatedEffort()
```
    Gets or sets the number of minutes that the user expects to work on a task.
  - setEstimatedEffort
```
public final void setEstimatedEffort(int value)
```
    Gets or sets the number of minutes that the user expects to work on a task.
  - getDueDate
```
public final Date getDueDate()
```
    Gets or sets the date by which the user expects work on the task to be complete.
  - setDueDate
```
public final void setDueDate(Date value)
```
    Gets or sets the date by which the user expects work on the task to be complete.
  - getStartDate
```
public final Date getStartDate()
```
    Gets or sets the date on which the user expects work on the task to begin.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - trows when start date is greater than date completed.
  - setStartDate
```
public final void setStartDate(Date value)
```
    Gets or sets the date on which the user expects work on the task to begin.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - trows when start date is greater than date completed.
  - getDateCompleted
```
public final Date getDateCompleted()
```
    Gets or sets the date when the user completed work on the task.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - throws when start date is less than date completed.
  - setDateCompleted
```
public final void setDateCompleted(Date value)
```
    Gets or sets the date when the user completed work on the task.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - throws when start date is less than date completed.
  - getLastUpdate
```
public final Date getLastUpdate()
```
    Gets or sets the date and time of the most recent change made to the Task object.
  - setLastUpdate
```
public final void setLastUpdate(Date value)
```
    Gets or sets the date and time of the most recent change made to the Task object.
  - getRecurrence
```
public final MapiCalendarRecurrencePattern getRecurrence()
```
    Gets or sets the recurrence properties.
  - setRecurrence
```
public final void setRecurrence(MapiCalendarRecurrencePattern value)
```
    Gets or sets the recurrence properties.
  - getHistory
```
public final int getHistory()
```
    Gets or sets the type of change that was last made to the Task object.
  - setHistory
```
public final void setHistory(int value)
```
    Gets or sets the type of change that was last made to the Task object.
  - getUsers
```
public final MapiTaskUsers getUsers()
```
    Gets or sets information about task users.
  - setUsers
```
public final void setUsers(MapiTaskUsers value)
```
    Gets or sets information about task users.
  - getStatus
```
public final int getStatus()
```
    Gets or sets the status of the user's progress on the task.
  - setStatus
```
public final void setStatus(int value)
```
    Gets or sets the status of the user's progress on the task.
  - getMode
```
public final int getMode()
```
    Gets or sets the assignment status of the Task object.
  - setMode
```
public final void setMode(int value)
```
    Gets or sets the assignment status of the Task object.
  - getState
```
public final int getState()
```
    Gets or sets the current assignment state of the Task object.
  - setState
```
public final void setState(int value)
```
    Gets or sets the current assignment state of the Task object.
  - getAcceptanceState
```
public final int getAcceptanceState()
```
    Gets or sets the acceptance state of the task.
  - setAcceptanceState
```
public final void setAcceptanceState(int value)
```
    Gets or sets the acceptance state of the task.
  - getFlags
```
public final int getFlags()
```
    Gets the indication flags of the Task object.
  - getReminderTime
```
public final Date getReminderTime()
```
    Gets or sets the initial signal time for a reminder
  - setReminderTime
```
public final void setReminderTime(Date value)
```
    Gets or sets the initial signal time for a reminder
  - getReminderSet
```
public final boolean getReminderSet()
```
    Gets or sets a value indicating whether a reminder is set on the object
  - setReminderSet
```
public final void setReminderSet(boolean value)
```
    Gets or sets a value indicating whether a reminder is set on the object
  - getReminderFileParameter
```
public final String getReminderFileParameter()
```
    Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
  - setReminderFileParameter
```
public final void setReminderFileParameter(String value)
```
    Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
  - save
```
public final void save(OutputStream stream,
        int saveFormat)
```
    Saves this MapiTask to the given stream using specified format.
  - save
```
public final void save(String filePath,
        int saveFormat)
```
    Saves this MapiTask into file using specified format.
  - fromVTodo
```
public static MapiTask fromVTodo(String filePath)
```
    Creates an instance of MapiTask from the specified .ics file.
    
    Parameters:
    filePath - The path to the file to be loaded.
    
    Returns:
    Returns a MapiTask instance which is loaded from the specified file.
  - fromVTodo
```
public static MapiTask fromVTodo(String filePath,
                 boolean detectEncoding)
```
    Creates an instance of MapiTask from the specified .ics file.
    
    Parameters:
    filePath - The path to the file to be loaded.
    detectEncoding - Determines a data encoding by analyzing its byte order mark (BOM)
    
    Returns:
    Returns a MapiTask instance which is loaded from the specified file.
  - fromVTodo
```
public static MapiTask fromVTodo(InputStream stream)
```
    Creates an instance of MapiTask from the specified stream.
    
    Parameters:
    stream - The stream to be loaded.
    
    Returns:
    Returns a MapiTask instance which is loaded from the specified stream.
  - fromVTodo
```
public static MapiTask fromVTodo(InputStream stream,
                 boolean detectEncoding)
```
    Creates an instance of MapiTask from the specified stream.
    
    Parameters:
    stream - The stream to be loaded.
    detectEncoding - Determines a data encoding by analyzing its byte order mark (BOM)
    
    Returns:
    Returns a MapiTask instance which is loaded from the specified stream.

Packages

com.aspose.email

Interfaces

Classes

Enums

Exceptions

Class MapiTask

Field Summary

Fields inherited from class com.aspose.email.MapiMessageItemBase

Constructor Summary

Method Summary

Methods inherited from class com.aspose.email.MapiMessageItemBase

Methods inherited from class com.aspose.email.MapiPropertyContainer

Methods inherited from class java.lang.Object

Constructor Detail

MapiTask

MapiTask

Method Detail

getPercentComplete

setPercentComplete

getActualEffort

setActualEffort

getEstimatedEffort

setEstimatedEffort

getDueDate

setDueDate

getStartDate

setStartDate

getDateCompleted

setDateCompleted

getLastUpdate

setLastUpdate

getRecurrence

setRecurrence

getHistory

setHistory

getUsers

setUsers

getStatus

setStatus

getMode

setMode

getState

setState

getAcceptanceState

setAcceptanceState

getFlags

getReminderTime

setReminderTime

getReminderSet

setReminderSet

getReminderFileParameter

setReminderFileParameter

save

save

fromVTodo

fromVTodo

fromVTodo

fromVTodo