Data Types

UploadWidgetResult

The result returned by the Upload Widget.

Note: the Upload Widget returns an array of these items.

{
"accountId": "YOUR_ACCOUNT_ID",
"filePath": "/uploads/image.jpg",
"fileUrl": "https://upcdn.io/A623uY2/raw/uploads/image.jpg",
"originalFile": {
"accountId": "YOUR_ACCOUNT_ID",
"filePath": "/uploads/image.jpg",
"fileUrl": "https://upcdn.io/A623uY2/raw/uploads/image.jpg",
"lastModified": 1615680311115,
"metadata": {
"myCustomField1": true,
"myCustomField2": {
"hello": "world"
},
"anotherCustomField": 42
},
"mime": "image/jpeg",
"originalFileName": "example.jpg",
"size": 43182,
"tags": [
"example_tag"
]
}
}

Your account ID.

This is visible on the settings page:

https://www.bytescale.com/dashboard/settings

Example: "A623uY2"

Type: String

Length: 7

If the user did not upload a cropped image, then this field will be undefined.

If the user did upload a cropped image, then this field will refer to a JSON file containing the cropped image's dimensions.

You must view this file via an image transformation — e.g. thumbnail — for the JSON file to be rendered as an image. If you view this file using raw in the URL then you'll see the raw JSON file containing the crop dimensions.

Type: UploadedFile

The filePath of the editedFile — if it exists — else the filePath of the originalFile.

Example: "/uploads/image.jpg"

Type: String

Min Length: 1

Max Length: 512

A browser-loadable URL for filePath, using the most suitable transformation available from your Bytescale account, else uses raw.

Example: "https://upcdn.io/A623uY2/raw/uploads/image.jpg"

Type: String

Min Length: 1

Max Length: 255

The original file uploaded from the user's device.

Type: UploadedFile

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: