com.box.sdkgen.managers.folderlocks

Class FolderLocksManager

Object

FolderLocksManager

public class FolderLocksManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderLocksManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FolderLock	createFolderLock(CreateFolderLockRequestBody requestBody) Creates a folder lock on a folder, preventing it from being moved and/or deleted.
FolderLock	createFolderLock(CreateFolderLockRequestBody requestBody, CreateFolderLockHeaders headers) Creates a folder lock on a folder, preventing it from being moved and/or deleted.
void	deleteFolderLockById(String folderLockId) Deletes a folder lock on a given folder.
void	deleteFolderLockById(String folderLockId, DeleteFolderLockByIdHeaders headers) Deletes a folder lock on a given folder.
Authentication	getAuth()
FolderLocks	getFolderLocks(GetFolderLocksQueryParams queryParams) Retrieves folder lock details for a given folder.
FolderLocks	getFolderLocks(GetFolderLocksQueryParams queryParams, GetFolderLocksHeaders headers) Retrieves folder lock details for a given folder.
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

FolderLocksManager

public FolderLocksManager()

FolderLocksManager

protected FolderLocksManager(FolderLocksManager.Builder builder)

Method Detail

getFolderLocks

public FolderLocks getFolderLocks(GetFolderLocksQueryParams queryParams)

Retrieves folder lock details for a given folder.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Parameters:

queryParams - Query parameters of getFolderLocks method

getFolderLocks

public FolderLocks getFolderLocks(GetFolderLocksQueryParams queryParams,
                                  GetFolderLocksHeaders headers)

Retrieves folder lock details for a given folder.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Parameters:

queryParams - Query parameters of getFolderLocks method

headers - Headers of getFolderLocks method

createFolderLock

public FolderLock createFolderLock(CreateFolderLockRequestBody requestBody)

Creates a folder lock on a folder, preventing it from being moved and/or deleted.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Parameters:

requestBody - Request body of createFolderLock method

createFolderLock

public FolderLock createFolderLock(CreateFolderLockRequestBody requestBody,
                                   CreateFolderLockHeaders headers)

Creates a folder lock on a folder, preventing it from being moved and/or deleted.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Parameters:

requestBody - Request body of createFolderLock method

headers - Headers of createFolderLock method

deleteFolderLockById

public void deleteFolderLockById(String folderLockId)

Deletes a folder lock on a given folder.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Parameters:

folderLockId - The ID of the folder lock. Example: "12345"

deleteFolderLockById

public void deleteFolderLockById(String folderLockId,
                                 DeleteFolderLockByIdHeaders headers)

Deletes a folder lock on a given folder.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Parameters:

folderLockId - The ID of the folder lock. Example: "12345"

headers - Headers of deleteFolderLockById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()