tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > BinariesService

BinariesService class

Signature:

export declare class BinariesService

Methods

Method Modifiers Description
downloadFile({ tempFileId, filename, }) static Downloads the temporary file for a binary file that was previously uploaded.
downloadItemBinary({ escapedItemId, }) static Downloads the binary content of a Multimedia Component as a file.
getFileThumbnail({ tempFileId, fileExtension, width, height, }) static Gets the thumbnail image of an uploaded binary file (or the multimedia type icon when no thumbnail is available).
getItemBinaryThumbnail({ escapedItemId, width, height, }) static Gets the thumbnail image for the binary content contained in a specified Multimedia Component.
upload({ file, }) static Uploads a single binary file. This operation returns an instance of ‘BinaryUploadResponse’ type.
uploadMultimediaComponent({ file, escapedFolderId, title, multimediaSchemaId, }) static <p>Uploads a single binary file and creates a multimedia component. This operation returns an instance of ‘Component’ type.</p><p>The method doesn’t support creating of the component based on the multimedia schema having required metadata fields with no default values.</p>