Skip to content

Files

Latest commit

box-sdk-buildbox-sdk-build
feat: Support tests in Java (box/box-codegen#580) (#30)
Oct 23, 2024
9c867c8 · Oct 23, 2024

History

History
100 lines (61 loc) · 3.46 KB

folderwatermarks.md

File metadata and controls

100 lines (61 loc) · 3.46 KB

FolderWatermarksManager

Get watermark for folder

Retrieve the watermark for a folder.

This operation is performed by calling function getFolderWatermark.

See the endpoint docs at API Reference.

client.getFolderWatermarks().getFolderWatermark(folder.getId())

Arguments

  • folderId String
    • 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 GetFolderWatermarkHeaders
    • Headers of getFolderWatermark method

Returns

This function returns a value of type Watermark.

Returns an object containing information about the watermark associated for to this folder.

Apply watermark to folder

Applies or update a watermark on a folder.

This operation is performed by calling function updateFolderWatermark.

See the endpoint docs at API Reference.

client.getFolderWatermarks().updateFolderWatermark(folder.getId(), new UpdateFolderWatermarkRequestBody(new UpdateFolderWatermarkRequestBodyWatermarkField.UpdateFolderWatermarkRequestBodyWatermarkFieldBuilder().imprint(UpdateFolderWatermarkRequestBodyWatermarkImprintField.DEFAULT).build()))

Arguments

  • folderId String
    • 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 UpdateFolderWatermarkRequestBody
    • Request body of updateFolderWatermark method
  • headers UpdateFolderWatermarkHeaders
    • Headers of updateFolderWatermark method

Returns

This function returns a value of type Watermark.

Returns an updated watermark if a watermark already existed on this folder.Returns a new watermark if no watermark existed on this folder yet.

Remove watermark from folder

Removes the watermark from a folder.

This operation is performed by calling function deleteFolderWatermark.

See the endpoint docs at API Reference.

client.getFolderWatermarks().deleteFolderWatermark(folder.getId())

Arguments

  • folderId String
    • 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 DeleteFolderWatermarkHeaders
    • Headers of deleteFolderWatermark method

Returns

This function returns a value of type void.

An empty response will be returned when the watermark was successfully deleted.