documentation v2.1.0

The relative path to the uploadify.swf file.
For absolute paths prefix the path with either ‘/’ or ‘http’

Default = ‘uploadify.swf’

The relative path to the backend script that will be processing your uploaded files.
For absolute paths prefix the path with either ‘/’ or ‘http’
Default = ‘uploadify.php’

The relative path to the backend script that will check if the file selected already resides on the server.
No Default. ‘check.php’ is provided with core files.

An object containing name/value pairs of additional information you would like sent to the upload script. {‘name’: ‘value’}

The name of your files array in the upload server script.
Default = ‘Filedata’

Set the method for sending scriptData to the backend script. Either ‘GET’ or ‘POST’. Default is set to ‘POST’.

The access mode for scripts in the flash file. If you are testing locally, set to ‘always’.
Default = ’sameDomain’

The path to the folder you would like to save the files to. Do not end the path with a ‘/’.
For absolute paths prefix the path with either ‘/’ or ‘http’. Note server security issues with trying to upload to remote destinations.

The ID of the element you want to use as your file queue. By default, one is created on the fly below the ‘Browse’ button.

The limit of the number of items that can be in the queue at one time. Default = 999.

Set to true if you want to allow multiple file uploads.

Set to true if you would like the files to be uploaded when they are selected.

The text that will appear in the file type drop down at the bottom of the browse dialog box.

A list of file extensions you would like to allow for upload. Format like ‘*.ext1;*.ext2;*.ext3′.
fileDesc is required when using this option.

A number representing the limit in bytes for each upload.

A limit to the number of simultaneous uploads you would like to allow.
Default: 1

The text you would like to appear on the default button. Default = ‘BROWSE’

The path to the image you will be using for the browse button.

Set to true if you want to hide the button image.

Set to true if you would like to activate rollover states for your browse button. To prepare your browse button for rollover states, simple add the ‘over’ and ‘press’ states below the normal state in a single file.

*Mouseover events are inconsistent in Flash 9 so you may see a short lag when using the rollover option.

The width of the button image / flash file. Default = 30

The height of the button image / flash file. If rollover is set to true, this should be 1/3 the height of the actual file. Default = 110

Set to transparent to make the background of the flash file transparent. If set to transparent, the flash file will be at the top-most layer of the page. By omitting the buttonImg option and setting wmode to transparent, the entire flash file will be transparent, allowing you layer content below it or style the button using CSS. Default = ‘opaque’

The path to the default cancel image. Default = ‘cancel.png’

A function that triggers when the script is loaded. The default event handler hides the targeted element on the page and replaces it with the flash file, then creates a queue container after it. The default function will not trigger if the value of your custom function returns false. For custom functions, you can access the html for the flash file using the variable flashElement.

A function that triggers for each element selected. The default event handler generates a 6 character random string as the unique identifier for the file item and creates a file queue item for the file. The default event handler will not trigger if the value of your custom function returns false.

Three arguments are passed to the function:
event: The event object.
queueID: The unique identifier of the file that was selected.
fileObj: An object containing details about the file that was selected.

• name – The name of the file
• size – The size in bytes of the file
• creationDate – The date the file was created
• modificationDate – The last date the file was modified
• type – The file extension beginning with a ‘.’

Two arguments are sent to the function:
event: The event object.
data: An object containing details about the select operation.

• fileCount – The total number of files in the queue
• filesSelected – The number of files selected in the select operation
• filesReplaced – The number of files that were replaced in the queue
• allBytesTotal – The total number of bytes for all files in the queue

A function that triggers when a file upload is cancelled or removed from the queue. The default event handler removes the file from the upload queue. The default event handler will not trigger if the value of your custom function returns false.

Four arguments are sent to the function:
event: The event object.
queueID: The unique identifier of the file that was cancelled.
fileObj: An object containing details about the file that was selected.

• name – The name of the file
• size – The size in bytes of the file
• creationDate – The date the file was created
• modificationDate – The last date the file was modified
• type – The file extension beginning with a ‘.’

data: Details about the file queue.

• fileCount – The total number of files left in the queue
• allBytesTotal – The total number of bytes left for all files in the queue

A function that triggers when the fileUploadClearQueue function is called. The default event handler removes all queue items from the upload queue. The default event handler will not trigger if the value of your custom function returns false.

Two arguments are sent to the function:
event: The event object.
data: An object containing details about the file queue.

• fileCount – The number of files remaining in the upload queue
• allBytesTotal – The number of bytes remaining in the upload queue

