Class TaskAttachmentApi


  • public class TaskAttachmentApi
    extends Object
    • Constructor Detail

      • TaskAttachmentApi

        public TaskAttachmentApi()
      • TaskAttachmentApi

        public TaskAttachmentApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • addAttachmentCall

        public okhttp3.Call addAttachmentCall​(String id,
                                              String attachmentName,
                                              String attachmentDescription,
                                              String attachmentType,
                                              String url,
                                              File content,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for addAttachment
        Parameters:
        id - The id of the task to add the attachment to. (required)
        attachmentName - The name of the attachment. (optional)
        attachmentDescription - The description of the attachment. (optional)
        attachmentType - The type of the attachment. (optional)
        url - The url to the remote content of the attachment. (optional)
        content - The content of the attachment. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • addAttachment

        public AttachmentDto addAttachment​(String id,
                                           String attachmentName,
                                           String attachmentDescription,
                                           String attachmentType,
                                           String url,
                                           File content)
                                    throws ApiException
        Create Creates an attachment for a task.
        Parameters:
        id - The id of the task to add the attachment to. (required)
        attachmentName - The name of the attachment. (optional)
        attachmentDescription - The description of the attachment. (optional)
        attachmentType - The type of the attachment. (optional)
        url - The url to the remote content of the attachment. (optional)
        content - The content of the attachment. (optional)
        Returns:
        AttachmentDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • addAttachmentWithHttpInfo

        public ApiResponse<AttachmentDto> addAttachmentWithHttpInfo​(String id,
                                                                    String attachmentName,
                                                                    String attachmentDescription,
                                                                    String attachmentType,
                                                                    String url,
                                                                    File content)
                                                             throws ApiException
        Create Creates an attachment for a task.
        Parameters:
        id - The id of the task to add the attachment to. (required)
        attachmentName - The name of the attachment. (optional)
        attachmentDescription - The description of the attachment. (optional)
        attachmentType - The type of the attachment. (optional)
        url - The url to the remote content of the attachment. (optional)
        content - The content of the attachment. (optional)
        Returns:
        ApiResponse<AttachmentDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • addAttachmentAsync

        public okhttp3.Call addAttachmentAsync​(String id,
                                               String attachmentName,
                                               String attachmentDescription,
                                               String attachmentType,
                                               String url,
                                               File content,
                                               ApiCallback<AttachmentDto> _callback)
                                        throws ApiException
        Create (asynchronously) Creates an attachment for a task.
        Parameters:
        id - The id of the task to add the attachment to. (required)
        attachmentName - The name of the attachment. (optional)
        attachmentDescription - The description of the attachment. (optional)
        attachmentType - The type of the attachment. (optional)
        url - The url to the remote content of the attachment. (optional)
        content - The content of the attachment. (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
      • deleteAttachmentCall

        public okhttp3.Call deleteAttachmentCall​(String id,
                                                 String attachmentId,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for deleteAttachment
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be removed. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • deleteAttachment

        public void deleteAttachment​(String id,
                                     String attachmentId)
                              throws ApiException
        Delete Removes an attachment from a task by id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be removed. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteAttachmentWithHttpInfo

        public ApiResponse<Void> deleteAttachmentWithHttpInfo​(String id,
                                                              String attachmentId)
                                                       throws ApiException
        Delete Removes an attachment from a task by id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be removed. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteAttachmentAsync

        public okhttp3.Call deleteAttachmentAsync​(String id,
                                                  String attachmentId,
                                                  ApiCallback<Void> _callback)
                                           throws ApiException
        Delete (asynchronously) Removes an attachment from a task by id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be removed. (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
      • getAttachmentCall

        public okhttp3.Call getAttachmentCall​(String id,
                                              String attachmentId,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for getAttachment
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getAttachment

        public AttachmentDto getAttachment​(String id,
                                           String attachmentId)
                                    throws ApiException
        Get Retrieves a task attachment by task id and attachment id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be retrieved. (required)
        Returns:
        AttachmentDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getAttachmentWithHttpInfo

        public ApiResponse<AttachmentDto> getAttachmentWithHttpInfo​(String id,
                                                                    String attachmentId)
                                                             throws ApiException
        Get Retrieves a task attachment by task id and attachment id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be retrieved. (required)
        Returns:
        ApiResponse<AttachmentDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getAttachmentAsync

        public okhttp3.Call getAttachmentAsync​(String id,
                                               String attachmentId,
                                               ApiCallback<AttachmentDto> _callback)
                                        throws ApiException
        Get (asynchronously) Retrieves a task attachment by task id and attachment id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment 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
      • getAttachmentDataCall

        public okhttp3.Call getAttachmentDataCall​(String id,
                                                  String attachmentId,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for getAttachmentData
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getAttachmentData

        public File getAttachmentData​(String id,
                                      String attachmentId)
                               throws ApiException
        Get (Binary) Retrieves the binary content of a task attachment by task id and attachment id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be retrieved. (required)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getAttachmentDataWithHttpInfo

        public ApiResponse<File> getAttachmentDataWithHttpInfo​(String id,
                                                               String attachmentId)
                                                        throws ApiException
        Get (Binary) Retrieves the binary content of a task attachment by task id and attachment id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment to be retrieved. (required)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getAttachmentDataAsync

        public okhttp3.Call getAttachmentDataAsync​(String id,
                                                   String attachmentId,
                                                   ApiCallback<File> _callback)
                                            throws ApiException
        Get (Binary) (asynchronously) Retrieves the binary content of a task attachment by task id and attachment id.
        Parameters:
        id - The id of the task. (required)
        attachmentId - The id of the attachment 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
      • getAttachmentsCall

        public okhttp3.Call getAttachmentsCall​(String id,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for getAttachments
        Parameters:
        id - The id of the task to retrieve the attachments for. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getAttachments

        public List<AttachmentDto> getAttachments​(String id)
                                           throws ApiException
        Get List Gets the attachments for a task.
        Parameters:
        id - The id of the task to retrieve the attachments for. (required)
        Returns:
        List<AttachmentDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getAttachmentsWithHttpInfo

        public ApiResponse<List<AttachmentDto>> getAttachmentsWithHttpInfo​(String id)
                                                                    throws ApiException
        Get List Gets the attachments for a task.
        Parameters:
        id - The id of the task to retrieve the attachments for. (required)
        Returns:
        ApiResponse<List<AttachmentDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getAttachmentsAsync

        public okhttp3.Call getAttachmentsAsync​(String id,
                                                ApiCallback<List<AttachmentDto>> _callback)
                                         throws ApiException
        Get List (asynchronously) Gets the attachments for a task.
        Parameters:
        id - The id of the task to retrieve the attachments 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