SPWorkflow Class

Properties   Methods   Events   Configuration Settings   Errors  

Manages the workflows of the list items relating to a specific SharePoint list.

Class Name

InSP_SPWorkflow

Procedural Interface

 insp_spworkflow_open();
 insp_spworkflow_close($res);
 insp_spworkflow_register_callback($res, $id, $function);
 insp_spworkflow_get_last_error($res);
 insp_spworkflow_get_last_error_code($res);
 insp_spworkflow_set($res, $id, $index, $value);
 insp_spworkflow_get($res, $id, $index);
 insp_spworkflow_do_altertodo($res);
 insp_spworkflow_do_config($res, $configurationstring);
 insp_spworkflow_do_doevents($res);
 insp_spworkflow_do_interrupt($res);
 insp_spworkflow_do_listtasks($res);
 insp_spworkflow_do_listworkflows($res);
 insp_spworkflow_do_reset($res);
 insp_spworkflow_do_startworkflow($res);

Remarks

The SPWorkflow class allows you to manage SharePoint workflows.

To get started, first set the URL, User, and Password properties to point the class to your Site, and then set ItemURL to the URL of a specific SharePoint item. To retrieve URLs for all of the items in a list, use the SPList class.

When ListWorkflows is called, the Workflow event will fire for each workflow associated with the specified item. Additionally, the WorkflowCount and WorkflowIndex properties can be used to iterate through each workflow. The WorkflowDescription, WorkflowId, WorkflowName, and WorkflowParams properties can be used to get information about each of the workflows returned by SharePoint.

To start a workflow, call the StartWorkflow method with the WorkflowId of the desired workflow.

The ListTasks method is used to list the tasks for a particular item. The tasks can be iterated through using the TaskCount and TaskIndex properties. Each task will populate the TaskParams collection with information about that particular task.

About SharePoint Online Services

When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).