com.box.sdkgen.managers.folderwatermarks

Class FolderWatermarksManager

Object

FolderWatermarksManager

public class FolderWatermarksManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderWatermarksManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deleteFolderWatermark(String folderId) Removes the watermark from a folder.
void	deleteFolderWatermark(String folderId, DeleteFolderWatermarkHeaders headers) Removes the watermark from a folder.
Authentication	getAuth()
Watermark	getFolderWatermark(String folderId) Retrieve the watermark for a folder.
Watermark	getFolderWatermark(String folderId, GetFolderWatermarkHeaders headers) Retrieve the watermark for a folder.
NetworkSession	getNetworkSession()
Watermark	updateFolderWatermark(String folderId, UpdateFolderWatermarkRequestBody requestBody) Applies or update a watermark on a folder.
Watermark	updateFolderWatermark(String folderId, UpdateFolderWatermarkRequestBody requestBody, UpdateFolderWatermarkHeaders headers) Applies or update a watermark on a folder.

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

FolderWatermarksManager

public FolderWatermarksManager()

FolderWatermarksManager

protected FolderWatermarksManager(FolderWatermarksManager.Builder builder)

Method Detail

getFolderWatermark

public Watermark getFolderWatermark(String folderId)

Retrieve the watermark for a folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

getFolderWatermark

public Watermark getFolderWatermark(String folderId,
                                    GetFolderWatermarkHeaders headers)

Retrieve the watermark for a folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of getFolderWatermark method

updateFolderWatermark

public Watermark updateFolderWatermark(String folderId,
                                       UpdateFolderWatermarkRequestBody requestBody)

Applies or update a watermark on a folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of updateFolderWatermark method

updateFolderWatermark

public Watermark updateFolderWatermark(String folderId,
                                       UpdateFolderWatermarkRequestBody requestBody,
                                       UpdateFolderWatermarkHeaders headers)

Applies or update a watermark on a folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of updateFolderWatermark method

headers - Headers of updateFolderWatermark method

deleteFolderWatermark

public void deleteFolderWatermark(String folderId)

Removes the watermark from a folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

deleteFolderWatermark

public void deleteFolderWatermark(String folderId,
                                  DeleteFolderWatermarkHeaders headers)

Removes the watermark from a folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of deleteFolderWatermark method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()