List of properties
Property name | Description |
---|---|
uploadUrl | Contains the URL of the server script configured to handle upload through HTTP POST calls. |
retryCount | Defines a count of attempts that unsuccessful upload will be repeated. |
macOsServerResponseTime | Defines a server response timeout in milliseconds for MAC OS platforms. |
successHttpStatusCodes | Defines an array of successful HTTP resposne codes. |
sendFileAttributes | Indicates whether file attributes should be included as form fields in the upload request. |
fileAttributesToSend | Indicates names of file attributes that should be included as form fields in the upload request. |
queueDataInLastRequest | Indicates whether ot not summary information about upload queue should be sent with the last file. |
formToSend | Name of <FORM> element that should be parsed and which elements values should be included as form fields in the upload request. |
retrieveBrowserCookie | Indicates whether browser cookie should be included in the upload request. |
redirectUrl | The URL to which user will be redirected after successful upload. |
redirectTarget | Specifies where to open the redirectURL. |
redirectMethod | The HTTP method that will be used for redirection. |
<fileStatusXXXMsg> | Group of properties which contain messages for various status of file. |
fileLoadIOErrorMsg | The message is shown when IOError occured during upload request. |
fileLoadSecurityErrorMsg | The message is shown when SecurityError occured during upload request. |
httpDefaultMsg | The message is shown when Http error occured during upload request. |
<httpXXXMsg> | Group of properties which contain various http error messages. |
resizedFilenamePattern | Gets or set pattern for names of resized images which will be uploaded to the server. Formatting constants are supported. |
uploadResizedImages | Determines whether resized images should be uploaded to the server. |
uploadOriginalImages | Determines whether original images should be uploaded to the server. |
increaseOriginalImageSize | Determines component behaviour when original image smaller than required resizing size. If false then original image will not be changed. |
resizedImageMaxWidth | Indicates the maximum width of resized image. All images are resized with saving proportions therefore the final width of resized image will be lower or equal to defined value. |
resizedImageMaxHeight | Indicates the maximum height of resized image. All images are resized with saving proportions therefore the final height of resized image will be lower or equal to defined value. |
resizedImageType | Indicates the type of resized image. |
resizedJpgQuality | Indicates the "quality" setting for resized JPEG images. |
uploadUrl
Default value: ""
Type: string
String reference: "uploader.uploadUrl"
Description:
Contains the URL of the server script configured to handle upload through HTTP POST calls. On some browsers, URL strings are limited in length. Lengths greater than 256 characters may fail on some browsers or servers. If this property is an empty string, an exception is thrown. The URL can be HTTP or, for secure uploads, HTTPS. To use HTTPS, use an HTTPS url in the url parameter. If you do not specify a port number in the url parameter, port 80 is used for HTTP and port 443 us used for HTTPS, by default. On some Non-IE browser HTTPS protocol prefix doesn't work properly, so in this case the following url format for upload via SSL is recomended: http://www.somewebsite.com:443/somepage.php. Relative URLs are also supported.
Note: Uploading operations can access files only within its own domain and within any domains that a URL policy file specifies. Put a policy file on the file server if the content initiating the upload doesn't come from the same domain as the file server. See more here Web site controls (policy file)
Note: & symbol should be encoded to %26 for query string values. Ex: http://www.somesite.com/uploader.php?field1=value1%26field2=value2
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.uploadUrl"] = "filesreceiver.php";
retryCount
Default value: 0
Type: int
String reference: "uploader.retryCount"
Description:
Defines a count of attempts that unsuccessful upload will be repeated. On some platforms unexpected IO error occured during getting an access to the file and this behavior stops an upload. Therefore, EAFlashUpload can retry to upload file "retryCount" times.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.retryCount"] = 3;
macOsServerResponseTime
Default value: 200
Type: int
String reference: "uploader.macOsServerResponseTime"
Description:
Defines a server response timeout in milliseconds for MAC OS platforms. Sometimes upload complete event doesn't fire on Flash Player on MAC OS. The EAFlashUpload waits defined time, recieves the server resposne and starts a new file upload process.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.macOsServerResponseTime"] = 200;
successHttpStatusCodes
Default value: 200|201|204|303
Type: int
String reference: "uploader.successHttpStatusCodes"
Description:
Defines an array of successful HTTP resposne codes. This property is designed generally for uploading file to Amazon S3. Adobe Flash Player recognizes only one "200" HTTP code as successful by default. Amazon S3 server may return various successful http codes. You can use this property for smoothly integration with your existing Amazon S3 solution. We recomend to use "201" HTTP code as a value of "success_action_status" form field. In a case when resized images are uploaded to the Amazon S3 the "201" code is a strong requirement.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.successHttpStatusCodes"] = "200|201|204|303";
sendFileAttributes
Default value: true
Type: Boolean
String reference: "uploader.sendFileAttributes"
Description:
Indicates whether file attributes should be included as form fields in the upload request.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.sendFileAttributes"] = true;
fileAttributesToSend
Default value: ["index", "name", "type", "size"]. The following value is used for ImageView by default: ["index", "name", "type", "size", "width", "height"].
Type: Array
String reference: "uploader.fileAttributesToSend"
Description:
Indicates the names of file attributes that should be included as form fields in the upload request.
The name of form field has the following format:
- file_<name of property> (Ex: file_size)
- when the resized images(ImageView) are sent:
- file<counter>_<name of property> (Ex: file0_width)
- resized<counter>_<name|width|height> (Ex: resized0_width)
Below is described avalable file attributes:
File's attribute | Description |
---|---|
id | The unique identifier of the file in the upload queue. |
index | The index of the file in the upload queue. |
name | The name of the file on the local disk. The full path is not included. |
type | In Windows or Linux, this attribute is the file extension. On the Macintosh, this attribute is the four-character file type, which is only used in Mac OS versions prior to Mac OS X. |
size | The size of the file on the local disk in bytes. |
creation date | The creation date of the file on the local disk. |
modification date | The date that the file on the local disk was last modified. |
creator | The Macintosh creator type of the file, which is only used in Mac OS versions prior to Mac OS X. In Windows or Linux, this attribute is null. |
width | The width of oroginal image in the queue. This property is available for ImageView only. |
height | The height of original image in the queue. This property is available for ImageView only. |
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.fileAttributesToSend"] = "size|width|height";
queueDataInLastRequest
Default value: true
Type: Boolean
String reference: "uploader.queueDataInLastRequest"
Description:
Indicates whether ot not summary information about upload queue should be sent with the last file. The data is represented in JSON format.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.queueDataInLastRequest"] = true;
formToSend
Default value: ""
Type: string
String reference: "uploader.formToSend"
Description:
Name of <FORM> element that should be parsed and which elements values should be included as form fields in the upload request. The EAFlashUpload parses specified form via JavaScript and includes values of elements to the each upload request.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.formToSend"] = "Form1";
retrieveBrowserCookie
Default value: true
Type: Boolean
String reference: "uploader.retrieveBrowserCookie"
Description:
Indicates whether browser cookie should be included in the upload request. The Flash Player plug-in for Non-IE (FireFox, Safari etc.) browsers doesn’t send browser cookies with upload request. Therefore, server-side applications that use cookies (ex: authentication, session tracking (state maintenance)) doesn’t work properly. EAFlashUpload retrieves browser cookies via JavaScript(document.cookie property) and sends it as a value of form field(the name of form field is "browser_cookie"). There is no way to retrieve cookie via javascript if server adds to cookie value HttpOnly flag.
Note: Described problem does not exist when you upload only resized images.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.retrieveBrowserCookie"] = true;
redirectUrl
Default value: ""
Type: string
String reference: "uploader.redirectUrl"
Description:
The URL to which user will be redirected after successful upload. The name and size of each file will be sent to redirect location. If redirectMethod is set to "GET" then all vlaues is sent as the query string variables. If redirectMethod is set to "POST" then all values is sent in the request body.
The following variables are sent for each file:
redirectMethod = "GET":
- UploadedFilesCount
- UploadedFilesSize
redirectMethod = "POST":
- UploadedFilesCount
- All form fields values of formToSend form
- File attributes:
file<counter>_<each value of fileAttributesToSend and all customFileProperties> (Ex: file_size)
when the resized images(ImageView) are sent:- file<counter>_<each value of fileAttributesToSend and all customFileProperties> (Ex: file0_width)
- resized<counter>_<name|size|width|height> (Ex: resized0_width)
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.redirectUrl"] = "redirecturl.php";
redirectTarget
Default value: "_blank"
Type: string
String reference: "uploader.redirectTarget"
Description:
The browser window or HTML frame in which to display the document indicated by the redirectUrl property. You can enter the name of a specific window or use one of the following values:
- "_self" specifies the current frame in the current window.
-
"_blank" specifies a new window.
Various browsers (and browser configurations) may block pop-up windows at any time; it is not possible to guarantee any pop-up window will appear. - "_parent" specifies the parent of the current frame.
- "_top" specifies the top-level frame in the current window.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.redirectTarget"] = "_self";
redirectMethod
Default value: "GET"
Type: string
String reference: "uploader.redirectMethod"
Description:
The HTTP method (POST or GET) that will be used for redirection.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.redirectMethod"] = "POST";
fileStatusXXXMsg group of properties
Description:
Group of properties that contain messages for various status of file. This messages are being used to describe different upload state of each file. File.statusString property is populated on basis of this messages. Also they are shown in the statusColumn column of filesList table(see TableView.filesList). The values of properties support formatting constants(see String formatting).
Property name | Default value | Type | String reference |
---|---|---|---|
fileStatusREADYMsg | "Ready" | string | uploader.fileStatusREADYMsg |
fileStatusUPLOADINGMsg | "#FILE_PERCENTS_DONE#%" | string | uploader.fileStatusUPLOADINGMsg |
fileStatusUPLOADEDMsg | "Uploaded" | string | uploader.fileStatusUPLOADEDMsg |
fileStatusRESIZED_UPLOADINGMsg | "Uploading resized image" | string | uploader.fileStatusRESIZED_UPLOADINGMsg |
fileStatusRESIZED_UPLOADEDMsg | "Resized image uploaded" | string | uploader.fileStatusRESIZED_UPLOADEDMsg |
fileStatusERRORMsg | "Error" | string | uploader.fileStatusERRORMsg |
fileStatusCANCELEDMsg | "Canceled" | string | uploader.fileStatusCANCELEDMsg |
fileStatusCUSTOMMsg | "Custom" | string | uploader.fileStatusCUSTOMMsg |
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.fileStatusUPLOADINGMsg"] = "#FILE_PERCENTS_DONE#% uploaded";
fileLoadIOErrorMsg
Default value: "The IOError occured"
Type: string
String reference: "uploader.fileLoadIOErrorMsg"
Description:
The message is shown when IOError occured during upload request.
The IOError occured in any of the following situations:
- The upload fails because of an input/output error while Flash Player is reading, or transmitting the file.
- The upload fails because an attempt to upload a file to a server that requires authentication (such as a user name and password). During upload, no mean is provided for users to enter passwords.
- The upload fails because the url parameter contains an invalid protocol. HTTP and HTTPS are allowed.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.fileLoadIOErrorMsg"] = "The IOError occured";
fileLoadSecurityErrorMsg
Default value: "The SecurityError occured."
Type: string
String reference: "uploader.fileLoadSecurityErrorMsg"
Description:
The message is shown when SecurityError occured during upload request.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.fileLoadSecurityErrorMsg"] = "The SecurityError occured.";
httpDefaultMsg
Default value: ""
Type: string
String reference: "uploader.httpDefaultMsg"
Description:
The message is shown when HTTP error occured during upload request. If you wish to display the same message for all HTTP error populate this property with appropriate message, if you not, populate this property with empty string.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.httpDefaultMsg"] = "The HTTP error occured during upload request.";
httpXXXMsg group
Description:
uploader object has group of properties which contain various http error messages. This messages are shown if httpDefaultMsg is an empty string. The values of properties support formatting constants.
The following table describes mentioned properties:
Property name | Default value | Type | String reference |
---|---|---|---|
http400Msg | "400 Bad request. The request could not be understood by the server due to malformed syntax." | string | uploader.http400Msg |
http401Msg | "401 Unauthorized. The request requires user authentication." | string | uploader.http401Msg |
http403Msg | "403 Forbidden. The server understood the request, but is refusing to fulfill it. Probably authentication access is enabled for upload script(value of uploader.uploadUrl parameter) or uploader.uploadUrl parameter has the wrong value." | string | uploader.http403Msg |
http404Msg | "404 Not Found. The server has not found anything matching the Request-URI. Please check uploader.uploadUrl has the correct value" | string | uploader.http404Msg |
http405Msg | "405 Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI." | string | uploader.http405Msg |
http406Msg | "406 Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request." | string | uploader.http406Msg |
http407Msg | "407 Proxy Authentication Required. This error is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy." | string | uploader.http407Msg |
http408Msg | "408 Request Timeout. The client did not produce a request within the time that the server was prepared to wait." | string | uploader.http408Msg |
http409Msg | "409 Conflict. The request could not be completed due to a conflict with the current state of the resource." | string | uploader.http409Msg |
http410Msg | "410 Gone. The requested resource is no longer available at the server and no forwarding address is known." | string | uploader.http410Msg |
http411Msg | "411 Length Required. The server refuses to accept the request without a defined Content-Length." | string | uploader.http411Msg |
http412Msg | "412 Precondition Failed. The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server." | string | uploader.http412Msg |
http413Msg | "413 Request Entity Too Large. The server is refusing to process a request because the request entity is larger than the server is willing or able to process." | string | uploader.http413Msg |
http414Msg | "414 Request-URI Too Long. The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret." | string | uploader.http414Msg |
http415Msg | "415 Unsupported Media Type. The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method." | string | uploader.http415Msg |
http416Msg | "416 Requested Range Not Satisfiable." | string | uploader.http416Msg |
http417Msg | "417 Expectation Failed. The expectation given in an Expect request-header field could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server." | string | uploader.http417Msg |
http500Msg | "500 Internal Server Error. Please check uploader.uploadUrl has the correct value. Check also that folder for storing files exists on the server and has read-write permissions. If you use ASP.NET as server platform please check ASP.NET application is created for folder which contains upload script." | string | uploader.http500Msg |
http501Msg | "501 Not Implemented. The server does not support the functionality required to fulfill the request." | string | uploader.http501Msg |
http502Msg | "502 Bad Gateway. The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request." | string | uploader.http502Msg |
http503Msg | "503 Service Unavailable. The server is currently unable to handle the request due to a temporary overloading or maintenance of the server." | string | uploader.http503Msg |
http504Msg | "504 Gateway Timeout. The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request." | string | uploader.http504Msg |
http505Msg | "505 HTTP Version Not Supported. The server does not support, or refuses to support, the HTTP protocol version that was used in the request message." | string | uploader.http505Msg |
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.http500Msg"] = "500 Internal Server Error.";
resizedFilenamePattern
Default value: "resized_#FILE_NAME#"
Type: string
String reference: "uploader.resizedFilenamePattern"
Description:
Gets or set pattern for names of resized images which will be uploaded to the server. Formatting constants are supported.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.resizedFilenamePattern"] = "resized_#FILE_NAME#";
uploadResizedImages
Default value: false (true if ImageView.swf is used).
Type: Boolean
String reference: "uploader.uploadResizedImages"
Description:
Determines whether resized images should be uploaded to the server.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.uploadResizedImages"] = true;
uploadOriginalImages
Default value: false (true if ImageView.swf is used).
Type: Boolean
String reference: "uploader.uploadOriginalImages"
Description:
Determines whether original images should be uploaded to the server.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.uploadOriginalImages"] = true;
increaseOriginalImageSize
Default value: false
Type: Boolean
String reference: "uploader.increaseOriginalImageSize"
Description:
Determines component behaviour when original image smaller than required resizing size. If false then original image will not be changed.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.increaseOriginalImageSize"] = true;
resizedImageMaxWidth
Default value: 160
Type: int
String reference: "uploader.resizedImageMaxWidth"
Description:
Indicates the maximum width of resized image. All images are resized with saving proportions therefore the final width of resized image will be lower or equal to defined value.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.resizedImageMaxWidth"] = 3;
resizedImageMaxHeight
Default value: 160
Type: int
String reference: "uploader.resizedImageMaxHeight"
Description:
Indicates the maximum height of resized image. All images are resized with saving proportions therefore the final height of resized image will be lower or equal to defined value.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.resizedImageMaxHeight"] = 3;
resizedImageType
Default value: "jpg"
Type: string
String reference: "uploader.resizedImageType"
Description:
Indicates the type of resized image. The possible values are: "jpg"(recommended), "png".
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.resizedImageType"] = "jpg";
resizedJpgQuality
Default value: 90 (Possible value range: 0 - 100)
Type: int
String reference: "uploader.resizedJpgQuality"
Description:
This propety allows to set the "quality" setting for JPEG images. Defined value is applied for resized images.
Examples:
The value of property is assigned via flashvars object of SWFObject:
flashvars["uploader.resizedJpgQuality"] = 90;