INNORIX Exabyter - Developer manual

Order no.	Product	Status	Date
O1111-1111-1111	INX-DD2222 X 100 INX-DD2222 X 10 INX-DD2222 X 1	Shipping	21 Sep. 2022
O1111-1111-1111	INX-DD2222 X 100	Shipping	21 Sep. 2022
O1111-1111-1111	INX-DD2222 X 100	Shipping	21 Sep. 2022

Parameters

File box

Name	Types	Default	Description
el	String		Set the div tag id for the file box.
boxStyle	String	simple1	Set the file box style. simple1: File type icon simple2: Dot icons simple3: Only file names detail1: Simple1 + File types and modified dates detail2: Simple2 + File types and modified dates detail3: Simple3 + File types and modified dates
boxHeight	Number	200	Set the file box height (pixels)
boxWidth	Number	200	Set the file box width (pixel)
useContextMenu	Boolean	true	Activate the context menu in the file box
enableDropZone	Boolean	true	Activate the drop zone in the file box
maxMassFileListCount	Number	1000	Set the maximum number of files in the standard file box UI. When this number is exceeded, the file box UI switches to the mass file attach mode.
folderAttach	Boolean	false	Activate the folder transfer feature. - It is supported in the plugin mode.
showPreviewImage	Boolean	false	Preview the selected image file in the file box. - It is supported in the plugin mode.

File transfer

Name	Types	Default	Description
uploadURL	String		Set the upload processing file address.
transferMode	String	both	Set the file box transfer mode. both : Upload and download in the same file box upload : Only upload download : Only download
transferStart	JSON Text	“upload”:”auto”, “download”: “manual”	Activate to start transferring automatically e.g { “upload”:”auto”, “download”: “manual” } auto: Start transferring, when the transfer window displays manual: User needs to click start button in the transfer window
downloadType	String	stream	Set download URL type direct: http://abc.com/file.dat format stream: http://abc.com/down.jsp?fid=33 format
isPresignedURL	Boolean	false	Use object storage.
attachIncompleteFiles	Boolean	true	Automatically attach the files that failed upload automatically. - It is supported in the plugin mode.
downloadDuplicate	String	Resume	Duplicated file policy when downloading. overwrite : overwrite resume : resume numbering : auto numbering rename confirm : user check confirm - It is supported in the plugin mode.
uploadDuplicate	Boolean	true	Duplicated file policy when uploading. true : resume false : overwrite - It is supported in the plugin mode.
highSpeedMode	Boolean	true	Activate the high speed transfer mode. - It is supported in the plugin mode.
limitRate	Number		Set the limitation of the file transfer speed. (Kbyte) - It is supported in the plugin mode.
useProxy	Boolean	false	Use proxy mode. - It is supported in the plugin mode.
useSSL	Boolean	false	Use HTTPS mode. - It is supported in the plugin mode.
savePath	String		Set the default save path e.g "c:\\download" - It is supported in the plugin mode.
sendDownloadTime	Boolean	false	Send the download start and complete time from the front end to the download processing file. - It is supported in the plugin mode.
skipDownloadCheck	Boolean	false	Verify whether the file actually exists and the size. - It is supported in the plugin mode.
useEncrypt	Boolean	false	Encrypt and decrypt the files while transferring. - It is supported in the plugin mode.
useEncryptMeta	Boolean	false	Encrypt the meta information while transferring. - It is supported in the plugin mode.
initStatusCheck	Boolean	false	Check the server status before transferring. - It is supported in the plugin mode.
integrity	String		Check the integrity while uploading. both: Check files and blocks. file: Check files block: Check blocks - It is supported in the plugin mode.
downloadIntegrityFile	Boolean	false	Check the integrity of the files while downloading. - It is supported in the plugin mode.
downloadIntegrity	Boolean	false	Check the integrity of the file `s blocks while downloading. - It is supported in the plugin mode.

Error Handling

Name	Types	Default	Description
autoRecovery	Boolean	true	When error occurs, resume transferring automatically. - It is supported in the plugin mode.
maxErrorCount	Number	unlimited	Set the maximum number of errors without user intervention. If it is ‘10’, when errors occur 11 times, the transfer will stop. - It is supported in the plugin mode.
maxRetryCount	Number	unlimited	Set the maximum number of retries when 1 error occurs. If it is ‘3’, when an error occurs, it will retry for 3 times. - It is supported in the plugin mode.
retryInterval	Number	3	Set the interval (second) of retries when 1 retries. If it is ‘3’, when an error occurs, it will retry every 3 seconds. - It is supported in the plugin mode.
skipErrorFile	Boolean	false	Transfer all files except the error files while transferring. - It is supported in the plugin mode.

Transfer window

Name	Types	Default	Description
showTransferWindow	Boolean	true	Display the transfer window.
draggableTransferWindow	Boolean	true	Allow to drag the transfer window.
transferWindowTitle	String	Exabyter	Set the transfer window title.
showByteSize	Boolean	false	Set the file size unit to Byte.
iframeOutside	Boolean	true	When the file box is in iframe, the transfer window will be displayed outside of the iframe.
iframeOutsideCssURL	String		Set the CSS URL (innorix.css) for the parent frame.
iframeOutsideLeft	Number		Set the transfer window location from the left. (pixel)
iframeOutsideTop	Number		Set the transfer window location from the top. (pixel)
iframeOutsideLocation	String		top: Display the transfer window in the most top frame. parent: Display the transfer window in the layer that is 1 level upper from the file box frame.
iframeOutsideMarginLeft	Number		Set the transfer windows margin from the left. (pixel)
iframeOutsideMarginTop	Number		Set the transfer windows margin from the top. (pixel)
fileListWindowMode	Boolean	false	Display the upload or download file list on the transfer window.
fileListWindowStatus	Boolean	false	Display the status of each file transfer on the transfer window. - It is supported in the plugin mode.
fileListWindowSetPath	Boolean	false	Allow to choose the save path on the download transfer window. - It is supported in the plugin mode.
fileListWindowDuplicate	Boolean	false	Display the duplicate file options on the download transfer window. - It is supported in the plugin mode.
cancelComfirmation	Boolean	false	When canceling, display a confirmation dialog. - It is supported in the plugin mode.

Plugin

Name	Types	Default	Description
html5	Boolean	true	true: Use HTML5 mode false: Use Agent mode
installURL	String		Set the agent installation guide URL. e.g. installUrl: ‘install/install.html’ - It is supported in the plugin mode.
autoHtml5Mode	Boolean	false	When the agent is not installed, it will use HTML5 mode. If it is ‘true’, installation page will not be displayed. - It is supported in the plugin mode.
pluginVersionCheck	Boolean	false	Check the plugin version. - It is supported in the plugin mode.
pluginInstallCheck	Boolean	true	Check whether the plugin is installated and the version. - It is supported in the plugin mode.
installPopup	Boolean	false	Display Install.html in a popup window. - It is supported in the plugin mode.
installPopupHeight	Number		Set the popup window height. (pixel) - It is supported in the plugin mode.
installPopupWidth	Number		Set the pop-up window width. (pixel) - It is supported in the plugin mode.
installPopupLeft	Number		Set the popup window location from the left. (pixel) - It is supported in the plugin mode.
installPopupTop	Number		Set the popup window location from the top. (pixel) - It is supported in the plugin mode.

Attachment

Name	Types	Default	Description
allowType	StringArray		Allow to attach only entered file types e.g ["jpg", "gif", "png"] ※ limitExtension is higher priority than allowExtension
denyType	StringArray		Deny to attach entered file types e.g ["exe", "msi", "cab"] ※ When specifying the same extension policy as allowExtension, LimitExtension is applied first
useSignature	Boolean	false	Compare the file header and extension.
addDuplicateFile	Boolean	false	Allow to attach duplicate files.
maxFileCount	Number	unlimited	Set the maximum number of attachable files.
maxFileSize	Number	unlimited	Set the maximum size of one file. (bytes)
maxTotalSize	Number	unlimited	Set the total size of attachable files. (bytes)

Monitor & Track

Name	Types	Default	Description
monitorURL	String		Set the monitor and track server address. (INNROIX Platform server) e.g. “http://test.innorix.com/mt/transfer”

API Methods

Front-end API

Dialog

Name	openFileDialog()
Description	Open the multi file dialog.
Return type	Nonevoid
Input parameter	None

Name	openFileDialogSingle()
Description	Open the single file dialog.
Return type	Nonevoid
Input parameter	None

Name	openFolderDialog()
Description	Open the folder dialog. - It is supported in the plugin mode.
Return type	Nonevoid
Input parameter	None

File box

Name	create()
Description	Create file box.
Return type	Nonevoid
Input parameter	None

Name	setSize()
Description	Set the file box size. (Pixels, %)
Return type	Nonevoid
Input parameter	Width(Number), Height(Number)

Name	setDropzone()
Description	Set the file drop zone. - It is supported in the plugin mode.
Return type	Nonevoid
Input parameter	innoJqueryevt

Name	getTransferMode()
Description	Get the transfer mode.
Return type	(String) upload: Upload mode download: Download mode both: Upload and download mode
Input parameter	innoJqueryevt

Name	presetDownloadFiles()
Description	Nonevoid
Return type	Create download file list in the file box.
Input parameter	# JSON Object [ { printFileName: "red.pdf ",// Displayed filename (String) fileSize: 1433885,// File size (Number) / Byte downloadUrl: “http://YourServerAddress/download.jsp?fileID=111”// Download URL (String) }, { printFileName: "blue.pdf",// Displayed filename (String) fileSize: 1433885, // File size (Number) / Byte downloadUrl: "http://YourServerAddress/download.jsp?fileID=222"// Download URL (String) } ]

Name	addSelectFilesById()
Description	Select the ID file in the file box.
Return type	Nonevoid
Input parameter	(String)

Name	removeFileByIndex()
Description	Remove the item of the index number file in the file box.
Return type	Nonevoid
Input parameter	(Number)

Name	removeFileById()
Description	Remove the item of the ID in the file box.
Return type	Nonevoid
Input parameter	(String)

Name	removeSelectedFiles()
Description	Remove the selected files in the file box.
Return type	Nonevoid
Input parameter	None

Name	removeAllFiles()
Description	Remove all files in the file box.
Return type	Nonevoid
Input parameter	None

Name	destory()
Description	Destory the file box.
Return type	Nonevoid
Input parameter	None

File information

Name	getAllFiles()
Description	Get information of all files in the file box.
Return type	# JSON Object - Upload file value [ { "basePath": Attached path (String) "boxId": File box ID (String) "filePath": Full path of the attached file (String) "fileSize": File size (Number) / Byte "folderName: Folder name (String) "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rootName": Folder name (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "transferType": Transfer mode (String) "uniqueFileName": Unique file name (String) "uploadUrl": Upload URL (String) }, ] # JSON Object – Download file value [ { "downloadUrl": Download URL (String) "fileSize": File size (Number) / Byte "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "sliceSize": File slice size (Number) / Byte "transferType": Transfer mode (String) "validate": Validate the file (Boolean) } ]
Input parameter	None

Name	getSelectedFiles()
Description	Get information of the selected files in the file box.
Return type	# JSON Object - Upload file value [ { "basePath": Attached path (String) "boxId": File box ID (String) "filePath": Full path of the attached file (String) "fileSize": File size (Number) / Byte "folderName: Folder name (String) "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rootName": Folder name (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "transferType": Transfer mode (String) "uniqueFileName": Unique file name (String) "uploadUrl": Upload URL (String) }, ] # JSON Object – Download file value [ { "downloadUrl": Download URL (String) "fileSize": File size (Number) / Byte "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "sliceSize": File slice size (Number) / Byte "transferType": Transfer mode (String) "validate": Validate the file (Boolean) } ]
Input parameter	None

Name	getUploadFiles()
Description	Get information of all upload files in the file box.
Return type	# JSON Object [ { "basePath": Attached path (String) "boxId": File box ID (String) "filePath": Full path of the attached file (String) "fileSize": File size (Number) / Byte "folderName: Folder name (String) "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rootName": Folder name (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "transferType": Transfer mode (String) "uniqueFileName": Unique file name (String) "uploadUrl": Upload URL (String) }, ]
Input parameter	None

Name	getDownloadFiles()
Description	Get information of all download files in the file box.
Return type	# JSON Object – Download file value [ { "downloadUrl ": Download URL (String) "fileSize ": File size (Number) / Byte "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "sliceSize": File slice size (Number) / Byte "transferType": Transfer mode (String) "validate": Validate the file (Boolean) } ]
Input parameter	None

Name	getFileCount()
Description	Get the number of all files in the file box.
Return type	(Number)
Input parameter	None

Name	getSelectedFileCount()
Description	Get the number of the selected files in the file box.
Return type	(Number)
Input parameter	None

Name	getUploadFileSize()
Description	Get the total size of the upload files in the file box.
Return type	(Number)
Input parameter	None

Name	getDownloadFileSize()
Description	Get the total size of the download files in the file box.
Return type	(Number)
Input parameter	None

Name	getTotalSize()
Description	Get the total size of all files in the file box.
Return type	(Number)
Input parameter	None

Name	getFileByIndex()
Description	Get information of the index file in the file box.
Return type	# JSON Object - Upload file value [ { "basePath": Attached path (String) "boxId": File box ID (String) "filePath": Full path of the attached file (String) "fileSize": File size (Number) / Byte "folderName: Folder name (String) "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rootName": Folder name (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "transferType": Transfer mode (String) "uniqueFileName": Unique file name (String) "uploadUrl": Upload URL (String) }, ] # JSON Object – Download file value [ { "downloadUrl": Download URL (String) "fileSize": File size (Number) / Byte "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "sliceSize": File slice size (Number) / Byte "transferType": Transfer mode (String) "validate": Validate the file (Boolean) } ]
Input parameter	(Number)

Name	getFileById()
Description	Get information of the ID file in the file box.
Return type	# JSON Object - Upload file value [ { "basePath": Attached path (String) "boxId": File box ID (String) "filePath": Full path of the attached file (String) "fileSize": File size (Number) / Byte "folderName: Folder name (String) "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rootName": Folder name (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "transferType": Transfer mode (String) "uniqueFileName": Unique file name (String) "uploadUrl": Upload URL (String) }, ] # JSON Object – Download file value [ { "downloadUrl": Download URL (String) "fileSize": File size (Number) / Byte "id": File ID (String) "mode": Transfer mode (String) "printFileName": Displayed filename (String) "rowID": File row index ID (String) "selected": Selected or not (Boolean) "sliceSize": File slice size (Number) / Byte "transferType": Transfer mode (String) "validate": Validate the file (Boolean) } ]
Input parameter	(String)

Transfer

Name	upload()
Description	Upload all files in the file box.
Return type	Nonevoid
Input parameter	None

Name	uploadCancel()
Description	Cancel uploading.
Return type	Nonevoid
Input parameter	None

Name	excute()
Description	Execute an attached file in a file box. - It is supported in the plugin mode.
Return type	Nonevoid
Input parameter	(String)

Name	download()
Description	Download all files in the file box.
Return type	Nonevoid
Input parameter	None

Name	downloadSelectedFiles()
Description	Download the selected files in the file box.
Return type	Nonevoid
Input parameter	None

Name	downloadAndOpen()
Description	Download and open a selected file. - It is supported in the plugin mode.
Return type	Nonevoid
Input parameter	None

Name	setDownloadPath()
Description	A user can choose the save path before the transfer window is displayed. - It is supported in the plugin mode.
Return type	Nonevoid
Input parameter	None

Name	setPostData()
Description	Create customized post data.
Return type	Nonevoid
Input parameter	# JSON Object { Name : Value, Name : Value, }

Name	setFilePostDataByIndex()
Description	Create customized post data by index.
Return type	Nonevoid
Input parameter	# JSON Object Index(Number), { Name : Value, Name : Value, }

Name	setCookie()
Description	Keep the web session information.
Return type	Nonevoid
Input parameter	(String) the example to keep session information after loading the file box box.on('loadComplete', function (p) { box.setCookie("JSESSIONID=<%=session.getId()%>"); }…

Name	appendThumbnailProperty()
Description	When uploading images, their resized images are created and uploaded together. (jpg, png, gif, bmp)
Return type	Nonevoid
Input parameter	# JSON Object Index(String), Width(Number), Height(Number), Baseline(STRING) box.appendThumbnailProperty(1, 300, 200, “VERTICAL”); box.appendThumbnailProperty(“ALL”, 300, 200, “HORIZONTAL”); box.appendThumbnailProperty(“ALL”, 300, 200, “FIX”);

Name	appendWatermarkProperty()
Description	When uploading images, add a watermark on the original and resized images and upload them. (jpg, png, gif, bmp)
Return type	Nonevoid
Input parameter	# JSON Object Index(String), imageUrl(String), Image type(String), Position(String) box.appendWatermarkProperty("ALL", "./logo.png", "ALL", "LEFT\|BOTTOM") box.appendWatermarkProperty("1", "./logo.png", "ORIGINAL", "RIGHT\|TOP") box.appendWatermarkProperty("1", "./logo.png", "THUMBNAIL", "CENTER\|CENTER")

Transfer window

Name	closeTransferWindow
Description	Close the transfer window.
Return type	Nonevoid
Input parameter	Nonevoid

Back-end API

Upload

Name	setOverwrite()
Description	Overwrite when there are duplicate files.
Return type	Nonevoid
Input parameter	Boolean) – true, false

Name	run()
Description	Start uploading.
Return type	Nonevoid
Input parameter	Nonevoid

Name	setFileName()
Description	Rename the uploaded files in the server.
Return type	Nonevoid
Input parameter	String

Name	setDirectory()
Description	Set the save path in the server.
Return type	Nonevoid
Input parameter	String

Name	setAutoDecryption()
Description	Decrypt when the uploaded files are encrypted. - It is supported in the plugin mode.
Return type	Nonevoid
Input parameter	(Boolean) – true, false

Name	setCustomError()
Description	Create a custom error. - It is supported in the plugin mode.
Return type	Nonevoid
Input parameter	InnorixCustomError.set(error Code, error Message, error Title, retry);

Name	setCustomValue()
Description	Set custom value.
Return type	Nonevoid
Input parameter	InnorixCustomValue.set(parameter, value);

Events

Front-end events

File box

Name	loadComplete
Description	After loading the file box.
Parameter	Nonevoid

Name

beforeAddFile

Description

Before adding files in the file box.

Parameter

# JSON Object    
{
“basePath": Attached path(String)
“boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"mode": Transfer mode (String)
"uploadUrl": Upload URL(String)
}

Name

afterAddFiles

Description

After adding files in the file box.

Parameter

# JSON Object 
[
{
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"transferType": Transfer mode (String)
"uniqueFileName": Unique file name (String)
"uploadUrl": Upload URL (String)
},   
{
"downloadUrl ": Download URL (String) 
"fileSize ": File size (Number) / Byte
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"sliceSize": Slice size(Number) / Byte
"transferType": Transfer mode (String)
"validate": Validate the file (Boolean)
}
]

Name

beforeRemoveFiles

Description

Before removing files in the file box.

Parameter

# JSON Object
[
{
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"transferType": Transfer mode (String)
"uniqueFileName": Unique file name (String)
"uploadUrl": Upload URL (String)
},   
{
"downloadUrl ": Download URL (String) 
"fileSize ": File size (Number) / Byte
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"sliceSize": Slice size (Number) / Byte
"transferType": Transfer mode (String)
"validate": Validate the file (Boolean)
}
]

Name

removeFiles

Description

After removing file in the file box.

Parameter

# JSON Object    
[
{
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"transferType": Transfer mode (String)
"uniqueFileName": Unique file name (String)
"uploadUrl": Upload URL (String)
},   
{
"downloadUrl ": Download URL (String) 
"fileSize ": File size (Number) / Byte
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"sliceSize": Slice size (Number) / Byte
"transferType": Transfer mode (String)
"validate": Validate the file (Boolean)
}
]

Name

addFileError

Description

When an error occurs while attaching files in the file box.

Parameter

# JSON Object    
[
{
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"mode": Transfer mode (String)
"uploadUrl": Upload URL (String)
}
"message":"*.pdf file can not be attached.", 	// Error info (String)
"*.ppt file can not be attached."
"The maximum limit of a single file is 1.00 MB."
"The maximum number of files is 1."
"The maximum limit of total files is 1.00 MB"
"The same file is already attached."
"type":"limitExtension"				// Error type (String)
"allowExtension"
"maxFileSize"
"maxFileCount"
"maxTotalSize"
"addDuplicateFile"
]

Name

onSelectRows

Description

When a file is selected in the file box.

Parameter

# JSON Object    
[
{
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"transferType": Transfer mode (String)
"uniqueFileName": Unique file name (String)
"uploadUrl": Upload URL (String)
},   
{
"downloadUrl ": Download URL (String) 
"fileSize ": File size (Number) / Byte
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"sliceSize": Slice size (Number) / Byte
"transferType": Transfer mode (String)
"validate": Validate the file (Boolean)
}
]

Name

onUnSelectRows

Description

When the selected file is unselected in the file box.

Parameter

# JSON Object    
[
{
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"transferType": Transfer mode (String)
"uniqueFileName": Unique file name (String)
"uploadUrl": Upload URL (String)
},   
{
"downloadUrl ": Download URL (String) 
"fileSize ": File size (Number) / Byte
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"sliceSize": Slice size (Number) / Byte
"transferType": Transfer mode (String)
"validate": Validate the file (Boolean)
}
]

Name

onDblClickRows

Description

When double click a file in the file box.

Parameter

# JSON Object    
[
{
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"transferType": Transfer mode (String)
"uniqueFileName": Unique file name (String)
"uploadUrl": Upload URL (String)
},   
{
"downloadUrl ": Download URL (String) 
"fileSize ": File size (Number) / Byte
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"sliceSize": Slice size (Number) / Byte
"transferType": Transfer mode (String)
"validate": Validate the file (Boolean)
}
]

Name	dropzoneShow
Description	When drop zone is activated. - It is supported in the plugin mode.
Parameter

Name	dropzoneHide
Description	When drop zone is deactivated. - It is supported in the plugin mode.
Parameter

Transfer

Name

uploadStart

Description

When the upload started.

Parameter

# JSON Object     
{
“files”:[ {	
"basePath": Attached path (String)
"boxId": File box ID (String)
"filePath": Attached file full path (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"transferType": Transfer mode (String)
"uniqueFileName": Unique file name (String)
"uploadUrl": Upload URL (String)
},
]
“progress”: Progress (Number) / %
“retries”: Retry count (Number) / Times
“speed”: Transfer speed(Number) /Byte/s
“state”: Status (String)
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Name

uploadComplete

Description

When the upload completed.

Parameter

# JSON Object      
{
“files”:[ {	
"clientFileName": Displayed filename (String)
"clientFilePath": Attached file full path (String)
"boxId": File box ID (String)
"basePath": Attached path (String)
"customeValue": Customized value (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"fileState": Transfer status (String)
"isFolder": Folder information (Boolean)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"serverFileName": Save file name (sting)
"serverFilePath": Save folder path (String)
"uploadUrl": Upload URL (String)
},
]
“progress”: Progress (Number) / %
“retries”: Retry count (Number)
“speed”: Transfer speed(Number) /Byte/s
“state”: Status (String)
“stausMessage”:{
“errorCode”: Error code (Boolean/String)
“id”: Status title (String)
},
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Name

uploadCancel

Description

When the upload canceled.

Parameter

# JSON Object      
{
“files”:[ {	
"clientFileName": Displayed filename (String)
"clientFilePath": Attached file full path (String)
"boxId": File box ID (String)
"basePath": Attached path (String)
"customeValue": Customized value (String)
"fileSize": File size(Number) / Byte
"folderName": Folder name (String)
"fileState": Transfer status (String)
"isFolder": Folder information (Boolean)
"rootName": Folder name (String)
"rowID": File row index ID (String)
"serverFileName": Save file name (sting)
"serverFilePath": Save folder path (String)
"uploadUrl": Upload URL (String)
},
]
“progress”: Progress (Number) / %
“retries”: Retry count (Number)
“speed”: Transfer speed(Number) /Byte/s
“state”: Status (String)
“stausMessage”:{
“errorCode”: Error code (Boolean/String)
“id”: Status title (String)
},
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Name

uploadError

Description

When an error occurs while uploading.

- It is supported in the plugin mode.

Parameter

# JSON Object
{
“files”: Upload file info (Array)
[{
“clientFileName”: Displayed filename (String)
“clientFilePath”: Attached file full path (String)
“boxId”: File box ID (String)
“basePath”: Attached path (String)
“customeValue”: Customized value (String)
“fileSize”: File size(Number) / Byte
“folderName: Folder name (String)
“fileState”: Transfer status (String)
“isFolder”: Folder information (Boolean)
“rootName”: Folder name (String)
“rowID”: File row index ID (String)
“serverFileName”: Save file name (sting)
“serverFilePath”: Save folder path (String)
“uploadURL”: Upload URL (String)
}],
“progress”: Progress (Number) / %
“retries”: Retry count (Number)
“speed”: Transfer speed(Number) /Byte
“state”: Status (String)
“statusMessage”: Status (Object)
{
errorCode: Error code (String)
id: Transfer status (String)
},
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Name

downloadStart

Description

When the download started.

Parameter

# JSON Object  
{
“files”:[{
"downloadUrl ": Download URL (String) 
"fileSize ": File size (Number) / Byte
"id": File ID (String)
"mode": Transfer mode (String)
"printFileName": Displayed filename (String)
"rowID": File row index ID (String)
"selected": Selected or not (Boolean)
"sliceSize": Slice size (Number) / Byte
"transferType": Transfer mode (String)
"validate": Validate the file (Boolean)
},
]
“progress”: Progress (Number) / %
“retries”: Retry count (Number) / Times
“speed”: Transfer speed(Number) /Byte/s
“state”: Status (String)
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Name

downloadComplete

Description

When the download completed.

- It is supported in the plugin mode.

Parameter

# JSON Object
{
“files”: Download file info (Array)
[{
“boxId”: File box ID (String)
“ ubfolde”: Download file name (String)
“filePath”: Save folder path (String)
“fileState”: Transfer status (String)
“fileURL”: Download URL (String)
“isFolder”: Folder information (Boolean)
“origFileSize”: Original file size(Number) / Byte
“rowID”: File row index ID (String)
“saveFileSize”: Save file size (Number) / Byte
},]
“progress”: Progress (Number) / %
“retries”: Retry count (Number) / Times
“speed”: Transfer speed(Number) /Byte/s
“state”: Status (String)
“stausMessage”: Status (Object)
{ 
“errorCode”: Error code (Boolean/String)
“id”: Transfer status (String)
},
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Name

downloadCancel

Description

When the download canceled.

- It is supported in the plugin mode.

Parameter

# JSON Object
{
“files”: Download file info (Array)
[{
“boxId”: File box ID (String)
“ ubfolde”: Download file name (String)
“filePath”: Save folder path (String)
“fileState”: Transfer status (String)
“fileURL”: Download URL (String)
“isFolder”: Folder information (Boolean)
“origFileSize”: Original file size(Number) / Byte
“rowID”: File row index ID (String)
“saveFileSize”: Save file size (Number) / Byte
},]
“progress”: Progress (Number) / %
“retries”: Retry count (Number) / Times
“speed”: Transfer speed(Number) /Byte/s
“state”: Status (String)
“stausMessage”: Status (Object)
{ 
“errorCode”: Error code (Boolean/String)
“id”: Transfer status (String)
},
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Name

downloadError

Description

When an error occurs while downloading.

- It is supported in the plugin mode.

Parameter

# JSON Object
{
“files”: Download file info (Array)
[{
“boxId”: File box ID (String)
“ ubfolde”: Download file name (String)
“filePath”: Save folder path (String)
“fileState”: Transfer status (String)
“fileURL”: Download URL (String)
“isFolder”: Folder information (Boolean)
“origFileSize”: Original file size(Number) / Byte
“rowID”: File row index ID (String)
“saveFileSize”: Save file size (Number) / Byte
}],
“progress”: Progress (Number) / %
“retries”: Retry count (Number) / Times
“speed”: Transfer speed(Number) /Byte/s
“state”: Status (String)
“stausMessage”: Status (Object)
{ 
“errorCode”: Error code (Boolean/String)
“id”: Transfer status (String)
},
“totalSize”: Total size (Number) / Byte
“transferID”: Transfer ID (String)
“transferSize”: Transfer size (Number) / Byte
“type”: Transfer mode (String)
}

Back-end events

Upload

Name

getFileInfo

Description

When the upload is started in the server.

Parameter

_action			// Upload action flag
_origin_filename		// Original file name
_filesize			// File size
_folder			// Folder information
_clientpath			// Attached file client path
_compressed		// Compressed file
_rootPath			// Root path
_subdir			// Sub directory path
_encrypt			// Encrypt transfer
_transferId			// Transfer ID
_slice_transfer		// Slice transfer use
_duplicationFile		// Duplicate file policy
_empty_folder		// Empty folder information

Name

attachFile

Description

Each file transfer status while uploading.

Parameter

_action			// Upload action flag
_origin_filename		// Original file name
_new_filename		// Save file name
_filesize			// File size
_folder			// Folder information
_clientpath			// Attached file client path
_serverpath		// Attached file save path
_compressed		// Compressed file
_rootPath			// Root path
_subdir			// Sub directory path
_encrypt			// Encrypt transfer
_transferId			// Transfer ID
_slice_transfer		// Slice transfer use
_duplicationFile		// Duplicate file policy
_empty_folder		// Empty folder information
_cookie			// Session cookie information
_start_offset		// Slice start point
_end_offset		// Slice end point
_orig_start_offset		// Resume transfer start point

Name

attachFileComplete

Description

When each file upload is completed.

Parameter

_action			// Upload action flag
_origin_filename		// Original file name
_new_filename		// Save file name
_filesize			// File size
_folder			// Folder information
_filepath			// Attached file save path
_compressed		// Compressed file
_rootPath			// Root path
_subdir			// Sub directory path
_encrypt			// Encrypt transfer
_transferId			// Transfer ID
_slice_transfer		// Slice transfer use
_duplicationFile		// Duplicate file policy
_empty_folder		// Empty folder information
_isfolder			// Folder information
_check_integrity		// Integrity transfer
_integrity_crc32		// Check crc32 value
_integrity_md5		// Check md5 value
_merging			// Merging