com.box.sdkgen.managers.fileversions

Class FileVersionsManager

Object

FileVersionsManager

public class FileVersionsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileVersionsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deleteFileVersionById(String fileId, String fileVersionId) Move a file version to the trash.
void	deleteFileVersionById(String fileId, String fileVersionId, DeleteFileVersionByIdHeaders headers) Move a file version to the trash.
Authentication	getAuth()
FileVersionFull	getFileVersionById(String fileId, String fileVersionId) Retrieve a specific version of a file.
FileVersionFull	getFileVersionById(String fileId, String fileVersionId, GetFileVersionByIdHeaders headers) Retrieve a specific version of a file.
FileVersionFull	getFileVersionById(String fileId, String fileVersionId, GetFileVersionByIdQueryParams queryParams) Retrieve a specific version of a file.
FileVersionFull	getFileVersionById(String fileId, String fileVersionId, GetFileVersionByIdQueryParams queryParams, GetFileVersionByIdHeaders headers) Retrieve a specific version of a file.
FileVersions	getFileVersions(String fileId) Retrieve a list of the past versions for a file.
FileVersions	getFileVersions(String fileId, GetFileVersionsHeaders headers) Retrieve a list of the past versions for a file.
FileVersions	getFileVersions(String fileId, GetFileVersionsQueryParams queryParams) Retrieve a list of the past versions for a file.
FileVersions	getFileVersions(String fileId, GetFileVersionsQueryParams queryParams, GetFileVersionsHeaders headers) Retrieve a list of the past versions for a file.
NetworkSession	getNetworkSession()
FileVersionFull	promoteFileVersion(String fileId) Promote a specific version of a file.
FileVersionFull	promoteFileVersion(String fileId, PromoteFileVersionHeaders headers) Promote a specific version of a file.
FileVersionFull	promoteFileVersion(String fileId, PromoteFileVersionQueryParams queryParams) Promote a specific version of a file.
FileVersionFull	promoteFileVersion(String fileId, PromoteFileVersionQueryParams queryParams, PromoteFileVersionHeaders headers) Promote a specific version of a file.
FileVersionFull	promoteFileVersion(String fileId, PromoteFileVersionRequestBody requestBody) Promote a specific version of a file.
FileVersionFull	promoteFileVersion(String fileId, PromoteFileVersionRequestBody requestBody, PromoteFileVersionHeaders headers) Promote a specific version of a file.
FileVersionFull	promoteFileVersion(String fileId, PromoteFileVersionRequestBody requestBody, PromoteFileVersionQueryParams queryParams) Promote a specific version of a file.
FileVersionFull	promoteFileVersion(String fileId, PromoteFileVersionRequestBody requestBody, PromoteFileVersionQueryParams queryParams, PromoteFileVersionHeaders headers) Promote a specific version of a file.
FileVersionFull	updateFileVersionById(String fileId, String fileVersionId) Restores a specific version of a file after it was deleted.
FileVersionFull	updateFileVersionById(String fileId, String fileVersionId, UpdateFileVersionByIdHeaders headers) Restores a specific version of a file after it was deleted.
FileVersionFull	updateFileVersionById(String fileId, String fileVersionId, UpdateFileVersionByIdRequestBody requestBody) Restores a specific version of a file after it was deleted.
FileVersionFull	updateFileVersionById(String fileId, String fileVersionId, UpdateFileVersionByIdRequestBody requestBody, UpdateFileVersionByIdHeaders headers) Restores a specific version of a file after it was deleted.

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

FileVersionsManager

public FileVersionsManager()

FileVersionsManager

protected FileVersionsManager(FileVersionsManager.Builder builder)

Method Detail

getFileVersions

public FileVersions getFileVersions(String fileId)

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.

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"

getFileVersions

public FileVersions getFileVersions(String fileId,
                                    GetFileVersionsQueryParams queryParams)

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.

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

getFileVersions

public FileVersions getFileVersions(String fileId,
                                    GetFileVersionsHeaders headers)

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.

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

getFileVersions

