Skip to content

folderWatermarks.md

Latest commit

 

History

History
96 lines (62 loc) · 3.34 KB

folderWatermarks.md

File metadata and controls

96 lines (62 loc) · 3.34 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.

await client.folderWatermarks.getFolderWatermark(folder.id);

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"
  • optionalsInput GetFolderWatermarkOptionalsInput

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.

await client.folderWatermarks.updateFolderWatermark(folder.id, {
  watermark: new UpdateFolderWatermarkRequestBodyWatermarkField({
    imprint: 'default' as UpdateFolderWatermarkRequestBodyWatermarkImprintField,
  }),
} satisfies UpdateFolderWatermarkRequestBody);

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
  • optionalsInput UpdateFolderWatermarkOptionalsInput

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.

await client.folderWatermarks.deleteFolderWatermark(folder.id);

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"
  • optionalsInput DeleteFolderWatermarkOptionalsInput

Returns

This function returns a value of type undefined.

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