(info) This AI is still in early stages of development.

instance.deactivate()

Deactivate the interval timer so the process instance will no longer be run at a regular interval.

 

Syntax

Processes("myProcess").deactivate(quiet);

Parameters

ParameterTypeMandatoryNotesPulse Version

quiet

Boolean

(error)

If true the instance.onDeactivate() event will not be fired.

0.1

Return value

ValueTypeNotesProcess Version
<instance>Process Instance

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

Processes("foo").deactivate(...).addTask(...).run();
0.1

Examples

 

Availability

Requires:

  • Warzone 3.1 or above
  • Process 0.1 or above

See also

Related documentation:

  • setTimer() – the JS API function that the process instance uses to set timer intervals.
  • Process Instances – everything you wanted to know about process instances