com.box.sdk

Class BoxZip

Object

BoxZip

public class BoxZip
extends Object

Provides methods to allow users to download multiple files and folders as a single zip file. Users can download up to either 32GB or 10,000 files in one batch (whichever limitation is hit first) as a single zip file.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ZIP_URL_TEMPLATE Zip URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxZip(BoxAPIConnection api) Constructs a Zip to be used by everything.

Method Summary

Modifier and Type	Method and Description
BoxZipInfo	create(String name, List<BoxZipItem> items) Creates a zip of multiple files and folders.
BoxZipDownloadStatus	download(String name, List<BoxZipItem> items, OutputStream output) Creates a zip and downloads it to a given OutputStream.
BoxZipDownloadStatus	download(String name, List<BoxZipItem> items, OutputStream output, ProgressListener listener) Creates a zip and downloads its contents its to a given OutputStream.
BoxAPIConnection	getAPI() Gets the API connection used by this resource.

Methods inherited from class Object

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

Field Detail

ZIP_URL_TEMPLATE

public static final URLTemplate ZIP_URL_TEMPLATE

Zip URL Template.

Constructor Detail

BoxZip

public BoxZip(BoxAPIConnection api)

Constructs a Zip to be used by everything.

Parameters:

api - the API connection to be used by the Zip.

Method Detail

create

public BoxZipInfo create(String name,
                         List<BoxZipItem> items)

Creates a zip of multiple files and folders.

Parameters:

name - the name of the zip file to be created

items - list of files or folders to be part of the created zip

Returns:

information about the created zip file

download

public BoxZipDownloadStatus download(String name,
                                     List<BoxZipItem> items,
                                     OutputStream output)

Creates a zip and downloads it to a given OutputStream.

Parameters:

name - the name of the zip file to be created

items - list of files or folders to be part of the created zip

output - the stream to where the zip file will be written.

Returns:

information about status of the download

download

public BoxZipDownloadStatus download(String name,
                                     List<BoxZipItem> items,
                                     OutputStream output,
                                     ProgressListener listener)

Creates a zip and downloads its contents its to a given OutputStream.

Parameters:

name - the name of the zip file to be created

items - list of files or folders to be part of the created zip

output - the stream to where the zip file will be written.

listener - a listener for monitoring the download's progress.

Returns:

information about status of the download

getAPI

public BoxAPIConnection getAPI()

Gets the API connection used by this resource.

Returns:

the API connection used by this resource.