A function that triggers when the file queue has reached maximum capacity. The default event alerts the user of the queue size.

Two arguments are sent to the function:
event: The event object.
queueSizeLimit: The maximum size of the queue.

A function that triggers when an error occurs during the upload process. The default event handler attaches an error message to the queue item returning the error and changes it’s queue item container to red.

Four arguments are sent to the function:
event: The event object.
queueID: The unique identifier of the file that returned an error.
fileObj: An object containing details about the file that was selected.

• name – The name of the file
• size – The size in bytes of the file
• creationDate – The date the file was created
• modificationDate – The last date the file was modified
• type – The file extension beginning with a ‘.’

errorObj: An object containing details about the error returned.

• type – Either ‘HTTP’, ‘IO’, or ‘Security’
• info – An error message describing the type of error returned

A function that fires each time a file is initially opened for uploading by the Flash file.  There is no defualt function.

Three arguments are sent to the function:
event: The event object.
queueID: The unique identifier of the file that was opened.
fileObj: An object containing details about the file that was selected.

• name – The name of the file
• size – The size in bytes of the file
• creationDate – The date the file was created
• modificationDate – The last date the file was modified
• type – The file extension beginning with a ‘.’

A function that fires each time the progress of a file upload changes. The default function updates the progress bar in the file queue item. The default function will not trigger if the value of your custom function returns false.

Four arguments are sent to function:
event: The event object.
queueID: The unique identifier of the file that whose progress was updated.
fileObj: An object containing details about the file that was selected.

• name – The name of the file
• size – The size in bytes of the file
• creationDate – The date the file was created
• modificationDate – The last date the file was modified
• type – The file extension beginning with a ‘.’

data: An object containing details about the upload and queue.

• percentage – The current percentage completed for the upload
• bytesLoaded – The current amount of bytes uploaded
• allBytesLoaded – The current amount of bytes loaded for all files in the queue
• speed – The current upload speed in KB/s

A function that triggers when a file upload has completed. The default function removes the file queue item from the upload queue. The default function will not trigger if the value of your custom function returns false.

Four arguments are sent to the function:
event: The event object.
queueID: The unique identifier of the file that was completed.
fileObj: An object containing details about the file that was selected.

• name – The name of the file
• filePath – The path on the server to the uploaded file
• size – The size in bytes of the file
• creationDate – The date the file was created
• modificationDate – The last date the file was modified
• type – The file extension beginning with a ‘.’

response: The data sent back from the server.
data: Details about the file queue.

• fileCount – The total number of files left in the queue
• speed – The average speed of the file upload in KB/s

A function that triggers when all file uploads have completed. There is no default event handler.

Two arguments are sent to the function:
event: The event object.
data: An object containing details about the upload process.

• filesUploaded – The total number of files uploaded
• errors – The total number of errors while uploading
• allBytesLoaded – The total number of bytes uploaded
• speed – The average speed of all uploaded files

A function that triggers when an existing file is detected on the server. The default event handler opens a confirmation box.

Five arguments are sent to the function:
event: The event object.
checkScript: The path to the file checking script.
fileQueue: A file queue object consisting of key/value pairs with the queue ID as the key and the filename as the value.
folder: The path to the upload folder.
single: True if only one file is being uploaded from the queue.

A function used to change options for a fileUpload object.

Two arguments are available, one is required:
setting: The option to change.
value: The value to change the option to. If left blank, this function will return the current value of the setting.

The following example will change the upload folder to ‘/uploads’:

The following options can be changed:
buttonImg, buttonText, cancelImg, fileDesc, fileExt, width, height, folder, script, scriptData, simUploadLimit, sizeLimit, hideButton

The following will return the current size of the queue
#(‘#someID’).uploadifySettings(‘queueSize’);

When using scriptData enter it in {key1 : value1, key2 : value2, …} format.

#(‘#someID’).uploadifySettings(’scriptData’, {‘name’ : some.val()});

If the key already exists it will update it, if it doesn’t exist it will add it. You no longer need to re-write every key/value pair. When requesting scriptData it will return the key/value pairs as an object.

A function used to begin an upload of a single file or all files in the queue.

One argument is optional:
queueID: The unqiue queue identifier for the file to upload.
The following example will upload all files in the queue:

A function used to remove a file from the queue or stop an upload in progress.

One argument is required.
queueID: The unique queue identifier of the file you wish to cancel.

The following example will remove a file from the upload queue:

A function used to clear all files from the upload queue.

The following example clears the file upload queue: