Package org.openapitools.client.api

Class SignalApi

  • public class SignalApi
extends Object

    • 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
        Event 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.18/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.18/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
        Event 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.18/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.18/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
        Event (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.18/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.18/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