MapiTask

Inheritance: java.lang.Object, com.aspose.email.MapiPropertyContainer, com.aspose.email.MapiMessageItemBase

public class MapiTask extends MapiMessageItemBase

Represents the Outlook Task object.

Constructors

Constructor 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.

Methods

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

MapiTask()

public MapiTask()

Initializes a new instance of the MapiTask class.

MapiTask(String subject, String body, Date startDate, Date dueDate)

public MapiTask(String subject, String body, Date startDate, Date dueDate)

Initializes a new instance of the MapiTask class.

Parameters:

Parameter Type Description
subject java.lang.String The subject.
body java.lang.String The message body.
startDate java.util.Date The start date.
dueDate java.util.Date The due date.

getPercentComplete()

public final int getPercentComplete()

Gets or sets the progress the user has made on a task.

Returns: int

setPercentComplete(int value)

public final void setPercentComplete(int value)

Gets or sets the progress the user has made on a task.

Parameters:

Parameter Type Description
value int

getActualEffort()

public final int getActualEffort()

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

Returns: int

setActualEffort(int value)

public final void setActualEffort(int value)

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

Parameters:

Parameter Type Description
value int

getEstimatedEffort()

public final int getEstimatedEffort()

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

Returns: int

setEstimatedEffort(int value)

public final void setEstimatedEffort(int value)

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

Parameters:

Parameter Type Description
value int

getDueDate()

public final Date getDueDate()

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

Returns: java.util.Date

setDueDate(Date value)

public final void setDueDate(Date value)

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

Parameters:

Parameter Type Description
value java.util.Date

getStartDate()

public final Date getStartDate()

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

Returns: java.util.Date

setStartDate(Date value)

public final void setStartDate(Date value)

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

Parameters:

Parameter Type Description
value java.util.Date

getDateCompleted()

public final Date getDateCompleted()

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

Returns: java.util.Date

setDateCompleted(Date value)

public final void setDateCompleted(Date value)

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

Parameters:

Parameter Type Description
value java.util.Date

getLastUpdate()

public final Date getLastUpdate()

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

Returns: java.util.Date

setLastUpdate(Date value)

public final void setLastUpdate(Date value)

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

Parameters:

Parameter Type Description
value java.util.Date

getRecurrence()

public final MapiCalendarRecurrencePattern getRecurrence()

Gets or sets the recurrence properties.

Returns: MapiCalendarRecurrencePattern

setRecurrence(MapiCalendarRecurrencePattern value)

public final void setRecurrence(MapiCalendarRecurrencePattern value)

Gets or sets the recurrence properties.

Parameters:

Parameter Type Description
value MapiCalendarRecurrencePattern

getHistory()

public final int getHistory()

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

Returns: int

setHistory(int value)

public final void setHistory(int value)

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

Parameters:

Parameter Type Description
value int

getUsers()

public final MapiTaskUsers getUsers()

Gets or sets information about task users.

Returns: MapiTaskUsers

setUsers(MapiTaskUsers value)

public final void setUsers(MapiTaskUsers value)

Gets or sets information about task users.

Parameters:

Parameter Type Description
value MapiTaskUsers

getStatus()

public final int getStatus()

Gets or sets the status of the user’s progress on the task.

Returns: int

setStatus(int value)

public final void setStatus(int value)

Gets or sets the status of the user’s progress on the task.

Parameters:

Parameter Type Description
value int

getMode()

public final int getMode()

Gets or sets the assignment status of the Task object.

Returns: int

setMode(int value)

public final void setMode(int value)

Gets or sets the assignment status of the Task object.

Parameters:

Parameter Type Description
value int

getState()

public final int getState()

Gets or sets the current assignment state of the Task object.

Returns: int

setState(int value)

public final void setState(int value)

Gets or sets the current assignment state of the Task object.

Parameters:

Parameter Type Description
value int

getAcceptanceState()

public final int getAcceptanceState()

Gets or sets the acceptance state of the task.

Returns: int

setAcceptanceState(int value)

public final void setAcceptanceState(int value)

Gets or sets the acceptance state of the task.

Parameters:

Parameter Type Description
value int

getFlags()

public final int getFlags()

Gets the indication flags of the Task object.

Returns: int

getReminderTime()

public final Date getReminderTime()

Gets or sets the initial signal time for a reminder

Returns: java.util.Date

setReminderTime(Date value)

public final void setReminderTime(Date value)

Gets or sets the initial signal time for a reminder

Parameters:

Parameter Type Description
value java.util.Date

getReminderSet()

public final boolean getReminderSet()

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

Returns: boolean

setReminderSet(boolean value)

public final void setReminderSet(boolean value)

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

Parameters:

Parameter Type Description
value boolean

getReminderFileParameter()

public final String getReminderFileParameter()

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

Returns: java.lang.String

setReminderFileParameter(String value)

public final void setReminderFileParameter(String value)

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

Parameters:

Parameter Type Description
value java.lang.String

save(OutputStream stream, int saveFormat)

public final void save(OutputStream stream, int saveFormat)

Saves this MapiTask to the given stream using specified format.

Parameters:

Parameter Type Description
stream java.io.OutputStream
saveFormat int

save(String filePath, int saveFormat)

public final void save(String filePath, int saveFormat)

Saves this MapiTask into file using specified format.

Parameters:

Parameter Type Description
filePath java.lang.String
saveFormat int

fromVTodo(String filePath)

public static MapiTask fromVTodo(String filePath)

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

Parameters:

Parameter Type Description
filePath java.lang.String The path to the file to be loaded.

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified file.

fromVTodo(String filePath, boolean detectEncoding)

public static MapiTask fromVTodo(String filePath, boolean detectEncoding)

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

Parameters:

Parameter Type Description
filePath java.lang.String The path to the file to be loaded.
detectEncoding boolean Determines a data encoding by analyzing its byte order mark (BOM)

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified file.

fromVTodo(InputStream stream)

public static MapiTask fromVTodo(InputStream stream)

Creates an instance of MapiTask from the specified stream.

Parameters:

Parameter Type Description
stream java.io.InputStream The stream to be loaded.

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified stream.

fromVTodo(InputStream stream, boolean detectEncoding)

public static MapiTask fromVTodo(InputStream stream, boolean detectEncoding)

Creates an instance of MapiTask from the specified stream.

Parameters:

Parameter Type Description
stream java.io.InputStream The stream to be loaded.
detectEncoding boolean Determines a data encoding by analyzing its byte order mark (BOM)

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified stream.