4.4.0

Options S3

If you are using the S3 uploader, all of Fine Uploader’s options are still present, and most of them still function the same way. However, some of the options are slightly different. This page will list any new or different options for the S3 uploader. Any option not listed here can be assumed to have the same behavior for the Traditional or S3 uploader.

Core

credentials

accessKey

Temporary public AWS key

Type:
String
Default Value:
null

expiration

Expiration date for temporary credentials. May be an ISO 8601 String or a Date object.

Type:
String or Date
Default Value:
null

secretKey

Temporary secret AWS key

Type:
String
Default Value:
null

sessionToken

Session token associated with the temporary credentials.

Type:
String
Default Value:
null

Note

The chunking.paramNames option does not apply to S3.

chunking

partSize

The maximum size of each part, in bytes.

Type:
Integer
Default Value:
5242880

cors

allowXdr

Enables or disables cross-domain ajax calls (if expected property is true) in IE9 and older.

Type:
Boolean
Default Value:
true

iframeSupport

localBlankPagePath

This is required if you plan on supporting browsers that do not implement the File API, such as IE9 and older. This must point to a blank page on the same origin/domain as the page hosting Fine Uploader.

Type:
String
Default Value:
null

objectProperties

acl

This value corresponds to a canned ACL

Type:
String
Default Value:
private

key

Describes the object key used to identify the file in your S3 bucket. Possible values are ‘uuid’, ‘filename’ or a function. If the value is a function, Fine Uploader S3 will pass the associated file ID as a parameter when invoking your function. If the value is a function it may return one of a qq.Promise or a String.

Type:
String or Function
Default Value:
uuid

reducedRedundancy

Set this to true if you would like to use the reduced redundancy storage class for all objects uploaded to S3.

Type:
Boolean
Default Value:
false

serverSideEncryption

Set this to true if you would like all uploaded files to be encrypted by AWS.

Type:
Boolean
Default Value:
false

Note

The resume.paramNames option does not apply to S3.

resume

recordsExpireIn

Number of days before resumable file records expire.

Type:
Integer
Default Value:
7

Note

request.customHeaders does not apply to S3.

request

accessKey

Your AWS public key. NOT YOUR SECRET KEY. Ignored if credentials have been set.

Type:
String
Default Value:
null

endpoint

URL for your S3 bucket. All valid bucket URLs documented by Amazon are supported, including custom domains. SSL is also supported.

Type:
String
Default Value:
null

params

Parameters passed along with each upload request.

Type:
Object
Default Value:
{}

filenameParam

Part of the parameter name that contains the name of the associated file which may differ from the key name. Prefixed with ‘x-amz-meta-‘ by Fine Uploader.

Type:
String
Default Value:
qqfilename

signature

customHeaders

Additional headers sent along with each signature request.

Type:
Object
Default Value:
{}

endpoint

The endpoint that Fine Uploader can use to send policy documents (HTML form uploads) or other strings to sign (REST requests) before sending requests off to S3.

Type:
String
Default Value:
null

uploadSuccess

customHeaders

Additional headers sent along with each signature request.

Type:
Object
Default Value:
{}

endpoint

An endpoint that Fine Uploader should POST to when a file has been successfully uploaded to S3.

Type:
String
Default Value:
null

params

Any additional parameters to attach to upload success file requests. Note that Fine Uploader will still send the bucket, key, filename, UUID, and etag (if available) as well

Type:
Object
Default Value:
{}

UI

failedUploadTextDisplay

mode

You will most likely want to keep this at the default value of ‘custom’. See the UI options documentation for more info on this option.

Type:
String
Default Value:
custom