| Excerpt |
|---|
Remove any matching tasks, or all tasks, from a process instance. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Processes("myProcess").removeTask(task, taskName, scope); |
Parameters
If a parameter is specified as null it will be ignored. Tasks will only be removed if all non-null parameters are matched.
If you don't specify any parameters, all tasks will be removed from the process instance!!
| Parameter | Type | Mandatory | Notes | Pulse Version |
|---|---|---|---|---|
| task | Null |  | A task function or If a task function is specified, tasks can only be removed if they match that exact task function. | 0.1 |
| taskName | String Null | | A taskName or If a taskName is specified, tasks can only be removed if they have that exact taskName. Note that if you added tasks via an array in the instance.addTask() method, each of those tasks will have had the array index appended to it's taskName. | 0.1 |
| scope | Object Null | | A scope object or If a scope object is specified, tasks can only be removed if they were added with that scope. | 0.1 |
Return value
| Value | Type | Notes | Process Version | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| <instance> | Process Instance | The process instance is returned, so you can chain more instance methods, eg:
| 0.1 |
Examples
| Div | ||
|---|---|---|
| ||
AvailabilityRequires:
|
| Div | ||
|---|---|---|
| ||
See alsoEssential reading:
|