ListWorkflows Method

Lists the workflows for a particular item.

Syntax

spworkflow.listWorkflows([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

The item is specified by the ItemURL property.

The WorkflowIndex and WorkflowCount properties allow you to iterate through the various workflows that are received by SharePoint. Each workflow will contain a WorkflowDescription, WorkflowId, WorkflowName, and a collection of TaskParams which describe input into the workflow.