com.box.sdkgen.managers.fileversionretentions

Class FileVersionRetentionsManager

Object

FileVersionRetentionsManager

public class FileVersionRetentionsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileVersionRetentionsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Authentication	getAuth()
FileVersionRetention	getFileVersionRetentionById(String fileVersionRetentionId) Returns information about a file version retention.
FileVersionRetention	getFileVersionRetentionById(String fileVersionRetentionId, GetFileVersionRetentionByIdHeaders headers) Returns information about a file version retention.
FileVersionRetentions	getFileVersionRetentions() Retrieves all file version retentions for the given enterprise.
FileVersionRetentions	getFileVersionRetentions(GetFileVersionRetentionsHeaders headers) Retrieves all file version retentions for the given enterprise.
FileVersionRetentions	getFileVersionRetentions(GetFileVersionRetentionsQueryParams queryParams) Retrieves all file version retentions for the given enterprise.
FileVersionRetentions	getFileVersionRetentions(GetFileVersionRetentionsQueryParams queryParams, GetFileVersionRetentionsHeaders headers) Retrieves all file version retentions for the given enterprise.
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

FileVersionRetentionsManager

public FileVersionRetentionsManager()

FileVersionRetentionsManager

protected FileVersionRetentionsManager(FileVersionRetentionsManager.Builder builder)

Method Detail

getFileVersionRetentions

public FileVersionRetentions getFileVersionRetentions()

Retrieves all file version retentions for the given enterprise.

**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

getFileVersionRetentions

public FileVersionRetentions getFileVersionRetentions(GetFileVersionRetentionsQueryParams queryParams)

Retrieves all file version retentions for the given enterprise.

**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Parameters:

queryParams - Query parameters of getFileVersionRetentions method

getFileVersionRetentions

public FileVersionRetentions getFileVersionRetentions(GetFileVersionRetentionsHeaders headers)

Retrieves all file version retentions for the given enterprise.

**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Parameters:

headers - Headers of getFileVersionRetentions method

getFileVersionRetentions

public FileVersionRetentions getFileVersionRetentions(GetFileVersionRetentionsQueryParams queryParams,
                                                      GetFileVersionRetentionsHeaders headers)

Retrieves all file version retentions for the given enterprise.

**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Parameters:

queryParams - Query parameters of getFileVersionRetentions method

headers - Headers of getFileVersionRetentions method

getFileVersionRetentionById

public FileVersionRetention getFileVersionRetentionById(String fileVersionRetentionId)

Returns information about a file version retention.

**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Parameters:

fileVersionRetentionId - The ID of the file version retention. Example: "3424234"

getFileVersionRetentionById

public FileVersionRetention getFileVersionRetentionById(String fileVersionRetentionId,
                                                        GetFileVersionRetentionByIdHeaders headers)

Returns information about a file version retention.

**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Parameters:

fileVersionRetentionId - The ID of the file version retention. Example: "3424234"

headers - Headers of getFileVersionRetentionById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()