getFileDescriptor( )

Gets information about a specific file in the Media Manager.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings Services and Settings
Manage Media Manager
Read Media Manager
Manage Events
Access Verticals by Automations
Set Up Automations
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getFileDescriptor(fileId: string): Promise<FileDescriptor>;
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.

Returns
Return Type:Promise<FileDescriptor>
JavaScript
import { files } from "@wix/media";

async function getFileDescriptor(fileId) {
  const response = await files.getFileDescriptor(fileId);
}
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?