Package org.openapitools.client.api

Class MessageApi

  • public class MessageApi
extends Object

    • Constructor Detail

      • MessageApi

        public MessageApi()

      • MessageApi

        public MessageApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deliverMessageCall

        public okhttp3.Call deliverMessageCall​(CorrelationMessageDto correlationMessageDto,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for deliverMessage
        Parameters:
        correlationMessageDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deliverMessage

        public List<MessageCorrelationResultWithVariableDto> deliverMessage​(CorrelationMessageDto correlationMessageDto)
                                                             throws ApiException
        Correlate Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.18/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.18/reference/bpmn20/).
        Parameters:
        correlationMessageDto - (optional)
        Returns:
        List<MessageCorrelationResultWithVariableDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deliverMessageWithHttpInfo

        public ApiResponse<List<MessageCorrelationResultWithVariableDto>> deliverMessageWithHttpInfo​(CorrelationMessageDto correlationMessageDto)
                                                                                      throws ApiException
        Correlate Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.18/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.18/reference/bpmn20/).
        Parameters:
        correlationMessageDto - (optional)
        Returns:
        ApiResponse<List<MessageCorrelationResultWithVariableDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deliverMessageAsync

        public okhttp3.Call deliverMessageAsync​(CorrelationMessageDto correlationMessageDto,
                                        ApiCallback<List<MessageCorrelationResultWithVariableDto>> _callback)
                                 throws ApiException
        Correlate (asynchronously) Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.18/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.18/reference/bpmn20/).
        Parameters:
        correlationMessageDto - (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