AlterToDo Method

Alter a todo task item.

Syntax

spworkflow.alterToDo([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Invoking this method will alter the todo task specified by the TaskIndex property. The item is specified by the ItemURL property.

Before calling the method, the TaskParams property must be populated with the correct input values. You can call ListTasks and set the TaskIndex to populate the TaskParams.