RDOTaskItem object

 

RDOTaskItem object represents an "IPM.Task" message in one of Outlook Task folders. RDOTaskItem is derived from the RDOMail object and as such inherits all the properties, methods and events implemented by the RDOMail object.

 

Everywhere RDOMail object is normally returned (RDOSession.GetMessageFromID, RDOFolder.Items, etc), RDOTaskItem will be returned if the message class is "IPM.Task".

 

The example below logs to the default profile, then creates and sends a task request to 3 recipients.

set Session = CreateObject("Redemption.RDOSession")
Session.Logon
set Task = Session.GetDefaultFolder(olFolderTasks).Items.Add
Task.Subject = "Test Redemption Task"
Task.Body = "Test Task Body"
Task.StartDate = #5/1/2006#
Task.Assign
set RecipAssign = Task.Recipients.Add("OtherUser@domain.com")
RecipAssign.Type =olTo
set RecipUpdate = Task.Recipients.Add("update@domain.com")
RecipUpdate.Type =olCC
set RecipComplete = Task.Recipients.Add("complete@domain.com")
RecipComplete.Type = olBCC
Task.Recipients.ResolveAll
Task.Send

 

Properties

Methods

 

Derived from: RDOMail

In addition to all the properties and methods specific to RDONoteItem, it also implements all properties, methods and events of the RDOMail object, from which it is derived.

Properties

ActualWork

Returns or sets a Long indicating the actual effort (in minutes) spent on the task. Read/write.

 

  
Assigners
 Returns RDOAddressEntries collection representing the stack of the task assigners.
 set Session = CreateObject("Redemption.RDOSession")
Session.MAPIOBJECT = Application.Session.MAPIOBJECT
set Task = Session.GetMessageFromID(Application.ActiveExplorer.Selection(1).EntryID)
for each AE in Task.Assigners
    Debug.Print AE.Name & ": " & AE.Address
next

CardData

Returns or sets a String representing the text of the card data for the task. Read/write.

 

  

Complete

True if the task is completed. Read/write Boolean.

 

  

ContactNames

Sets or returns a String representing the contact names associated with the task item or journal entry. Read/write.

 

 

Contacts

Returns an array of String representing the contact names associated with the task item or journal entry. Read-only.

 

 

DateCompleted

Returns or sets a Date indicating the completion date of the task. Read/write.

 

 

DelegationState

Returns an rdoTaskDelegationState constant indicating the delegation state of the task. Read-only.

DelegationState can be one of these rdoTaskDelegationState constants.
olTaskDelegationAccepted
olTaskDelegationDeclined
olTaskDelegationUnknown
olTaskNotDelegated
 

 

Delegator

Returns a String representing the display name of the delegator for the task. Read-only.

 

 

DueDate

Returns or sets a Date indicating the due date for the task. Read/write.

 

 
GlobalTaskID
 Read/write, string. Global task id used by Outlook to correlate task requests / updates / responses with the existing task items in the Tasks folder.
This property might not be set if the task has never assigned/sent.
  

IsRecurring

True if the task is a recurring task. When the GetRecurrencePattern method is used with an RDOTaskItem object, this property is set to True. Read-only Boolean.
 

 

Ordinal

Returns or sets a Long specifying the position in the view (ordinal) for the task. Read/write.

 

 

Owner

Returns or sets a String indicating the owner for the task. This is a free-form string field. Setting this property to someone other than the current user does not have the effect of delegating the task. Read/write if the task is stored on the Exchange Server public folder. Read-only if it's stored in a user's mailbox or personal folders file.

 

 

Ownership

Returns an rdoTaskOwnership specifying the ownership state of the task. Read-only.

Ownership can be one of these rdoTaskOwnership constants.
olDelegatedTask
olNewTask
olOwnTask
 

 

RecurrenceState

Returns an rdoRecurrenceState constant indicating the recurrence property of the specified object. Read-only.
 

RecurrenceState can be one of these rdoRecurrenceState constants.
olApptException
olApptMaster
olApptNotRecurring
olApptOccurrence
 

 

PercentComplete

Returns or sets a Long indicating the percentage of the task completed at the current date and time. Read/write.

 

 

ResponseState

Returns an rdoTaskResponse constant indicating the overall status of the response to the specified task request. Read-only.

ResponseStatecan be one of these rdoTaskResponse constants.
olTaskAccept
olTaskAssign
olTaskDecline
olTaskSimple

 

This method is not implemented in the current version of Redemption.
 

 

Role

