Zeebe.Client.Api.Commands.IFinalCommandStep< T > Interface Template Reference

The is a general final command step for the fluent command API, which defines the send method. More...

Inheritance diagram for Zeebe.Client.Api.Commands.IFinalCommandStep< T >:

Public Member Functions
Task< T >	Send (TimeSpan? timeout=null, CancellationToken token=default)
	Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command.
Task< T >	Send (CancellationToken cancellationToken)
	Convenient method, which delegates to Send(TimeSpan? timeout = null, CancellationToken token = default).

Detailed Description

The is a general final command step for the fluent command API, which defines the send method.

Template Parameters

T	the type of the command response.

Member Function Documentation

Send() [1/2]

Task< T > Zeebe.Client.Api.Commands.IFinalCommandStep< T >.Send

(

CancellationToken

cancellationToken

)

Convenient method, which delegates to Send(TimeSpan? timeout = null, CancellationToken token = default).

Parameters

cancellationToken

the token that manages the cancellation of the request.

Returns

a task tracking state of success/failure of the command.

Send() [2/2]

Task< T > Zeebe.Client.Api.Commands.IFinalCommandStep< T >.Send	(	TimeSpan?	timeout = null,
		CancellationToken	token = default
	)

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command.

Use await ...Send(); to wait until the response is available.

T response = await command.Send();

Parameters

timeout	the time span after request should be timed out.
token	the token that manages the cancellation of the request.

Returns

a task tracking state of success/failure of the command.

---

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

• Client/Api/Commands/IFinalCommandStep.cs