com.box.sdkgen.managers.downloads

Class DownloadsManager

Object

DownloadsManager

public class DownloadsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	DownloadsManager()
protected	DownloadsManager(DownloadsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
InputStream	downloadFile(String fileId) Returns the contents of a file in binary format.
InputStream	downloadFile(String fileId, DownloadFileHeaders headers) Returns the contents of a file in binary format.
InputStream	downloadFile(String fileId, DownloadFileQueryParams queryParams) Returns the contents of a file in binary format.
InputStream	downloadFile(String fileId, DownloadFileQueryParams queryParams, DownloadFileHeaders headers) Returns the contents of a file in binary format.
void	downloadFileToOutputStream(String fileId, OutputStream outputStream)
void	downloadFileToOutputStream(String fileId, OutputStream outputStream, DownloadFileToOutputStreamHeaders headers)
void	downloadFileToOutputStream(String fileId, OutputStream outputStream, DownloadFileToOutputStreamQueryParams queryParams)
void	downloadFileToOutputStream(String fileId, OutputStream outputStream, DownloadFileToOutputStreamQueryParams queryParams, DownloadFileToOutputStreamHeaders headers)
Authentication	getAuth()
String	getDownloadFileUrl(String fileId) Returns the contents of a file in binary format.
String	getDownloadFileUrl(String fileId, GetDownloadFileUrlHeaders headers) Returns the contents of a file in binary format.
String	getDownloadFileUrl(String fileId, GetDownloadFileUrlQueryParams queryParams) Returns the contents of a file in binary format.
String	getDownloadFileUrl(String fileId, GetDownloadFileUrlQueryParams queryParams, GetDownloadFileUrlHeaders headers) Returns the contents of a file in binary format.
NetworkSession	getNetworkSession()

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

DownloadsManager

public DownloadsManager()

DownloadsManager

protected DownloadsManager(DownloadsManager.Builder builder)

Method Detail

getDownloadFileUrl

public String getDownloadFileUrl(String fileId)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

getDownloadFileUrl

public String getDownloadFileUrl(String fileId,
                                 GetDownloadFileUrlQueryParams queryParams)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

queryParams - Query parameters of downloadFile method

getDownloadFileUrl

public String getDownloadFileUrl(String fileId,
                                 GetDownloadFileUrlHeaders headers)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

headers - Headers of downloadFile method

getDownloadFileUrl

public String getDownloadFileUrl(String fileId,
                                 GetDownloadFileUrlQueryParams queryParams,
                                 GetDownloadFileUrlHeaders headers)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

queryParams - Query parameters of downloadFile method

headers - Headers of downloadFile method

downloadFile

public InputStream downloadFile(String fileId)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

downloadFile

public InputStream downloadFile(String fileId,
                                DownloadFileQueryParams queryParams)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

queryParams - Query parameters of downloadFile method

downloadFile

public InputStream downloadFile(String fileId,
                                DownloadFileHeaders headers)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

headers - Headers of downloadFile method

downloadFile

public InputStream downloadFile(String fileId,
                                DownloadFileQueryParams queryParams,
                                DownloadFileHeaders headers)

Returns the contents of a file in binary format.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

queryParams - Query parameters of downloadFile method

headers - Headers of downloadFile method

downloadFileToOutputStream

public void downloadFileToOutputStream(String fileId,
                                       OutputStream outputStream)

downloadFileToOutputStream

public void downloadFileToOutputStream(String fileId,
                                       OutputStream outputStream,
                                       DownloadFileToOutputStreamQueryParams queryParams)

downloadFileToOutputStream

public void downloadFileToOutputStream(String fileId,
                                       OutputStream outputStream,
                                       DownloadFileToOutputStreamHeaders headers)

downloadFileToOutputStream

public void downloadFileToOutputStream(String fileId,
                                       OutputStream outputStream,
                                       DownloadFileToOutputStreamQueryParams queryParams,
                                       DownloadFileToOutputStreamHeaders headers)

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()