org.openapitools.client.api

Class SignalApi

java.lang.Object

org.openapitools.client.api.SignalApi

public class SignalApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SignalApi()
SignalApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	throwSignal(SignalDto signalDto) A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers.
okhttp3.Call	throwSignalAsync(SignalDto signalDto, ApiCallback<Void> _callback) (asynchronously) A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers.
okhttp3.Call	throwSignalCall(SignalDto signalDto, ApiCallback _callback) Build call for throwSignal
ApiResponse<Void>	throwSignalWithHttpInfo(SignalDto signalDto) A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignalApi

public SignalApi()

SignalApi

public SignalApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throwSignalCall

public okhttp3.Call throwSignalCall(SignalDto signalDto,
                                    ApiCallback _callback)
                             throws ApiException

Build call for throwSignal

Parameters:

signalDto - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throwSignal

public void throwSignal(SignalDto signalDto)
                 throws ApiException

A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers. Internally this maps to the engine's signal event received builder method `RuntimeService#createSignalEvent()`. For more information about the signal behavior, see the [Signal Events](https://docs.camunda.org/manual/7.14/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.14/reference/bpmn20/).

Parameters:

signalDto - (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

throwSignalWithHttpInfo

public ApiResponse<Void> throwSignalWithHttpInfo(SignalDto signalDto)
                                          throws ApiException

A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers. Internally this maps to the engine's signal event received builder method `RuntimeService#createSignalEvent()`. For more information about the signal behavior, see the [Signal Events](https://docs.camunda.org/manual/7.14/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.14/reference/bpmn20/).

Parameters:

signalDto - (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

throwSignalAsync

public okhttp3.Call throwSignalAsync(SignalDto signalDto,
                                     ApiCallback<Void> _callback)
                              throws ApiException

(asynchronously) A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers. Internally this maps to the engine's signal event received builder method `RuntimeService#createSignalEvent()`. For more information about the signal behavior, see the [Signal Events](https://docs.camunda.org/manual/7.14/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.14/reference/bpmn20/).

Parameters:

signalDto - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object