com.box.boxjavalibv2.requests

Class DownloadFileRequest

java.lang.Object

com.box.restclientv2.requestsbase.DefaultBoxRequest

com.box.boxjavalibv2.requests.DownloadFileRequest

All Implemented Interfaces:

IBoxRequest

public class DownloadFileRequest
extends DefaultBoxRequest

Request to download a file.

Constructor Summary

Constructors

Constructor and Description
DownloadFileRequest(IBoxConfig config, IBoxJSONParser parser, java.lang.String fileId, BoxDefaultRequestObject requestObject) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAuthority() Get authority for the api call.
java.lang.String	getScheme() Get scheme for the api call.
static java.lang.String	getUri(java.lang.String fileId) Get uri.

Methods inherited from class com.box.restclientv2.requestsbase.DefaultBoxRequest

addHeader, addHttpParam, addQueryParam, getApiUrlPath, getAuth, getConfig, getCookie, getExpectedResponseCode, getHeaders, getHttpParams, getQueryParams, getRawRequest, getRequestEntity, getRestMethod, prepareRequest, setAuth, setCookie, setEntity, setExpectedResponseCode, setIfMatch, setRequestFields

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadFileRequest

public DownloadFileRequest(IBoxConfig config,
                   IBoxJSONParser parser,
                   java.lang.String fileId,
                   BoxDefaultRequestObject requestObject)
                    throws BoxRestException

Constructor.

Parameters:

config - config

parser - json parser

fileId - id of the file to be downloaded

requestObject - request object

Throws:

BoxRestException - exception

Method Detail

getUri

public static java.lang.String getUri(java.lang.String fileId)

Get uri.

Parameters:

fileId - id of file

Returns:

uri

getScheme

public java.lang.String getScheme()

Description copied from interface: IBoxRequest

Get scheme for the api call.

Specified by:

getScheme in interface IBoxRequest

Overrides:

getScheme in class DefaultBoxRequest

getAuthority

public java.lang.String getAuthority()

Description copied from interface: IBoxRequest

Get authority for the api call.

Specified by:

getAuthority in interface IBoxRequest

Overrides:

getAuthority in class DefaultBoxRequest