Parameter object passed to the UploadManager.upload(params) method in the Bytescale SDKs.
{}{ "cancellationToken": { "isCancelled": false }, "data": "Hello World", "maxConcurrentUploadParts": 2, "metadata": { "myCustomField1": true, "myCustomField2": { "hello": "world" }, "anotherCustomField": 42 }, "mime": "text/plain", "onProgress": Function, "originalFileName": "example.txt", "path": { "fileName": "example-{UNIQUE_DIGITS_4}{ORIGINAL_FILE_EXT}", "folderPath": "/uploads" }, "size": 11, "tags": [ "example_tag" ]}Cancellation token to allow the upload to be cancelled after it has started.
Type: CancellationToken
The data to upload.
The supported types for this parameter vary between the different Bytescale SDKs.
Please refer to each SDK's documentation for this field's type.
Type: Number
Arbitrary JSON to store against the file as metadata.
You can retrieve this later via a GetFileDetails request.
Type: FileMetadata
The file's MIME type.
Example: "text/plain"
Type: String
Min Length: 3
Max Length: 255
Callback taking a single parameter: an object of type UploadManagerProgressEvent.
Type: Function
The file's original name on the user's device.
Example: "example.txt"
Type: String
Min Length: 1
Max Length: 255
The path to upload the file to.
Type: FilePathDefinition
Size of the file data being uploaded, in bytes.
Conditional: only include if both data is a stream.
Example: 11
Type: Integer
Minimum: 0
The file tags to store against the file.
When you associate file tags with a file, Bytescale checks which rules match the tags (if any) and applies those rules to the upload request:
Rules can include max file size checks, traffic limit checks, rate limit checks, and so forth. These are configured in the Bytescale Dashboard.
Example: ["example_tag"]
Type: String[]
This website uses cookies. By continuing you are consenting to the use of cookies per our Cookie Policy. Our legal policies were last updated March 06 2024.
This website requires a modern web browser -- the latest versions of these browsers are supported: