Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 3 KB

fileWatermarks.md

File metadata and controls

98 lines (64 loc) · 3 KB

FileWatermarksManager

Get watermark on file

Retrieve the watermark for a file.

This operation is performed by calling function getFileWatermark.

See the endpoint docs at API Reference.

await client.fileWatermarks.getFileWatermark(file.id);

Arguments

  • fileId string
    • 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"

  • optionalsInput GetFileWatermarkOptionalsInput

Returns

This function returns a value of type Watermark.

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

Apply watermark to file

Applies or update a watermark on a file.

This operation is performed by calling function updateFileWatermark.

See the endpoint docs at API Reference.

await client.fileWatermarks.updateFileWatermark(file.id, {
  watermark: new UpdateFileWatermarkRequestBodyWatermarkField({
    imprint: 'default' as UpdateFileWatermarkRequestBodyWatermarkImprintField,
  }),
} satisfies UpdateFileWatermarkRequestBody);

Arguments

  • fileId string
    • 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 UpdateFileWatermarkRequestBody
    • Request body of updateFileWatermark method

  • optionalsInput UpdateFileWatermarkOptionalsInput

Returns

This function returns a value of type Watermark.

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

Remove watermark from file

Removes the watermark from a file.

This operation is performed by calling function deleteFileWatermark.

See the endpoint docs at API Reference.

await client.fileWatermarks.deleteFileWatermark(file.id);

Arguments

  • fileId string
    • 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"

  • optionalsInput DeleteFileWatermarkOptionalsInput

Returns

This function returns a value of type undefined.

Removes the watermark and returns an empty response.