searchFiles( )

Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters.

The searchFiles() function returns a Promise that resolves to an array of the specified files' descriptors and cursor information.

If no parameters are specified, the function returns all files in the MEDIA_ROOT folder.

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
Read Media Manager
Manage Media Manager
Manage Restaurants - all permissions
Learn more about permission scopes.
Method Declaration
Method Parameters

Options to specify which folders to search.

Return Type:Promise<SearchFilesResponse>
Was this helpful?