io.qase.client.api

Class AttachmentsApi

java.lang.Object

io.qase.client.api.AttachmentsApi

public class AttachmentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AttachmentsApi()
AttachmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
HashResponse	deleteAttachment(String hash) Remove attachment by Hash.
okhttp3.Call	deleteAttachmentAsync(String hash, ApiCallback<HashResponse> _callback) Remove attachment by Hash.
okhttp3.Call	deleteAttachmentCall(String hash, ApiCallback _callback) Build call for deleteAttachment
ApiResponse<HashResponse>	deleteAttachmentWithHttpInfo(String hash) Remove attachment by Hash.
ApiClient	getApiClient()
AttachmentResponse	getAttachment(String hash) Get attachment by Hash.
okhttp3.Call	getAttachmentAsync(String hash, ApiCallback<AttachmentResponse> _callback) Get attachment by Hash.
okhttp3.Call	getAttachmentCall(String hash, ApiCallback _callback) Build call for getAttachment
AttachmentListResponse	getAttachments(Integer limit, Integer offset) Get all attachments.
okhttp3.Call	getAttachmentsAsync(Integer limit, Integer offset, ApiCallback<AttachmentListResponse> _callback) Get all attachments.
okhttp3.Call	getAttachmentsCall(Integer limit, Integer offset, ApiCallback _callback) Build call for getAttachments
ApiResponse<AttachmentListResponse>	getAttachmentsWithHttpInfo(Integer limit, Integer offset) Get all attachments.
ApiResponse<AttachmentResponse>	getAttachmentWithHttpInfo(String hash) Get attachment by Hash.
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
AttachmentUploadsResponse	uploadAttachment(String code, List<File> _file) Upload attachment.
okhttp3.Call	uploadAttachmentAsync(String code, List<File> _file, ApiCallback<AttachmentUploadsResponse> _callback) Upload attachment.
okhttp3.Call	uploadAttachmentCall(String code, List<File> _file, ApiCallback _callback) Build call for uploadAttachment
ApiResponse<AttachmentUploadsResponse>	uploadAttachmentWithHttpInfo(String code, List<File> _file) Upload attachment.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentsApi

public AttachmentsApi()

AttachmentsApi

public AttachmentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

deleteAttachmentCall

public okhttp3.Call deleteAttachmentCall(String hash,
                                         ApiCallback _callback)
                                  throws QaseException

Build call for deleteAttachment

Parameters:

hash - Hash. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

deleteAttachment

public HashResponse deleteAttachment(String hash)
                              throws QaseException

Remove attachment by Hash. This method allows to remove attachment by Hash.

Parameters:

hash - Hash. (required)

Returns:

HashResponse

Throws:

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

deleteAttachmentWithHttpInfo

public ApiResponse<HashResponse> deleteAttachmentWithHttpInfo(String hash)
                                                       throws QaseException

Remove attachment by Hash. This method allows to remove attachment by Hash.

Parameters:

hash - Hash. (required)

Returns:

ApiResponse<HashResponse>

Throws:

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

deleteAttachmentAsync

public okhttp3.Call deleteAttachmentAsync(String hash,
                                          ApiCallback<HashResponse> _callback)
                                   throws QaseException

Remove attachment by Hash. (asynchronously) This method allows to remove attachment by Hash.

Parameters:

hash - Hash. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

getAttachmentCall

public okhttp3.Call getAttachmentCall(String hash,
                                      ApiCallback _callback)
                               throws QaseException

Build call for getAttachment

Parameters:

hash - Hash. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getAttachment

public AttachmentResponse getAttachment(String hash)
                                 throws QaseException

Get attachment by Hash. This method allows to retrieve attachment by Hash.

Parameters:

hash - Hash. (required)

Returns:

AttachmentResponse

Throws:

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

getAttachmentWithHttpInfo

public ApiResponse<AttachmentResponse> getAttachmentWithHttpInfo(String hash)
                                                          throws QaseException

Get attachment by Hash. This method allows to retrieve attachment by Hash.

Parameters:

hash - Hash. (required)

Returns:

ApiResponse<AttachmentResponse>

Throws:

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

getAttachmentAsync

public okhttp3.Call getAttachmentAsync(String hash,
                                       ApiCallback<AttachmentResponse> _callback)
                                throws QaseException

Get attachment by Hash. (asynchronously) This method allows to retrieve attachment by Hash.

Parameters:

hash - Hash. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

getAttachmentsCall

public okhttp3.Call getAttachmentsCall(Integer limit,
                                       Integer offset,
                                       ApiCallback _callback)
                                throws QaseException

Build call for getAttachments

Parameters:

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getAttachments

public AttachmentListResponse getAttachments(Integer limit,
                                             Integer offset)
                                      throws QaseException

Get all attachments. This method allows to retrieve attachments.

Parameters:

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

AttachmentListResponse

Throws:

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

getAttachmentsWithHttpInfo

public ApiResponse<AttachmentListResponse> getAttachmentsWithHttpInfo(Integer limit,
                                                                      Integer offset)
                                                               throws QaseException

Get all attachments. This method allows to retrieve attachments.

Parameters:

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

ApiResponse<AttachmentListResponse>

Throws:

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

getAttachmentsAsync

public okhttp3.Call getAttachmentsAsync(Integer limit,
                                        Integer offset,
                                        ApiCallback<AttachmentListResponse> _callback)
                                 throws QaseException

Get all attachments. (asynchronously) This method allows to retrieve attachments.

Parameters:

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

uploadAttachmentCall

public okhttp3.Call uploadAttachmentCall(String code,
                                         List<File> _file,
                                         ApiCallback _callback)
                                  throws QaseException

Build call for uploadAttachment

Parameters:

code - Code of project, where to search entities. (required)

_file - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

uploadAttachment

public AttachmentUploadsResponse uploadAttachment(String code,
                                                  List<File> _file)
                                           throws QaseException

Upload attachment. This method allows to upload attachment to Qase. Max upload size: * Up to 32 Mb per file * Up to 128 Mb per single request * Up to 20 files per single request If there is no free space left in your team account, you will receive an error with code 507 - Insufficient Storage.

Parameters:

code - Code of project, where to search entities. (required)

_file - (optional)

Returns:

AttachmentUploadsResponse

Throws:

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

uploadAttachmentWithHttpInfo

public ApiResponse<AttachmentUploadsResponse> uploadAttachmentWithHttpInfo(String code,
                                                                           List<File> _file)
                                                                    throws QaseException

Upload attachment. This method allows to upload attachment to Qase. Max upload size: * Up to 32 Mb per file * Up to 128 Mb per single request * Up to 20 files per single request If there is no free space left in your team account, you will receive an error with code 507 - Insufficient Storage.

Parameters:

code - Code of project, where to search entities. (required)

_file - (optional)

Returns:

ApiResponse<AttachmentUploadsResponse>

Throws:

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

uploadAttachmentAsync

public okhttp3.Call uploadAttachmentAsync(String code,
                                          List<File> _file,
                                          ApiCallback<AttachmentUploadsResponse> _callback)
                                   throws QaseException

Upload attachment. (asynchronously) This method allows to upload attachment to Qase. Max upload size: * Up to 32 Mb per file * Up to 128 Mb per single request * Up to 20 files per single request If there is no free space left in your team account, you will receive an error with code 507 - Insufficient Storage.

Parameters:

code - Code of project, where to search entities. (required)

_file - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object