importFile( )
Imports a file to the Media Manager from a URL.
Description
The importFile() function returns a Promise that resolves to information
about the newly imported file.
Video and audio files that have been imported aren't immediately available
to be used even after the Promise is resolved. Before they can be used, they
must first undergo transcoding. The onFileUploaded()
event is triggered when an imported file has been uploaded and before the transcoding is finished. As a result, some properties
such as the fileUrl may not initially appear in the returns.
Syntax
function importFile(path: string, url: string, options: UploadOptions): FileInfo
importFile Parameters
NAME
TYPE
DESCRIPTION
The path within the Media Manager where the file will be
uploaded. If the path doesn't yet exist, the missing folders will be created,
for example: /media/files.
If metadataOptions.isVisitorUpload is true (default), the visitor-uploads folder is the root of the file path,
in this case, visitor-uploads/media/files/.
The file's external URL, where it was imported from.
Options to use when uploading a file
Returns
Fulfilled - Information about the file that was uploaded.
Return Type:
NAME
TYPE
DESCRIPTION
Deprecated. Use the fileUrl property instead.
The fileName property is the internal name (unique identifier) which is generated when a file is uploaded by the Media Manager, returned from the importFile(), or upload() functions. The name is the string located in the file's URL. Click here to learn more. Use this name when calling the getFileInfo(), getFileUrl(),
and getVideoPlaybackUrl() functions.
The file's Wix media URL in the following format: 'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'.
File hash.
Size of the uploaded file in bytes.
Type of the file that was uploaded. One of:
"audio""document""image""shape""video"
Whether the link to the uploaded file is public or private. Private links require a token to be used.
ID of the file's parent folder.
Original name of the uploaded file. This is the display name that appears in the Media Manager.
Status of the file that was uploaded. One of:
"IN-DOWNLOAD-QUEUE""IN-QUEUE""READY"
URL where the file was uploaded from.
URL of the file's icon.
List of labels assigned to the file by the Media Manager.
Media height.
Media width.
Date the file was created.
Date the file was updated.
Was this helpful?
Import a file
1import { Permissions, webMethod } from 'wix-web-module';2import { mediaManager } from 'wix-media-backend';34export const importFile = webMethod(Permissions.Anyone, (url) => {5 return mediaManager.importFile(6 "/myImportFolder/subfolder",7 url,8 {9 "mediaOptions": {10 "mimeType": "image/jpeg",11 "mediaType": "image"12 },13 "metadataOptions": {14 "isPrivate": false,15 "isVisitorUpload": false,16 "context": {17 "someKey1": "someValue1",18 "someKey2": "someValue2"19 }20 }21 }22 );23});2425/* Returns a promise that resolves to:26 *27 * {28 * "fileUrl": "wix:image://v1/f6c0f9_tg439f4475a749e181dd14407fdbd37e~mv2.jpg/imported-pic.png#originWidth=319&originHeight=206",29 * "hash": "Ew00kXbu4Zt33rzjcWa6Ng==",30 * "sizeInBytes": 51085,31 * "mimeType": "image/jpeg",32 * "mediaType": "image",33 * "isPrivate": false,34 * "parentFolderId": "2bf470f5be194b319cdb2accc3278ff9",35 * "originalFileName": "my-image.jpg",36 * "sourceUrl": "https://somedomain.com/img/original-name.jpg",37 * "opStatus": "IN-DOWNLOAD-QUEUE"38 * }39 */