public FileVersions getFileVersions(String fileId,
                                    GetFileVersionsQueryParams queryParams,
                                    GetFileVersionsHeaders headers)

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.

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

headers - Headers of getFileVersions method

getFileVersionById

public FileVersionFull getFileVersionById(String fileId,
                                          String fileVersionId)

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

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"

fileVersionId - The ID of the file version. Example: "1234"

getFileVersionById

public FileVersionFull getFileVersionById(String fileId,
                                          String fileVersionId,
                                          GetFileVersionByIdQueryParams queryParams)

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

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"

fileVersionId - The ID of the file version. Example: "1234"

queryParams - Query parameters of getFileVersionById method

getFileVersionById

public FileVersionFull getFileVersionById(String fileId,
                                          String fileVersionId,
                                          GetFileVersionByIdHeaders headers)

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

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"

fileVersionId - The ID of the file version. Example: "1234"

headers - Headers of getFileVersionById method

getFileVersionById

public FileVersionFull getFileVersionById(String fileId,
                                          String fileVersionId,
                                          GetFileVersionByIdQueryParams queryParams,
                                          GetFileVersionByIdHeaders headers)

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

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"

fileVersionId - The ID of the file version. Example: "1234"

queryParams - Query parameters of getFileVersionById method

headers - Headers of getFileVersionById method

deleteFileVersionById

public void deleteFileVersionById(String fileId,
                                  String fileVersionId)

Move a file version to the trash.

Versions are only tracked for Box users with premium accounts.

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"

fileVersionId - The ID of the file version. Example: "1234"

deleteFileVersionById

public void deleteFileVersionById(String fileId,
                                  String fileVersionId,
                                  DeleteFileVersionByIdHeaders headers)

Move a file version to the trash.

Versions are only tracked for Box users with premium accounts.

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"

fileVersionId - The ID of the file version. Example: "1234"

headers - Headers of deleteFileVersionById method

updateFileVersionById

public FileVersionFull updateFileVersionById(String fileId,
                                             String fileVersionId)

Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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"

fileVersionId - The ID of the file version. Example: "1234"

updateFileVersionById

public FileVersionFull updateFileVersionById(String fileId,
                                             String fileVersionId,
                                             UpdateFileVersionByIdRequestBody requestBody)

Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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"

fileVersionId - The ID of the file version. Example: "1234"

requestBody - Request body of updateFileVersionById method

updateFileVersionById

public FileVersionFull updateFileVersionById(String fileId,
                                             String fileVersionId,
                                             UpdateFileVersionByIdHeaders headers)

Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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"

fileVersionId - The ID of the file version. Example: "1234"

headers - Headers of updateFileVersionById method

updateFileVersionById

public FileVersionFull updateFileVersionById(String fileId,
                                             String fileVersionId,
                                             UpdateFileVersionByIdRequestBody requestBody,
                                             UpdateFileVersionByIdHeaders headers)

Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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"

fileVersionId - The ID of the file version. Example: "1234"

requestBody - Request body of updateFileVersionById method

headers - Headers of updateFileVersionById method

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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"

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId,
                                          PromoteFileVersionRequestBody requestBody)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId,
                                          PromoteFileVersionQueryParams queryParams)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId,
                                          PromoteFileVersionRequestBody requestBody,
                                          PromoteFileVersionQueryParams queryParams)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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

queryParams - Query parameters of promoteFileVersion method

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId,
                                          PromoteFileVersionHeaders headers)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId,
                                          PromoteFileVersionRequestBody requestBody,
                                          PromoteFileVersionHeaders headers)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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

headers - Headers of promoteFileVersion method

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId,
                                          PromoteFileVersionQueryParams queryParams,
                                          PromoteFileVersionHeaders headers)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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

headers - Headers of promoteFileVersion method

promoteFileVersion

public FileVersionFull promoteFileVersion(String fileId,
                                          PromoteFileVersionRequestBody requestBody,
                                          PromoteFileVersionQueryParams queryParams,
                                          PromoteFileVersionHeaders headers)

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

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

queryParams - Query parameters of promoteFileVersion method

headers - Headers of promoteFileVersion method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()