Package org.camunda.community.rest.client.api

Class SignalApi

java.lang.Object
org.camunda.community.rest.client.api.SignalApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class SignalApi extends Object

  • Constructor Details

    • SignalApi

      public SignalApi()

    • SignalApi

      public SignalApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • 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.21/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.21/reference/bpmn20/).
      Parameters:
      signalDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • throwSignal

      public void throwSignal(SignalDto signalDto, Map<String,String> additionalHeaders) 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.21/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.21/reference/bpmn20/).
      Parameters:
      signalDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call