com.box.sdkgen.managers.filewatermarks

Class FileWatermarksManager

Object

FileWatermarksManager

public class FileWatermarksManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileWatermarksManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deleteFileWatermark(String fileId) Removes the watermark from a file.
void	deleteFileWatermark(String fileId, DeleteFileWatermarkHeaders headers) Removes the watermark from a file.
Authentication	getAuth()
Watermark	getFileWatermark(String fileId) Retrieve the watermark for a file.
Watermark	getFileWatermark(String fileId, GetFileWatermarkHeaders headers) Retrieve the watermark for a file.
NetworkSession	getNetworkSession()
Watermark	updateFileWatermark(String fileId, UpdateFileWatermarkRequestBody requestBody) Applies or update a watermark on a file.
Watermark	updateFileWatermark(String fileId, UpdateFileWatermarkRequestBody requestBody, UpdateFileWatermarkHeaders headers) Applies or update a watermark on a file.

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

FileWatermarksManager

public FileWatermarksManager()

FileWatermarksManager

protected FileWatermarksManager(FileWatermarksManager.Builder builder)

Method Detail

getFileWatermark

public Watermark getFileWatermark(String fileId)

Retrieve the watermark for a file.

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"

getFileWatermark

public Watermark getFileWatermark(String fileId,
                                  GetFileWatermarkHeaders headers)

Retrieve the watermark for a file.

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

updateFileWatermark

public Watermark updateFileWatermark(String fileId,
                                     UpdateFileWatermarkRequestBody requestBody)

Applies or update a watermark on a file.

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

updateFileWatermark

public Watermark updateFileWatermark(String fileId,
                                     UpdateFileWatermarkRequestBody requestBody,
                                     UpdateFileWatermarkHeaders headers)

Applies or update a watermark on a file.

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

headers - Headers of updateFileWatermark method

deleteFileWatermark

public void deleteFileWatermark(String fileId)

Removes the watermark from a file.

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"

deleteFileWatermark

public void deleteFileWatermark(String fileId,
                                DeleteFileWatermarkHeaders headers)

Removes the watermark from a file.

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

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()