Package com.mypurecloud.sdk.v2.api

Class DownloadsApi

java.lang.Object

com.mypurecloud.sdk.v2.api.DownloadsApi

public class DownloadsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DownloadsApi()
DownloadsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
UrlResponse	getDownload(GetDownloadRequest request)	Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content
ApiResponse<UrlResponse>	getDownload(ApiRequest<Void> request)	Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content
UrlResponse	getDownload(String downloadId, String contentDisposition, Boolean issueRedirect, Boolean redirectToAuth)	Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content
ApiResponse<UrlResponse>	getDownloadWithHttpInfo(String downloadId, String contentDisposition, Boolean issueRedirect, Boolean redirectToAuth)	Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content

Methods inherited from class java.lang.Object

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

Constructor Details

DownloadsApi

public DownloadsApi()

DownloadsApi

public DownloadsApi(ApiClient apiClient)

Method Details

getDownload

public UrlResponse getDownload(String downloadId,
 String contentDisposition,
 Boolean issueRedirect,
 Boolean redirectToAuth)
                        throws IOException,
ApiException

Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content

Parameters:

downloadId - Download ID (required)

contentDisposition - (optional)

issueRedirect - (optional, default to true)

redirectToAuth - (optional, default to true)

Returns:

UrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDownloadWithHttpInfo

public ApiResponse<UrlResponse> getDownloadWithHttpInfo(String downloadId,
 String contentDisposition,
 Boolean issueRedirect,
 Boolean redirectToAuth)
                                                 throws IOException

Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content

Parameters:

downloadId - Download ID (required)

contentDisposition - (optional)

issueRedirect - (optional, default to true)

redirectToAuth - (optional, default to true)

Returns:

UrlResponse

Throws:

IOException - if the request fails to be processed

getDownload

public UrlResponse getDownload(GetDownloadRequest request)
                        throws IOException,
ApiException

Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content

Parameters:

request - The request object

Returns:

UrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDownload

public ApiResponse<UrlResponse> getDownload(ApiRequest<Void> request)
                                     throws IOException

Issues a redirect to a signed secure download URL for specified download this method will issue a redirect to the url to the content

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed