public class FolderWatermarksManager extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
FolderWatermarksManager.Builder |
| Modifier and Type | Field and Description |
|---|---|
Authentication |
auth |
NetworkSession |
networkSession |
| Modifier | Constructor and Description |
|---|---|
|
FolderWatermarksManager() |
protected |
FolderWatermarksManager(FolderWatermarksManager.Builder builder) |
| 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.
|
public Authentication auth
public NetworkSession networkSession
public FolderWatermarksManager()
protected FolderWatermarksManager(FolderWatermarksManager.Builder builder)
public Watermark getFolderWatermark(String folderId)
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"
public Watermark getFolderWatermark(String folderId, GetFolderWatermarkHeaders headers)
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 methodpublic Watermark updateFolderWatermark(String folderId, UpdateFolderWatermarkRequestBody requestBody)
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 methodpublic Watermark updateFolderWatermark(String folderId, UpdateFolderWatermarkRequestBody requestBody, UpdateFolderWatermarkHeaders headers)
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 methodheaders - Headers of updateFolderWatermark methodpublic void deleteFolderWatermark(String folderId)
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"
public void deleteFolderWatermark(String folderId, DeleteFolderWatermarkHeaders headers)
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 methodpublic Authentication getAuth()
public NetworkSession getNetworkSession()