generateFileDownloadUrl( )


Generates one or more temporary URLs for downloading a specific file in the Media Manager.

The generateFileDownloadUrl() function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter.

To download different assets of the file, use the assetKeys parameter which generates a download URL for each asset. If no asset key is specified, it defaults to src, which generates one download URL in the original file's format and quality.

Use this function to grant external clients access to a private media file. Use the expirationInMinutes parameter to set the URL expiration time, and the expirationRedirectUrl parameter to add a redirect URL when the URL expires.

To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the generateFilesDownloadUrl() function. Since this is a permanent URL, it is less secure. Therefore, to download private files, use the generateFileDownloadUrl() function for each private file that you want to generate a download URL for.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Manage Media Manager
Manage Restaurants - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
fileIdstringRequired

File ID.

You can also pass the files' Wix media URLs. For example, ["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]. Learn more in the File and Folder IDs article.


optionsGenerateFileDownloadUrlOptions

Options to use when generating a file's download URL.

Returns
Return Type:Promise<GenerateFileDownloadUrlResponse>
Was this helpful?
Yes
No