Zeebe C# Client 2.5.0
C# Client to communicate with an Zeebe Gateway
Loading...
Searching...
No Matches
IModifyProcessInstanceCommandStep1 Interface Reference

Command to modify a process instance. More...

Public Member Functions

IModifyProcessInstanceCommandStep3 ActivateElement (string elementId)
 Create an activate Instruction for the given element id. The element will be created within an existing element instance of the flow scope. When activating an element inside a multi-instance element the element instance key of the ancestor must be defined. For this use ActivateElement(string, long). More...
 
IModifyProcessInstanceCommandStep3 ActivateElement (string elementId, long ancestorElementInstanceKey)
 Create an activate Instruction for the given element id. The element will be created within the scope that is passed. This scope must be an ancestor of the element that's getting activated. More...
 
IModifyProcessInstanceCommandStep2 TerminateElement (long elementInstanceKey)
 Create a terminate instruction for the given element id. More...
 

Detailed Description

Command to modify a process instance.

Member Function Documentation

◆ ActivateElement() [1/2]

IModifyProcessInstanceCommandStep3 IModifyProcessInstanceCommandStep1.ActivateElement ( string  elementId)

Create an activate Instruction for the given element id. The element will be created within an existing element instance of the flow scope. When activating an element inside a multi-instance element the element instance key of the ancestor must be defined. For this use ActivateElement(string, long).

Parameters
elementIdThe id of the element to activate.
Returns
The builder for this command.

◆ ActivateElement() [2/2]

IModifyProcessInstanceCommandStep3 IModifyProcessInstanceCommandStep1.ActivateElement ( string  elementId,
long  ancestorElementInstanceKey 
)

Create an activate Instruction for the given element id. The element will be created within the scope that is passed. This scope must be an ancestor of the element that's getting activated.

Parameters
elementIdThe id of the element to activate.
ancestorElementInstanceKeyThe element instance key in which the element will be created.
Returns
The builder for this command.

◆ TerminateElement()

IModifyProcessInstanceCommandStep2 IModifyProcessInstanceCommandStep1.TerminateElement ( long  elementInstanceKey)

Create a terminate instruction for the given element id.

Parameters
elementInstanceKeyThe element instance key of the element to terminate.
Returns
the builder for this command.

The documentation for this interface was generated from the following file: