com.box.sdkgen.managers.files

Class FilesManager

Object

FilesManager

public class FilesManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilesManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FileFull	copyFile(String fileId, CopyFileRequestBody requestBody) Creates a copy of a file.
FileFull	copyFile(String fileId, CopyFileRequestBody requestBody, CopyFileHeaders headers) Creates a copy of a file.
FileFull	copyFile(String fileId, CopyFileRequestBody requestBody, CopyFileQueryParams queryParams) Creates a copy of a file.
FileFull	copyFile(String fileId, CopyFileRequestBody requestBody, CopyFileQueryParams queryParams, CopyFileHeaders headers) Creates a copy of a file.
void	deleteFileById(String fileId) Deletes a file, either permanently or by moving it to the trash.
void	deleteFileById(String fileId, DeleteFileByIdHeaders headers) Deletes a file, either permanently or by moving it to the trash.
Authentication	getAuth()
FileFull	getFileById(String fileId) Retrieves the details about a file.
FileFull	getFileById(String fileId, GetFileByIdHeaders headers) Retrieves the details about a file.
FileFull	getFileById(String fileId, GetFileByIdQueryParams queryParams) Retrieves the details about a file.
FileFull	getFileById(String fileId, GetFileByIdQueryParams queryParams, GetFileByIdHeaders headers) Retrieves the details about a file.
InputStream	getFileThumbnailById(String fileId, GetFileThumbnailByIdExtension extension) Retrieves a thumbnail, or smaller image representation, of a file.
InputStream	getFileThumbnailById(String fileId, GetFileThumbnailByIdExtension extension, GetFileThumbnailByIdHeaders headers) Retrieves a thumbnail, or smaller image representation, of a file.
InputStream	getFileThumbnailById(String fileId, GetFileThumbnailByIdExtension extension, GetFileThumbnailByIdQueryParams queryParams) Retrieves a thumbnail, or smaller image representation, of a file.
InputStream	getFileThumbnailById(String fileId, GetFileThumbnailByIdExtension extension, GetFileThumbnailByIdQueryParams queryParams, GetFileThumbnailByIdHeaders headers) Retrieves a thumbnail, or smaller image representation, of a file.
String	getFileThumbnailUrl(String fileId, GetFileThumbnailUrlExtension extension) Retrieves a thumbnail, or smaller image representation, of a file.
String	getFileThumbnailUrl(String fileId, GetFileThumbnailUrlExtension extension, GetFileThumbnailUrlHeaders headers) Retrieves a thumbnail, or smaller image representation, of a file.
String	getFileThumbnailUrl(String fileId, GetFileThumbnailUrlExtension extension, GetFileThumbnailUrlQueryParams queryParams) Retrieves a thumbnail, or smaller image representation, of a file.
String	getFileThumbnailUrl(String fileId, GetFileThumbnailUrlExtension extension, GetFileThumbnailUrlQueryParams queryParams, GetFileThumbnailUrlHeaders headers) Retrieves a thumbnail, or smaller image representation, of a file.
NetworkSession	getNetworkSession()
FileFull	updateFileById(String fileId) Updates a file.
FileFull	updateFileById(String fileId, UpdateFileByIdHeaders headers) Updates a file.
FileFull	updateFileById(String fileId, UpdateFileByIdQueryParams queryParams) Updates a file.
FileFull	updateFileById(String fileId, UpdateFileByIdQueryParams queryParams, UpdateFileByIdHeaders headers) Updates a file.
FileFull	updateFileById(String fileId, UpdateFileByIdRequestBody requestBody) Updates a file.
FileFull	updateFileById(String fileId, UpdateFileByIdRequestBody requestBody, UpdateFileByIdHeaders headers) Updates a file.
FileFull	updateFileById(String fileId, UpdateFileByIdRequestBody requestBody, UpdateFileByIdQueryParams queryParams) Updates a file.
FileFull	updateFileById(String fileId, UpdateFileByIdRequestBody requestBody, UpdateFileByIdQueryParams queryParams, UpdateFileByIdHeaders headers) Updates a file.

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

FilesManager

public FilesManager()

FilesManager

protected FilesManager(FilesManager.Builder builder)

Method Detail

getFileById

public FileFull getFileById(String fileId)

Retrieves the details about a file.

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"

getFileById

public FileFull getFileById(String fileId,
                            GetFileByIdQueryParams queryParams)

Retrieves the details about a file.

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 getFileById method

getFileById

public FileFull getFileById(String fileId,
                            GetFileByIdHeaders headers)

Retrieves the details about a file.

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 getFileById method

getFileById

public FileFull getFileById(String fileId,
                            GetFileByIdQueryParams queryParams,
                            GetFileByIdHeaders headers)

Retrieves the details about a file.

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 getFileById method

headers - Headers of getFileById method

updateFileById

public FileFull updateFileById(String fileId)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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"

updateFileById

public FileFull updateFileById(String fileId,
                               UpdateFileByIdRequestBody requestBody)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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"

requestBody - Request body of updateFileById method

updateFileById

public FileFull updateFileById(String fileId,
                               UpdateFileByIdQueryParams queryParams)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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 updateFileById method

updateFileById

public FileFull updateFileById(String fileId,
                               UpdateFileByIdRequestBody requestBody,
                               UpdateFileByIdQueryParams queryParams)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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"

requestBody - Request body of updateFileById method

queryParams - Query parameters of updateFileById method

updateFileById

public FileFull updateFileById(String fileId,
                               UpdateFileByIdHeaders headers)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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 updateFileById method

updateFileById

public FileFull updateFileById(String fileId,
                               UpdateFileByIdRequestBody requestBody,
                               UpdateFileByIdHeaders headers)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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"

requestBody - Request body of updateFileById method

headers - Headers of updateFileById method

updateFileById

public FileFull updateFileById(String fileId,
                               UpdateFileByIdQueryParams queryParams,
                               UpdateFileByIdHeaders headers)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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 updateFileById method

headers - Headers of updateFileById method

updateFileById

public FileFull updateFileById(String fileId,
                               UpdateFileByIdRequestBody requestBody,
                               UpdateFileByIdQueryParams queryParams,
                               UpdateFileByIdHeaders headers)

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

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"

requestBody - Request body of updateFileById method

queryParams - Query parameters of updateFileById method

headers - Headers of updateFileById method

deleteFileById

public void deleteFileById(String fileId)

Deletes a file, either permanently or by moving it to the trash.

The enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.

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"

deleteFileById

public void deleteFileById(String fileId,
                           DeleteFileByIdHeaders headers)

Deletes a file, either permanently or by moving it to the trash.

The enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.

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 deleteFileById method

copyFile

public FileFull copyFile(String fileId,
                         CopyFileRequestBody requestBody)

Creates a copy of a file.

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"

requestBody - Request body of copyFile method

copyFile

public FileFull copyFile(String fileId,
                         CopyFileRequestBody requestBody,
                         CopyFileQueryParams queryParams)

Creates a copy of a file.

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"

requestBody - Request body of copyFile method

queryParams - Query parameters of copyFile method

copyFile

public FileFull copyFile(String fileId,
                         CopyFileRequestBody requestBody,
                         CopyFileHeaders headers)

Creates a copy of a file.

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"

requestBody - Request body of copyFile method

headers - Headers of copyFile method

copyFile

public FileFull copyFile(String fileId,
                         CopyFileRequestBody requestBody,
                         CopyFileQueryParams queryParams,
                         CopyFileHeaders headers)

Creates a copy of a file.

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"

requestBody - Request body of copyFile method

queryParams - Query parameters of copyFile method

headers - Headers of copyFile method

getFileThumbnailUrl

public String getFileThumbnailUrl(String fileId,
                                  GetFileThumbnailUrlExtension extension)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

getFileThumbnailUrl

public String getFileThumbnailUrl(String fileId,
                                  GetFileThumbnailUrlExtension extension,
                                  GetFileThumbnailUrlQueryParams queryParams)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

queryParams - Query parameters of getFileThumbnailById method

getFileThumbnailUrl

public String getFileThumbnailUrl(String fileId,
                                  GetFileThumbnailUrlExtension extension,
                                  GetFileThumbnailUrlHeaders headers)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

headers - Headers of getFileThumbnailById method

getFileThumbnailUrl

public String getFileThumbnailUrl(String fileId,
                                  GetFileThumbnailUrlExtension extension,
                                  GetFileThumbnailUrlQueryParams queryParams,
                                  GetFileThumbnailUrlHeaders headers)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

queryParams - Query parameters of getFileThumbnailById method

headers - Headers of getFileThumbnailById method

getFileThumbnailById

public InputStream getFileThumbnailById(String fileId,
                                        GetFileThumbnailByIdExtension extension)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

getFileThumbnailById

public InputStream getFileThumbnailById(String fileId,
                                        GetFileThumbnailByIdExtension extension,
                                        GetFileThumbnailByIdQueryParams queryParams)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

queryParams - Query parameters of getFileThumbnailById method

getFileThumbnailById

public InputStream getFileThumbnailById(String fileId,
                                        GetFileThumbnailByIdExtension extension,
                                        GetFileThumbnailByIdHeaders headers)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

headers - Headers of getFileThumbnailById method

getFileThumbnailById

public InputStream getFileThumbnailById(String fileId,
                                        GetFileThumbnailByIdExtension extension,
                                        GetFileThumbnailByIdQueryParams queryParams,
                                        GetFileThumbnailByIdHeaders headers)

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed [found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

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"

extension - The file format for the thumbnail. Example: "png"

queryParams - Query parameters of getFileThumbnailById method

headers - Headers of getFileThumbnailById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()