Returns or sets a String containing the free-form text string associating the owner of a task with a role for the task. Read/write.

 

 

SchedulePlusPriority

Returns or sets a String representing the Microsoft Schedule+ priority for the task. Can be 1 through 9, A through Z, or A1 through Z9. Priority 1 is the highest. Read/write.
 

 

StartDate

Returns or sets a Date specifying the starting date and time for the specified task. Read/write.

 

 

Status

Returns or sets an rdoTaskStatus constant specifying the status for the task. Corresponds to the Status field of a TaskItem. Read/write.

Status can be one of these rdoTaskStatus constants.
olTaskComplete
olTaskDeferred
olTaskInProgress
olTaskNotStarted
olTaskWaiting
 

 

StatusOnCompletionRecipients

Returns or sets a semicolon-delimited String of display names for recipients who will receive status upon completion of the task. This property is calculated from the Recipients property. Recipients returned by the StatusOnCompletionRecipients property correspond to BCC recipients in the Recipients collection. Read/write.
 

 

StatusUpdateRecipients

Returns a semicolon-delimited String of display names for recipients who receive status updates for the task. This property is calculated from the Recipients property. Recipients returned by the StatusUpdateRecipients property correspond to CC recipients in the Recipients collection. Read-only.
 

 

TeamTask

True if the task is a team task. Read/write Boolean.

 

 

TotalWork

Returns or sets a Long indicating the total work for the task. Corresponds to the Total work field on the Details tab of a Task item. Read/write.
 

 

Methods

Assign

Assigns a task and returns a an RDOTaskItem object that represents it. This method allows a task to be assigned (delegated) to another user. You must create a task before you can assign it, and you must assign a task before you can send it. An assigned task is sent as a TaskRequestItem object.
 

  

CancelResponseState

Resets an unsent response to a task request back to a simple task. After you receive a task request and respond to it, but before sending the response, you can use this method to revert the task to its state before you responded.
 

  

ClearRecurrencePattern

Removes the recurrence settings and restores the single-occurrence state for an appointment or task.
 

  

GetRecurrencePattern

Returns an RDORecurrencePattern object that represents the recurrence attributes of an appointment. If there is no existing recurrence pattern, a new empty RDORecurrencePattern object is returned.
 

set Session = CreateObject("Redemption.RDOSession")
Session.Logon

set Task = Session.GetDefaultFolder(olFolderTasks).Items.Add
Task.Subject = "Test Redemption Task"
Task.Body = "Test Task Body"
Task.StartDate = #5/1/2006#
Set myRecurrPatt = Task.GetRecurrencePattern
myRecurrPatt.RecurrenceType = olRecursDaily
myRecurrPatt.Interval = 3
myRecurrPatt.PatternStartDate = #5/1/2006#
myRecurrPatt.PatternEndDate = #5/1/2007#
Task.Save

MarkComplete

If the task is recurring and is set to regenerate itself upon completion, advances the task to the next iteration and creates new completed task for the current iteration.

Otherwise marks the task as completed. Sets PercentComplete to "100%", Complete to True, and DateCompleted to the current date.

 

See MarkCompleteEx below.

  
MarkCompleteEx

If the task is recurring and is set to regenerate itself upon completion, advances the task to the next iteration and creates new completed task for the current iteration.

Otherwise marks the task as completed. Sets PercentComplete to "100%", Complete to True, and DateCompleted to the current date.

 

Returns the completed task, either the new single instance if the task regenerates itself or the master task itself.

 

Also see MarkCompleteEx above.

 

  

Respond(Response, fNoUI, fAdditionalTextDialog)

Responds to a task request for the TaskItem object.

expression.Respond(Response, fNoUI, fAdditionalTextDialog)

Response Required rdoTaskResponse. The response to the request.


olTaskAccept
olTaskAssign
olTaskDecline
olTaskSimple

fNoUI - True to not display a dialog box; the response is sent automatically. False to display the dialog box for responding.

fAdditionalTextDialog - False to not prompt the user for input; the response is displayed in the inspector for editing. True to prompt the user to either send or send with comments. This argument is valid only if fNoUI is False.
 

This method is not implemented in the current version of Redemption.

 

 

SkipRecurrence

Clears the current instance of a recurring task and sets the recurrence to the next instance of that task.

 

This method is not implemented in the current version of Redemption.

 

 

StatusReport

Sends a status report to all Cc recipients (recipients returned by the StatusUpdateRecipients property) with the current status for the task. Returns an Object representing the status report.