org.openapitools.client.api

Class TaskCommentApi

java.lang.Object

org.openapitools.client.api.TaskCommentApi

public class TaskCommentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TaskCommentApi()
TaskCommentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CommentDto	createComment(String id, CommentDto commentDto) Creates a comment for a task by id.
okhttp3.Call	createCommentAsync(String id, CommentDto commentDto, ApiCallback<CommentDto> _callback) (asynchronously) Creates a comment for a task by id.
okhttp3.Call	createCommentCall(String id, CommentDto commentDto, ApiCallback _callback) Build call for createComment
ApiResponse<CommentDto>	createCommentWithHttpInfo(String id, CommentDto commentDto) Creates a comment for a task by id.
ApiClient	getApiClient()
CommentDto	getComment(String id, String commentId) Retrieves a task comment by task id and comment id.
okhttp3.Call	getCommentAsync(String id, String commentId, ApiCallback<CommentDto> _callback) (asynchronously) Retrieves a task comment by task id and comment id.
okhttp3.Call	getCommentCall(String id, String commentId, ApiCallback _callback) Build call for getComment
List<CommentDto>	getComments(String id) Gets the comments for a task by id.
okhttp3.Call	getCommentsAsync(String id, ApiCallback<List<CommentDto>> _callback) (asynchronously) Gets the comments for a task by id.
okhttp3.Call	getCommentsCall(String id, ApiCallback _callback) Build call for getComments
ApiResponse<List<CommentDto>>	getCommentsWithHttpInfo(String id) Gets the comments for a task by id.
ApiResponse<CommentDto>	getCommentWithHttpInfo(String id, String commentId) Retrieves a task comment by task id and comment id.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskCommentApi

public TaskCommentApi()

TaskCommentApi

public TaskCommentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createCommentCall

public okhttp3.Call createCommentCall(String id,
                                      CommentDto commentDto,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createComment

Parameters:

id - The id of the task to add the comment to. (required)

commentDto - **Note:** Only the `message` and `processInstanceId` properties will be used. Every other property passed to this endpoint will be ignored. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createComment

public CommentDto createComment(String id,
                                CommentDto commentDto)
                         throws ApiException

Creates a comment for a task by id.

Parameters:

id - The id of the task to add the comment to. (required)

commentDto - **Note:** Only the `message` and `processInstanceId` properties will be used. Every other property passed to this endpoint will be ignored. (optional)

Returns:

CommentDto

Throws:

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

createCommentWithHttpInfo

public ApiResponse<CommentDto> createCommentWithHttpInfo(String id,
                                                         CommentDto commentDto)
                                                  throws ApiException

Creates a comment for a task by id.

Parameters:

id - The id of the task to add the comment to. (required)

commentDto - **Note:** Only the `message` and `processInstanceId` properties will be used. Every other property passed to this endpoint will be ignored. (optional)

Returns:

ApiResponse<CommentDto>

Throws:

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

createCommentAsync

public okhttp3.Call createCommentAsync(String id,
                                       CommentDto commentDto,
                                       ApiCallback<CommentDto> _callback)
                                throws ApiException

(asynchronously) Creates a comment for a task by id.

Parameters:

id - The id of the task to add the comment to. (required)

commentDto - **Note:** Only the `message` and `processInstanceId` properties will be used. Every other property passed to this endpoint will be ignored. (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

getCommentCall

public okhttp3.Call getCommentCall(String id,
                                   String commentId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getComment

Parameters:

id - The id of the task. (required)

commentId - The id of the comment to be retrieved. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getComment

public CommentDto getComment(String id,
                             String commentId)
                      throws ApiException

Retrieves a task comment by task id and comment id.

Parameters:

id - The id of the task. (required)

commentId - The id of the comment to be retrieved. (required)

Returns:

CommentDto

Throws:

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

getCommentWithHttpInfo

public ApiResponse<CommentDto> getCommentWithHttpInfo(String id,
                                                      String commentId)
                                               throws ApiException

Retrieves a task comment by task id and comment id.

Parameters:

id - The id of the task. (required)

commentId - The id of the comment to be retrieved. (required)

Returns:

ApiResponse<CommentDto>

Throws:

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

getCommentAsync

public okhttp3.Call getCommentAsync(String id,
                                    String commentId,
                                    ApiCallback<CommentDto> _callback)
                             throws ApiException

(asynchronously) Retrieves a task comment by task id and comment id.

Parameters:

id - The id of the task. (required)

commentId - The id of the comment to be retrieved. (required)

_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

getCommentsCall

public okhttp3.Call getCommentsCall(String id,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getComments

Parameters:

id - The id of the task to retrieve the comments for. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getComments

public List<CommentDto> getComments(String id)
                             throws ApiException

Gets the comments for a task by id.

Parameters:

id - The id of the task to retrieve the comments for. (required)

Returns:

List<CommentDto>

Throws:

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

getCommentsWithHttpInfo

public ApiResponse<List<CommentDto>> getCommentsWithHttpInfo(String id)
                                                      throws ApiException

Gets the comments for a task by id.

Parameters:

id - The id of the task to retrieve the comments for. (required)

Returns:

ApiResponse<List<CommentDto>>

Throws:

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

getCommentsAsync

public okhttp3.Call getCommentsAsync(String id,
                                     ApiCallback<List<CommentDto>> _callback)
                              throws ApiException

(asynchronously) Gets the comments for a task by id.

Parameters:

id - The id of the task to retrieve the comments for. (required)

_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