Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt

Abort the current run of a process instance, optionally cancelling any queued runs.

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
ProcessesProcess("myProcess").abort(all);
// note: instance.onEnd() will be called when the aborted run ends

Parameters

ParameterTypeMandatoryNotesPulse Version

all

Boolean

(error)

If true all queued runs will be cancelled.

Default: false

0.1

Return value

ValueTypeNotesProcess Version
<instance>Process Instance

The process instance is returned, so you can chain more instance methods, eg:

Code Block
themeRDark
languagejavascript
linenumberstrue
ProcessesProcess("foo").abort(...).addTask(...).run();
0.1

Examples

 

Div
classbox

Availability

Requires:

  • Warzone 3.1 or above
  • Process 0.1 or above