org.openapitools.client.api

Class MessageApi

java.lang.Object

org.openapitools.client.api.MessageApi

public class MessageApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MessageApi()
MessageApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<MessageCorrelationResultWithVariableDto>	deliverMessage(CorrelationMessageDto correlationMessageDto) Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.
okhttp3.Call	deliverMessageAsync(CorrelationMessageDto correlationMessageDto, ApiCallback<List<MessageCorrelationResultWithVariableDto>> _callback) (asynchronously) Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.
okhttp3.Call	deliverMessageCall(CorrelationMessageDto correlationMessageDto, ApiCallback _callback) Build call for deliverMessage
ApiResponse<List<MessageCorrelationResultWithVariableDto>>	deliverMessageWithHttpInfo(CorrelationMessageDto correlationMessageDto) Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

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

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.13/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.13/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

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.13/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.13/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

(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.13/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.13/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