{"id":"a3205a18-f80d-48cd-a294-cc688c3dd185","createdDate":"2024-08-26T14:08:07.805Z","updatedDate":"2024-08-26T14:08:07.805Z","resourceId":"ea316e66-714c-4fa1-9113-e6fef038ca67","sdk":{"schema":{"name":"velo-deps_wix-media.v2_folders","fqn":"","slug":"velo-deps-wix-media-v2-folders","typesMap":{"BulkDeleteFoldersOptions":{"name":"BulkDeleteFoldersOptions","fqn":"BulkDeleteFoldersOptions","slug":"bulk-delete-folders-options","actions":[],"properties":[{"name":"permanent","slug":"permanent","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the specified folders are permanently deleted.
\nDefault: `false`"}]},"CreateFolderOptions":{"name":"CreateFolderOptions","fqn":"CreateFolderOptions","slug":"create-folder-options","actions":[],"properties":[{"name":"parentFolderId","slug":"parent-folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the folder's parent folder."}]},"Namespace":{"name":"Namespace","fqn":"Namespace","slug":"namespace","actions":[],"enumValues":["ALBUMS_AND_ART_STORE","ALBUMS_OLD","CHAT","CHAT_MOBILE","LOGO_BUILDER","NO_NAMESPACE","OTHERS","PHOTO_SHARE_APP","SHARING_APP","WIX_ECOM","WIX_FORMS","WIX_MUSIC","WIX_VIDEO"],"properties":[]},"CreateFolderResponse":{"name":"CreateFolderResponse","fqn":"CreateFolderResponse","slug":"create-folder-response","actions":[],"properties":[{"name":"folder","slug":"folder","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Folder","referenceFqn":"Folder"},"description":"Information about the newly created folder."}]},"Folder":{"name":"Folder","fqn":"Folder","slug":"folder","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the folder was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder ID. Generated when a folder is created in the Media Manager."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the folder was updated."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder name as it appears in the Media Manager."},{"name":"parentFolderId","slug":"parent-folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the folder's parent folder.
Default: `media-root` folder."},{"name":"state","slug":"state","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"State","referenceFqn":"State"},"description":"State of the folder."}]},"State":{"name":"State","fqn":"State","slug":"state","actions":[],"enumValues":["DELETED","OK"],"properties":[]},"GenerateFolderDownloadUrlResponse":{"name":"GenerateFolderDownloadUrlResponse","fqn":"GenerateFolderDownloadUrlResponse","slug":"generate-folder-download-url-response","actions":[],"properties":[{"name":"downloadUrl","slug":"download-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL for downloading a specific folder in the Media Manager."}]},"ListDeletedFoldersOptions":{"name":"ListDeletedFoldersOptions","fqn":"ListDeletedFoldersOptions","slug":"list-deleted-folders-options","actions":[],"properties":[{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPaging","referenceFqn":"CursorPaging"},"description":"Cursor and paging information."},{"name":"parentFolderId","slug":"parent-folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the folder's parent folder."},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"},"description":"Field name and order to sort by. One of:\n- `displayName`\n- `_updatedDate`\n\nDefault: `_updatedDate` in `\"DESC\"` order."}]},"CursorPaging":{"name":"CursorPaging","fqn":"CursorPaging","slug":"cursor-paging","actions":[],"properties":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of items to return in the results."}]},"Sorting":{"name":"Sorting","fqn":"Sorting","slug":"sorting","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field to sort by."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SortOrder","referenceFqn":"SortOrder"},"description":"Sort order."}]},"SortOrder":{"name":"SortOrder","fqn":"SortOrder","slug":"sort-order","actions":[],"enumValues":["ASC","DESC"],"properties":[]},"ListDeletedFoldersResponse":{"name":"ListDeletedFoldersResponse","fqn":"ListDeletedFoldersResponse","slug":"list-deleted-folders-response","actions":[],"properties":[{"name":"folders","slug":"folders","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Folder","referenceFqn":"Folder"}},"description":"List of folders in the Media Manager's trash bin."},{"name":"nextCursor","slug":"next-cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"The next cursor if it exists."}]},"PagingMetadataV2":{"name":"PagingMetadataV2","fqn":"PagingMetadataV2","slug":"paging-metadata-v2","actions":[],"properties":[{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."}]},"ListFoldersOptions":{"name":"ListFoldersOptions","fqn":"ListFoldersOptions","slug":"list-folders-options","actions":[],"properties":[{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPaging","referenceFqn":"CursorPaging"},"description":"Cursor and paging information."},{"name":"parentFolderId","slug":"parent-folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the folder's parent folder.\n
Default: `media-root` folder."},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"},"description":"Field name and order to sort by. One of:\n- `displayName`\n- `_updatedDate`\n\nDefault: `_updatedDate` in `\"DESC\"` order."}]},"ListFoldersResponse":{"name":"ListFoldersResponse","fqn":"ListFoldersResponse","slug":"list-folders-response","actions":[],"properties":[{"name":"folders","slug":"folders","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Folder","referenceFqn":"Folder"}},"description":"Information about the folders in the requested folder."},{"name":"nextCursor","slug":"next-cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"The next cursor if it exists."}]},"SearchFoldersOptions":{"name":"SearchFoldersOptions","fqn":"SearchFoldersOptions","slug":"search-folders-options","actions":[],"properties":[{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPaging","referenceFqn":"CursorPaging"},"description":"Cursor and paging information."},{"name":"rootFolder","slug":"root-folder","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RootFolder","referenceFqn":"RootFolder"},"description":"A root folder in the media manager to search in.
\nDefault: `MEDIA_ROOT`."},{"name":"search","slug":"search","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Term to search for, such as the value of a folder's `displayName`.\n\nFor example, if a folder's `displayName` is 'my-videos-folder', the search term is `'my-videos-folder'`."},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"},"description":"Field name and order to sort by. One of:\n- `displayName`\n- `_updatedDate`\n\nDefault: `_updatedDate` in `\"DESC\"` order."}]},"RootFolder":{"name":"RootFolder","fqn":"RootFolder","slug":"root-folder","actions":[],"enumValues":["MEDIA_ROOT","TRASH_ROOT","VISITOR_UPLOADS_ROOT"],"properties":[]},"SearchFoldersResponse":{"name":"SearchFoldersResponse","fqn":"SearchFoldersResponse","slug":"search-folders-response","actions":[],"properties":[{"name":"folders","slug":"folders","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Folder","referenceFqn":"Folder"}},"description":"Information about the folders in the requested folder."},{"name":"nextCursor","slug":"next-cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"The next cursor if it exists."}]},"UpdateFolder":{"name":"UpdateFolder","fqn":"UpdateFolder","slug":"update-folder","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the folder was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder ID. Generated when a folder is created in the Media Manager."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the folder was updated."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder name as it appears in the Media Manager."},{"name":"parentFolderId","slug":"parent-folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the folder's parent folder.
Default: `media-root` folder."},{"name":"state","slug":"state","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"State","referenceFqn":"State"},"description":"State of the folder."}]},"UpdateFolderOptions":{"name":"UpdateFolderOptions","fqn":"UpdateFolderOptions","slug":"update-folder-options","actions":[],"properties":[]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.media.site_media.v1.folder"},"actions":[{"name":"bulkDeleteFolders","fqn":"bulkDeleteFolders","slug":"bulk-delete-folders","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["folderIds"],"permissions":["Manage Bookings Services and Settings","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Bulk delete folders (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\n/* Sample folderIds value:\n * [ \n * '302fc049d70c41dea33fa4a27ab481ba',\n * 's8ze556gf8wfao3us62nx25ww3lr595a'\n * ] \n */\n\nasync function myBulkDeleteFoldersFunction(folderIds) {\n try {\n const deletedFolders = await folders.bulkDeleteFolders(folderIds);\n\n console.log('Successfully moved folders to trash.');\n return deletedFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to void */"},{"title":"Bulk delete folders (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample folderIds value:\n * [ \n * '302fc049d70c41dea33fa4a27ab481ba',\n * 's8ze556gf8wfao3us62nx25ww3lr595a'\n * ] \n */\n\nexport const myBulkDeleteFoldersFunction = webMethod(Permissions.Anyone, async (folderIds) => {\n try {\n const elevatedBulkDeleteFolders = elevate(folders.bulkDeleteFolders);\n const deletedFolders = await elevatedBulkDeleteFolders(folderIds);\n\n console.log('Successfully moved folders to trash.');\n return deletedFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to void */\n"},{"title":"Bulk permanently delete folders","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample folderIds value:\n * [ \n * '302fc049d70c41dea33fa4a27ab481ba',\n * 's8ze556gf8wfao3us62nx25ww3lr595a',\n * 'c956d69906414e7faf8a0ad81117b17d'\n * ]\n * \n * Sample options value:\n * {\n * permanent: true\n * }\n */\n\nexport const myBulkDeleteFoldersFunction = webMethod(Permissions.Anyone, async (folderIds, options) => {\n try {\n const elevatedBulkDeleteFolders = elevate(folders.bulkDeleteFolders);\n const deletedFolders = await elevatedBulkDeleteFolders(folderIds, options);\n\n console.log('Successfully permanently deleted files.');\n return deletedFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to void */"},{"title":"Bulk delete all folders ","description":"This code is an example of a page on which a visitor chooses a folder from a dropdown list, and then deletes all folders found within that folder.","content":"/****************************************\n * Backend code - delete-folders.web.js *\n ***************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const deleteFolders = webMethod(Permissions.Anyone, async (folderIds) => {\n try {\n const elevatedBulkDeleteFolders = elevate(folders.bulkDeleteFolders);\n const deletedFolders = await elevatedBulkDeleteFolders(folderIds);\n\n console.log('Successfully moved folders to trash.');\n return deletedFolders;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const listFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListFolders = elevate(folders.listFolders)\n const foldersList = await elevatedListFolders();\n\n return foldersList;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const searchFolders = webMethod(Permissions.Anyone, async (options) => {\n try {\n const elevatedSearchFolders = elevate(folders.searchFolders)\n const foldersFound = await elevatedSearchFolders(options);\n\n return foldersFound;\n } catch (error) {\n console.error(error);\n }\n});\n\n\n/*************\n * Page code *\n ************/\n\nimport { deleteFolders, listFolders, searchFolders } from 'backend/delete-folders.web';\n\n$w.onReady(async () => {\n await populateFoldersDropdown();\n\n $w('#bulkDelete').onClick(async () => {\n const searchOptions = { rootFolder: $w('#foldersDropdown').value};\n\n const foldersToDelete = await searchFolders(searchOptions);\n const foldersIdsToDelete = foldersToDelete.map((folder) => {\n return folder._id;\n });\n await deleteFolders(foldersIdsToDelete);\n\n console.log(`Successfully deleted all folders found in ${$w('#foldersDropdown').label}.`)\n $w('#bulkDeleteSuccessMsg').show();\n });\n});\n\nasync function populateFoldersDropdown() {\n const folders = await listFolders();\n const dropdownOptions = folders.map((folder) => {\n return {\n label: folder.displayName,\n value: folder._id\n };\n });\n\n $w('#foldersDropdown').options = dropdownOptions;\n};"}],"actionParams":[{"name":"folderIds","slug":"folder-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the folders to move to the Media Manager's trash bin."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkDeleteFoldersOptions","referenceFqn":"BulkDeleteFoldersOptions"},"description":"Options to use when deleting folders."}],"description":"Temporarily deletes the specified folders from the Media Manager.\n\nThe `bulkDeleteFolders()` function returns a Promise that resolves when the folders are deleted.\n\nThe deleted folders are moved to the Media Manager's `TRASH_ROOT` folder (trash bin) unless permanently deleted. To permanently delete folders, pass the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.\n\n>**Notes:**\n> - When a folder is deleted, the files in that folder are deleted.\n> - The specified folders can be from different parent folders.\n> - Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.\n> - Attempting to delete folders that are already in the trash bin doesn't result in an error.\n> - If your site contains files from a non-permanently deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).\n> - You can use the `bulkRestoreFoldersFromTrashBin()` function to restore folders from the Media Manager's trash bin."},{"name":"bulkRestoreFoldersFromTrashBin","fqn":"bulkRestoreFoldersFromTrashBin","slug":"bulk-restore-folders-from-trash-bin","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["folderIds"],"permissions":["Manage Bookings Services and Settings","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Bulk restore (non-permanently deleted) folders (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\n/* Sample folderIds value:\n * [\n * 'd4051a6890724365a78678a6208ac37e',\n * '302fc049d70c41dea33fa4a27ab481ba'\n * ]\n */\n\nasync function myBulkRestoreFoldersFromTrashBinFunc(folderIds) {\n try {\n const restoredFolders = await folders.bulkRestoreFoldersFromTrashBin(folderIds);\n\n console.log('Restored deleted folders:', restoredFolders);\n return restoredFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n /* Promise resolves to void */"},{"title":"Bulk restore (non-permanently deleted) folders (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample folderIds value:\n * [\n * 'd4051a6890724365a78678a6208ac37e',\n * '302fc049d70c41dea33fa4a27ab481ba'\n * ]\n */\n\nexport const myBulkRestoreFoldersFromTrashBinFunc = webMethod(Permissions.Anyone, async (folderIds) => {\n try {\n const elevatedBulkRestoreFoldersFromTrashBin = elevate(folders.bulkRestoreFoldersFromTrashBin);\n const restoredFolders = await elevatedBulkRestoreFoldersFromTrashBin(folderIds);\n\n console.log('Restored deleted folders:', restoredFolders);\n return restoredFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n /* Promise resolves to void */"},{"title":"Bulk restore all folders from the trash bin","content":"/*****************************************\n * Backend code - restore-folders.web.js *\n ****************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const restoreAllFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListDeletedFolders = elevate(folders.listDeletedFolders);\n const deletedFolders = await elevatedListDeletedFolders();\n\n const deletedFolderIds = deletedFolders.map((folder) => {\n return folder._id;\n });\n \n const elevatedBulkRestoreFoldersFromTrashBin = elevate(folders.bulkRestoreFoldersFromTrashBin);\n const restoredFolders = await elevatedBulkRestoreFoldersFromTrashBin(deletedFolderIds);\n\n return restoredFolders;\n } catch (error) {\n console.error(error);\n }\n});\n\n\n/*************\n * Page code *\n ************/\n\nimport { restoreAllFolders } from 'backend/restore-folders.web';\n\n$w.onReady(async () => {\n $w('#restoreAll').onClick(async () => {\n const restoredFolders = await restoreAllFolders();\n\n console.log('Restored all folders:', restoredFolders);\n $w('#bulkRestoreSuccessMsg').show();\n });\n});"}],"actionParams":[{"name":"folderIds","slug":"folder-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the folders to restore from the Media Manager's trash bin."}],"description":"Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.\n\n\nThe `bulkRestoreFoldersFromTrashBin()` function returns a Promise that resolves when the folders have been restored."},{"name":"createFolder","fqn":"createFolder","slug":"create-folder","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["displayName"],"permissions":["Manage Bookings Services and Settings","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CreateFolderResponse","referenceFqn":"CreateFolderResponse"}},"examples":[{"title":"Create a folder (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\n/* Sample displayName value: 'Vector Art'\n * \n * Sample options value:\n * {\n * parentFolderId: 'b2bc72834460412494c93617d88b8c89'\n * }\n */\n\nasync function myCreateFolderFunction(displayName, options) {\n try {\n const newFolder = await folders.createFolder(displayName, options);\n\n console.log('Created folder successfully:', newFolder);\n return newFolder;\n } catch (err){\n console.error(err);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"folder\": {\n * \"_createdDate\": \"2023-08-14T08:05:03.000Z\",\n * \"_id\": \"128833f888ea4846bbfbe8f164f3c6b5\",\n * \"_updatedDate\": \"2023-08-14T08:05:03.000Z\",\n * \"displayName\": \"Vector Art\",\n * \"parentFolderId\": \"b2bc72834460412494c93617d88b8c89\",\n * \"state\": \"OK\"\n * }\n * }\n */"},{"title":"Create a folder (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n\n/* Sample displayName value: 'Vector Art'\n * \n * Sample options value:\n * {\n * parentFolderId: 'b2bc72834460412494c93617d88b8c89'\n * }\n */\n\nexport const myCreateFolderFunction = webMethod(Permissions.Anyone, async (displayName, options) => {\n try {\n const elevateCreateFolder = elevate(folders.createFolder);\n const newFolder = await elevateCreateFolder(displayName, options);\n\n console.log('Created folder successfully:', newFolder);\n return newFolder;\n } catch (err){\n console.error(err);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"folder\": {\n * \"_createdDate\": \"2023-08-14T08:05:03.000Z\",\n * \"_id\": \"128833f888ea4846bbfbe8f164f3c6b5\",\n * \"_updatedDate\": \"2023-08-14T08:05:03.000Z\",\n * \"displayName\": \"Vector Art\",\n * \"parentFolderId\": \"b2bc72834460412494c93617d88b8c89\",\n * \"state\": \"OK\"\n * }\n * }\n */"},{"title":"Create a folder from visitor input ","description":"This code is an example of a page on which a visitor chooses a folder from a dropdown list, and then creates a folder within that folder.","content":"/***************************************\n * Backend code - create-folder.web.js *\n **************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const listFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListFolders = elevate(folders.listFolders)\n const foldersList = await elevatedListFolders();\n\n return foldersList;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const createFolder = webMethod(Permissions.Anyone, async (displayName, options) => {\n try {\n const elevateCreateFolder = elevate(folders.createFolder);\n const newFolder = await elevateCreateFolder(displayName, options);\n\n return newFolder;\n } catch (err){\n console.error(err);\n }\n});\n\n/*************\n * Page code *\n ************/\n\nimport { createFolder, listFolders } from 'backend/create-folder.web';\n\n$w.onReady(async () => {\n await populateFoldersDropdown();\n\n $w('#createFolder').onClick(async () => {\n const folderName = $w('folderName').value;\n const createOptions = {parentFolderId: $w('foldersDropdown').value};\n const newFolder = await createFolder(folderName, createOptions);\n\n console.log(`Successfully created new folder \"${folderName}\" in ${$w('#foldersDropdown').label}.`)\n $w('#createdFolderSuccessMsg').show();\n });\n});\n\nasync function populateFoldersDropdown() {\n const folders = await listFolders();\n const dropdownOptions = folders.map((folder) => {\n return {\n label: folder.displayName,\n value: folder._id\n };\n });\n\n $w('#foldersDropdown').options = dropdownOptions;\n};"}],"actionParams":[{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder name that appears in the Media Manager."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateFolderOptions","referenceFqn":"CreateFolderOptions"},"description":"Options for specifying where to create a folder."}],"description":"Creates a new folder in the Media Manager.\n\nThe `createFolder()` function returns a Promise that resolves to the created folder.\n\nUse the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.\nIf no folder is specified, the new folder is created in the `media-root` folder."},{"name":"generateFolderDownloadUrl","fqn":"generateFolderDownloadUrl","slug":"generate-folder-download-url","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["folderId"],"permissions":["Manage Bookings Services and Settings","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GenerateFolderDownloadUrlResponse","referenceFqn":"GenerateFolderDownloadUrlResponse"}},"examples":[{"title":"Generate a folder download url (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\nasync function generateFolderDownloadUrl(folderId) {\n try {\n const result = await folders.generateFolderDownloadUrl(folderId);\n\n const folderDownloadUrl = result.downloadUrl;\n return folderDownloadUrl;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"downloadUrl\": \"https://archive.wixmp.com/archive/wix/b367fe21877e4ef589cde5352a3a04af\"\n * }\n */"},{"title":"Generate a folder download url (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const generateFolderDownloadUrl = webMethod(Permissions.Anyone, async (folderId) => {\n try {\n const elevatedGenerateFolderDownloadUrl = elevate(folders.generateFolderDownloadUrl);\n const result = await elevatedGenerateFolderDownloadUrl(folderId);\n\n const folderDownloadUrl = result.downloadUrl;\n return folderDownloadUrl;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"downloadUrl\": \"https://archive.wixmp.com/archive/wix/b367fe21877e4ef589cde5352a3a04af\"\n * }\n */\n"},{"title":"Generate a folder download url for a chosen folder ","description":"This code is an example of a page on which a visitor chooses a folder from a dropdown list, and then receives a folder download url for that folder.","content":"/***************************************************\n * Backend code - generate-folder-download-url.web.js *\n **************************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const listFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListFolders = elevate(folders.listFolders)\n const foldersList = await elevatedListFolders();\n\n return foldersList;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const generateDownloadUrl = webMethod(Permissions.Anyone, async (folderId) => {\n try {\n const elevatedGenerateFolderDownloadUrl = elevate(folders.generateFolderDownloadUrl);\n const result = await elevatedGenerateFolderDownloadUrl(folderId);\n \n const folderDownloadUrl = result.downloadUrl;\n return folderDownloadUrl;\n } catch (error) {\n console.error(error);\n }\n});\n\n/*************\n * Page code *\n ************/\n\nimport { generateDownloadUrl, listFolders } from 'backend/generate-folder-download-url.web';\n\n$w.onReady(async () => {\n await populateFoldersDropdown();\n\n $w('#downloadFolder').onClick(async () => {\n const folderId = $w('foldersDropdown').value;\n const downloadUrl = await generateDownloadUrl(folderId);\n\n $w('#downloadFolderBtn').link = downloadUrl;\n $w('#downloadingFolderMsg').show();\n });\n});\n\nasync function populateFoldersDropdown() {\n const folders = await listFolders();\n const dropdownOptions = folders.map((folder) => {\n return {\n label: folder.displayName,\n value: folder._id\n };\n });\n\n $w('#foldersDropdown').options = dropdownOptions;\n};"}],"actionParams":[{"name":"folderId","slug":"folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder ID."}],"description":"Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.\n\nThe `generateFolderDownloadUrl()` function returns a Promise that resolves to a download URL.\n\nThe compressed file can contain sub-folders, and up to 1000 files."},{"name":"getFolder","fqn":"getFolder","slug":"get-folder","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["folderId"],"permissions":["Manage Bookings Services and Settings","Read Media Manager","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.READ-MEDIAMANAGER","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Folder","referenceFqn":"Folder"},"description":"Information about the folder."},"examples":[{"title":"Get a folder (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\n/* Sample folderId value: '30ed8f8a8f1e4a99b82c516cb212192f' */\n\nasync function myGetFolderFunction(folderId) {\n try {\n const folder = await folders.getFolder(folderId);\n\n console.log('Successfully retrieved folder:', folder);\n return folder;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2023-08-22T08:31:06.000Z\",\n * \"_id\": \"30ed8f8a8f1e4a99b82c516cb212192f\",\n * \"_updatedDate\": \"2023-08-22T08:31:06.000Z\",\n * \"displayName\": \"test2\",\n * \"parentFolderId\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"state\": \"OK\"\n * }\n */"},{"title":"Get a folder (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample folderId value: '30ed8f8a8f1e4a99b82c516cb212192f' */\n\nexport const myGetFolderFunction = webMethod(Permissions.Anyone, async (folderId) => {\n try {\n const elevatedGetFolder = elevate(folders.getFolder);\n const folder = await elevatedGetFolder(folderId);\n\n console.log('Successfully retrieved folder:', folder);\n return folder;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2023-08-22T08:31:06.000Z\",\n * \"_id\": \"30ed8f8a8f1e4a99b82c516cb212192f\",\n * \"_updatedDate\": \"2023-08-22T08:31:06.000Z\",\n * \"displayName\": \"test2\",\n * \"parentFolderId\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"state\": \"OK\"\n * }\n */\n"}],"actionParams":[{"name":"folderId","slug":"folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder ID."}],"description":"Gets information from the specified folder in the Media Manager.\n\nThe `getFolder()` function returns a Promise that resolves to information about the specified folder."},{"name":"listDeletedFolders","fqn":"listDeletedFolders","slug":"list-deleted-folders","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissions":["Manage Bookings Services and Settings","Read Media Manager","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.READ-MEDIAMANAGER","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListDeletedFoldersResponse","referenceFqn":"ListDeletedFoldersResponse"}},"examples":[{"title":"List deleted folders (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\nasync function listDeletedFolders() {\n try {\n const deletedFolders = await folders.listDeletedFolders();\n\n console.log(\"Deleted Folders:\", deletedFolders);\n return deletedFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-21T09:32:47.000Z\",\n * \"_id\": \"d4051a6890724365a78678a6208ac37e\",\n * \"_updatedDate\": \"2023-08-21T09:32:47.000Z\",\n * \"displayName\": \"family\",\n * \"parentFolderId\": \"trash-root\",\n * \"state\": \"DELETED\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T05:34:03.000Z\",\n * \"_id\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"_updatedDate\": \"2023-08-21T05:34:03.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"trash-root\",\n * \"state\": \"DELETED\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */"},{"title":"List deleted folders (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const listDeletedFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListDeletedFolders = elevate(folders.listDeletedFolders);\n const deletedFolders = await elevatedListDeletedFolders();\n\n console.log(\"Deleted Folders:\", deletedFolders);\n return deletedFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-21T09:32:47.000Z\",\n * \"_id\": \"d4051a6890724365a78678a6208ac37e\",\n * \"_updatedDate\": \"2023-08-21T09:32:47.000Z\",\n * \"displayName\": \"family\",\n * \"parentFolderId\": \"trash-root\",\n * \"state\": \"DELETED\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T05:34:03.000Z\",\n * \"_id\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"_updatedDate\": \"2023-08-21T05:34:03.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"trash-root\",\n * \"state\": \"DELETED\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */"},{"title":"List deleted folders with sort ","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample options value:\n * {\n * sort: {\n * fieldName: 'displayName',\n * order: 'ASC'\n * }\n * }\n */\n\nexport const listDeletedFolders = webMethod(Permissions.Anyone, async (options) => {\n try {\n const elevatedListDeletedFolders = elevate(folders.listDeletedFolders);\n const deletedFolders = await elevatedListDeletedFolders(options);\n\n console.log(\"Deleted folders, sorted alphabetically by name:\", deletedFolders);\n return deletedFolders;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-21T05:34:03.000Z\",\n * \"_id\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"_updatedDate\": \"2023-08-21T05:34:03.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"trash-root\",\n * \"state\": \"DELETED\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T09:32:47.000Z\",\n * \"_id\": \"d4051a6890724365a78678a6208ac37e\",\n * \"_updatedDate\": \"2023-08-21T09:32:47.000Z\",\n * \"displayName\": \"family\",\n * \"parentFolderId\": \"trash-root\",\n * \"state\": \"DELETED\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */\n"},{"title":"Bulk restore all folders from the trash bin","content":"/*****************************************\n * Backend code - restore-folders.web.js *\n ****************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const restoreAllFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListDeletedFolders = elevate(folders.listDeletedFolders);\n const deletedFolders = await elevatedListDeletedFolders();\n\n const deletedFolderIds = deletedFolders.map((folder) => {\n return folder._id;\n });\n \n const elevatedBulkRestoreFoldersFromTrashBin = elevate(folders.bulkRestoreFoldersFromTrashBin);\n const restoredFolders = await elevatedBulkRestoreFoldersFromTrashBin(deletedFolderIds);\n\n return restoredFolders;\n } catch (error) {\n console.error(error);\n }\n});\n\n\n/*************\n * Page code *\n ************/\n\nimport { restoreAllFolders } from 'backend/restore-folders.web';\n\n$w.onReady(async () => {\n $w('#restoreAll').onClick(async () => {\n const restoredFolders = await restoreAllFolders();\n\n console.log('Restored all folders:', restoredFolders);\n $w('#bulkRestoreSuccessMsg').show();\n });\n});"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListDeletedFoldersOptions","referenceFqn":"ListDeletedFoldersOptions"},"description":"Options to use when listing deleted folders from the trash bin."}],"description":"Retrieves a list of deleted folders from the trash bin.\n\nThe `listDeletedFolders()` function returns a Promise that resolves to information about the specified deleted folders and cursor information.\n\nTo retrieve a list of non-deleted folders, use the `listFolders()` function."},{"name":"listFolders","fqn":"listFolders","slug":"list-folders","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissions":["Manage Bookings Services and Settings","Read Media Manager","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.READ-MEDIAMANAGER","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListFoldersResponse","referenceFqn":"ListFoldersResponse"}},"examples":[{"title":"List folders (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\nasync function myListFoldersFunction()\n{\n try {\n const foldersList = await folders.listFolders();\n\n console.log(\"Folders:\", foldersList);\n return foldersList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-14T07:41:19.000Z\",\n * \"_id\": \"103601562ec94214bee61f470b403dd5\",\n * \"_updatedDate\": \"2023-08-14T07:41:19.000Z\",\n * \"displayName\": \"Pictures\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-14T07:38:31.000Z\",\n * \"_id\": \"c956d69906414e7faf8a0ad81117b17d\",\n * \"_updatedDate\": \"2023-08-14T07:38:31.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-09T08:57:12.000Z\",\n * \"_id\": \"b2bc72834460412494c93617d88b8c89\",\n * \"_updatedDate\": \"2023-08-09T08:57:12.000Z\",\n * \"displayName\": \"Documents\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */"},{"title":"List folders (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const myListFoldersFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListFolders = elevate(folders.listFolders);\n const folderList = await elevatedListFolders();\n\n console.log(\"Folders:\", folderList);\n return folderList;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-14T07:41:19.000Z\",\n * \"_id\": \"103601562ec94214bee61f470b403dd5\",\n * \"_updatedDate\": \"2023-08-14T07:41:19.000Z\",\n * \"displayName\": \"Pictures\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-14T07:38:31.000Z\",\n * \"_id\": \"c956d69906414e7faf8a0ad81117b17d\",\n * \"_updatedDate\": \"2023-08-14T07:38:31.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-09T08:57:12.000Z\",\n * \"_id\": \"b2bc72834460412494c93617d88b8c89\",\n * \"_updatedDate\": \"2023-08-09T08:57:12.000Z\",\n * \"displayName\": \"Documents\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */"},{"title":"List 5 folders found in a parent folder, sorted alphabetically by name ","content":"import { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\nimport { Permissions, webMethod } from 'wix-web-module';\n\n/* Sample options value:\n * {\n * paging: {\n * limit: 5\n * },\n * parentFolderId : '103601562ec94214bee61f470b403dd5',\n * sort : {\n * fieldName : 'displayName',\n * order : 'ASC'\n * }\n * }\n */\n\nexport const myListFoldersFunction = webMethod(Permissions.Anyone, async (options) => {\n try {\n const result = await folders.listFolders(options);\n\n const folderList = result.folders;\n\n folderList.forEach(element => {\n console.log(element.displayName);\n });\n\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-21T09:33:47.000Z\",\n * \"_id\": \"0cfdf68ac3b9453b81cfe171caf40b0c\",\n * \"_updatedDate\": \"2023-08-21T09:33:47.000Z\",\n * \"displayName\": \"31-08\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T09:33:30.000Z\",\n * \"_id\": \"193161aeef8f4b80b97d7032fb2c4f0a\",\n * \"_updatedDate\": \"2023-08-21T11:09:58.000Z\",\n * \"displayName\": \"Water\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T09:32:39.000Z\",\n * \"_id\": \"4b9e2dd061de4f3e80e3ada23b0fb440\",\n * \"_updatedDate\": \"2023-08-21T09:32:39.000Z\",\n * \"displayName\": \"city\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T09:56:43.000Z\",\n * \"_id\": \"6a86df2ce32c4d279c21fbdd2887c18b\",\n * \"_updatedDate\": \"2023-08-21T09:56:43.000Z\",\n * \"displayName\": \"docs1\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T09:33:10.000Z\",\n * \"_id\": \"5d0625ed28494bf7938c03e9a21130ba\",\n * \"_updatedDate\": \"2023-08-21T09:33:24.000Z\",\n * \"displayName\": \"docs2\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T09:32:34.000Z\",\n * \"_id\": \"7984b3c5454e4371acbd4f4eedde96bc\",\n * \"_updatedDate\": \"2023-08-21T11:10:51.000Z\",\n * \"displayName\": \"mountains\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */"},{"title":"Create a folder from visitor input ","description":"This code is an example of a page on which a visitor chooses a folder from a dropdown list, and then creates a folder within that folder.","content":"/***************************************\n * Backend code - create-folder.web.js *\n **************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const listFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListFolders = elevate(folders.listFolders)\n const foldersList = await elevatedListFolders();\n\n return foldersList;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const createFolder = webMethod(Permissions.Anyone, async (displayName, options) => {\n try {\n const elevateCreateFolder = elevate(folders.createFolder);\n const newFolder = await elevateCreateFolder(displayName, options);\n\n return newFolder;\n } catch (err){\n console.error(err);\n }\n});\n\n/*************\n * Page code *\n ************/\n\nimport { createFolder, listFolders } from 'backend/create-folder.web';\n\n$w.onReady(async () => {\n await populateFoldersDropdown();\n\n $w('#createFolder').onClick(async () => {\n const folderName = $w('folderName').value;\n const createOptions = {parentFolderId: $w('foldersDropdown').value};\n const newFolder = await createFolder(folderName, createOptions);\n\n console.log(`Successfully created new folder \"${folderName}\" in ${$w('#foldersDropdown').label}.`)\n $w('#createdFolderSuccessMsg').show();\n });\n});\n\nasync function populateFoldersDropdown() {\n const folders = await listFolders();\n const dropdownOptions = folders.map((folder) => {\n return {\n label: folder.displayName,\n value: folder._id\n };\n });\n\n $w('#foldersDropdown').options = dropdownOptions;\n};"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListFoldersOptions","referenceFqn":"ListFoldersOptions"},"description":"Options to use when listing folders from the Media Manager."}],"description":"Retrieves a list of folders in the Media Manager.\n\nThe `listFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.\n\nTo retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the list of folders within the root folder of the Media Manager.\n\nTo retrieve a list of (non-permanently) deleted folders, use the `listDeletedFolders()` function."},{"name":"searchFolders","fqn":"searchFolders","slug":"search-folders","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissions":["Manage Bookings Services and Settings","Read Media Manager","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.READ-MEDIAMANAGER","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SearchFoldersResponse","referenceFqn":"SearchFoldersResponse"}},"examples":[{"title":"Search folders (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\nasync function mySearchFoldersFunction() {\n try {\n const foldersFound = await folders.searchFolders();\n\n console.log(\"Folders found in search:\", foldersFound);\n return foldersFound;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-14T07:41:19.000Z\",\n * \"_id\": \"103601562ec94214bee61f470b403dd5\",\n * \"_updatedDate\": \"2023-08-21T11:09:08.000Z\",\n * \"displayName\": \"Pictures\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T05:34:03.000Z\",\n * \"_id\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"_updatedDate\": \"2023-08-21T05:34:03.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */"},{"title":"Search folders (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const mySearchFoldersFunction = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedSearchFolders = elevate(folders.searchFolders);\n const foldersFound = await elevatedSearchFolders();\n\n console.log(\"Folders found in search:\", foldersFound);\n return foldersFound;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-14T07:41:19.000Z\",\n * \"_id\": \"103601562ec94214bee61f470b403dd5\",\n * \"_updatedDate\": \"2023-08-21T11:09:08.000Z\",\n * \"displayName\": \"Pictures\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-21T05:34:03.000Z\",\n * \"_id\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"_updatedDate\": \"2023-08-21T05:34:03.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"media-root\",\n * \"state\": \"OK\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"\"\n * },\n * \"hasNext\": false\n * }\n * }\n */\n"},{"title":"Search for 2 folders by key-word, returned alphabetically ","description":"When no `rootFolder` is specified in the options parameter, the search returns results from the 'MEDIA_ROOT' folder.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample options value:\n * {\n * search: 'mountains',\n * sort: {\n * fieldName: 'updatedDate',\n * order: 'ASC'\n * },\n * paging: {\n * limit: 2\n * }\n * }\n */\n\nexport const mySearchFoldersFunction = webMethod(Permissions.Anyone, async (options) => {\n try {\n const elevatedSearchFolders = elevate(folders.searchFolders);\n const foldersFound = await elevatedSearchFolders(options);\n\n console.log(\"Folders found in search:\", foldersFound);\n return foldersFound;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"folders\": [\n * {\n * \"_createdDate\": \"2023-08-21T09:32:34.000Z\",\n * \"_id\": \"7984b3c5454e4371acbd4f4eedde96bc\",\n * \"_updatedDate\": \"2023-08-21T11:10:51.000Z\",\n * \"displayName\": \"mountains\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * },\n * {\n * \"_createdDate\": \"2023-08-24T11:26:26.000Z\",\n * \"_id\": \"742d4a0ee5884b119292d52ed964f14d\",\n * \"_updatedDate\": \"2023-08-24T11:26:26.000Z\",\n * \"displayName\": \"mountain_videos\",\n * \"parentFolderId\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"state\": \"OK\"\n * }\n * ],\n * \"nextCursor\": {\n * \"cursors\": {\n * \"next\": \"eyJ0b3RhbCI6IDEsICJvZmZzZXQiOiAyfQ==\"\n * },\n * \"hasNext\": true\n * }\n * }\n */\n"},{"title":"Bulk delete all folders ","description":"This code is an example of a page on which a visitor chooses a folder from a dropdown list, and then deletes all folders found within that folder.","content":"/****************************************\n * Backend code - delete-folders.web.js *\n ***************************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const deleteFolders = webMethod(Permissions.Anyone, async (folderIds) => {\n try {\n const elevatedBulkDeleteFolders = elevate(folders.bulkDeleteFolders);\n const deletedFolders = await elevatedBulkDeleteFolders(folderIds);\n\n console.log('Successfully moved folders to trash.');\n return deletedFolders;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const listFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListFolders = elevate(folders.listFolders)\n const foldersList = await elevatedListFolders();\n\n return foldersList;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const searchFolders = webMethod(Permissions.Anyone, async (options) => {\n try {\n const elevatedSearchFolders = elevate(folders.searchFolders)\n const foldersFound = await elevatedSearchFolders(options);\n\n return foldersFound;\n } catch (error) {\n console.error(error);\n }\n});\n\n\n/*************\n * Page code *\n ************/\n\nimport { deleteFolders, listFolders, searchFolders } from 'backend/delete-folders.web';\n\n$w.onReady(async () => {\n await populateFoldersDropdown();\n\n $w('#bulkDelete').onClick(async () => {\n const searchOptions = { rootFolder: $w('#foldersDropdown').value};\n\n const foldersToDelete = await searchFolders(searchOptions);\n const foldersIdsToDelete = foldersToDelete.map((folder) => {\n return folder._id;\n });\n await deleteFolders(foldersIdsToDelete);\n\n console.log(`Successfully deleted all folders found in ${$w('#foldersDropdown').label}.`)\n $w('#bulkDeleteSuccessMsg').show();\n });\n});\n\nasync function populateFoldersDropdown() {\n const folders = await listFolders();\n const dropdownOptions = folders.map((folder) => {\n return {\n label: folder.displayName,\n value: folder._id\n };\n });\n\n $w('#foldersDropdown').options = dropdownOptions;\n};"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SearchFoldersOptions","referenceFqn":"SearchFoldersOptions"},"description":"Options specifying which folders to search."}],"description":"Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.\n\nThe `searchFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.\n\nIf no parameters are specified, the function returns all folders in the `MEDIA_ROOT` folder."},{"name":"updateFolder","fqn":"updateFolder","slug":"update-folder","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","folder"],"permissions":["Manage Bookings Services and Settings","Manage Media Manager","Manage Portfolio","Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.BOOKINGS.CONFIGURATION","SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER","SCOPE.PORTFOLIO.MANAGE-PORTFOLIO","SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Folder","referenceFqn":"Folder"},"description":"Information about the updated folder."},"examples":[{"title":"Update a folder's name (dashboard page code)","content":"import { folders } from 'wix-media.v2';\n\n/* Sample id value: '7984b3c5454e4371aqbd4f4eedde96bc'\n *\n * Sample folder value:\n * {\n * displayName: 'mountains'\n * }\n */\n\nasync function myUpdateFolderFunction(id, options) {\n try {\n const updatedFolder = await folders.updateFolder(id, options);\n\n console.log(`Updated folder ${updatedFolder.displayName}:`, updatedFolder);\n return updatedFolder;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2023-08-21T09:32:34.000Z\",\n * \"_id\": \"7984b3c5454e4371acbd4f4eedde96bc\",\n * \"_updatedDate\": \"2023-08-21T11:10:51.000Z\",\n * \"displayName\": \"mountains\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * }\n */"},{"title":"Update a folder's name (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\n/* Sample id value: '7984b3c5454e4371aqbd4f4eedde96bc'\n *\n * Sample folder value:\n * {\n * displayName: 'mountains'\n * }\n */\n\nexport const myUpdateFolderFunction = webMethod(Permissions.Anyone, async (id, options) => {\n try {\n const elevatedUpdateFolder = elevate(folders.updateFolder);\n const updatedFolder = await elevatedUpdateFolder(id, options);\n\n console.log(`Updated folder ${updatedFolder.displayName}:`, updatedFolder);\n return updatedFolder;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2023-08-21T09:32:34.000Z\",\n * \"_id\": \"7984b3c5454e4371acbd4f4eedde96bc\",\n * \"_updatedDate\": \"2023-08-21T11:10:51.000Z\",\n * \"displayName\": \"mountains\",\n * \"parentFolderId\": \"103601562ec94214bee61f470b403dd5\",\n * \"state\": \"OK\"\n * }\n */\n"},{"title":"Update a folder's location ","description":"This code is an example of a page on which a visitor chooses a folder from a dropdown list, and then creates a folder within that folder.","content":"/************************************\n * Backend code - create-folder.web.js *\n ***********************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { folders } from 'wix-media.v2';\nimport { elevate } from 'wix-auth';\n\nexport const listFolders = webMethod(Permissions.Anyone, async () => {\n try {\n const elevatedListFolders = elevate(folders.listFolders)\n const foldersList = await elevatedListFolders();\n\n return foldersList;\n } catch (error) {\n console.error(error);\n }\n});\n\nexport const updateFolder = webMethod(Permissions.Anyone, async (id, options) => {\n try {\n const elevatedUpdateFolder = elevate(folders.updateFolder);\n const updatedFolder = await elevatedUpdateFolder(id, options);\n\n return updatedFolder;\n } catch (error) {\n console.error(error);\n }\n});\n\n/*************\n * Page code *\n ************/\n\nimport { updateFolder, listFolders } from 'backend/create-folder.web';\n\n$w.onReady(async () => {\n await populateFoldersDropdowns();\n\n $w('#updateFolderLocation').onClick(async () => {\n const folderId = $w('#updateFolderDropdown').value;\n const parentFolderId = $w('#parentFolderDropdown').value;\n if (folderId === parentFolderId) {\n $w('#folderIsParentFolderMsg').show();\n return;\n };\n const options = {parentFolderId};\n const updatedFolder = await updateFolder(folderId, options);\n\n console.log(`Successfully updated folder ${updatedFolder.displayName}:`, updatedFolder);\n $w('#updateFolderSuccessMsg').show();\n });\n});\n\nasync function populateFoldersDropdowns() {\n const folders = await listFolders();\n const dropdownOptions = folders.map((folder) => {\n return {\n label: folder.displayName,\n value: folder._id\n };\n });\n\n $w('#updateFolderDropdown').options = dropdownOptions;\n $w('#parentFolderDropdown').options = dropdownOptions;\n};\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder ID. Generated when a folder is created in the Media Manager."},{"name":"folder","slug":"folder","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateFolder","referenceFqn":"UpdateFolder"},"description":"Folder to update."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateFolderOptions","referenceFqn":"UpdateFolderOptions"}}],"description":"Updates a folder.\n\nThe `updateFolder()` function returns a Promise that resolves to information about the updated folder.\n\nYou can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder."}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction\n\n\n\n\n\nThe Folders API allows you to manage the folders in your Media Manager. \n\nWith the Folders API, you can:\n- [Get](wix-media-v2/folders/get-folder), [list](wix-media-v2/folders/list-folders), and [search](wix-media-v2/folders/search-folders) folders.\n- [Create](wix-media-v2/folders/create-folder), [update](wix-media-v2/folders/update-folder), and [delete](wix-media-v2/folders/bulk-delete-folders) folders. \n- [Restore](wix-media-v2/folders/bulk-restore-folders-from-trash-bin) folders from the trash bin.\n- [Generate URLs](wix-media-v2/folders/generate-folder-download-url) for downloading folders from the Media Manager. \n\nLearn more about [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) and how to access it. \n\n## Before You Begin\n\nTo use the Folders API, import `{ folders }` from the `wix-media.v2` module:\n\n```javascript\nimport { folders } from 'wix-media.v2';\n``` \n","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.103"}}

getFolder( )