JSProgressMonitor

Unknown macro: {td}

cancel()
Cancels the transfer process.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getCurrentBytesToTransfer()
Returns the number of bytes to transfer for the current file.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getCurrentFileIndex()
Returns the index of the current file being transferred.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getCurrentTransferredBytes()
Returns the number of bytes already transferred for the current file.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

getCurrentTransferredFileName()
Returns the name of the current file being transferred.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getTotalBytesToTransfer()
Returns the total bytes to transfer to or from the server (sum of all the files size)

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getTotalFilesToTransfer()
Returns the total number of files to transfer.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getTotalTransferredBytes()
Returns the total bytes already transferred (for all files)

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

isCanceled()
Returns true if the process was canceled.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

isFinished()
Returns true if the process is finished.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

setProgressCallBack(function, interval)
Sets a method to be called repeatedly at the given interval (in seconds), the method will receive an instance of this JSProgressMonitor updated with the latest values.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

setProgressCallBack(function, interval, delay)
Sets a method to be called repeatedly at the given interval (in seconds), the method will receive an instance of this JSProgressMonitor updated with the latest values.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

cancel

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

cancel

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

monitor.cancel();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCurrentBytesToTransfer

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getCurrentBytesToTransfer

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCurrentFileIndex

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getCurrentFileIndex

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCurrentTransferredBytes

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getCurrentTransferredBytes

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCurrentTransferredFileName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getCurrentTransferredFileName

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getTotalBytesToTransfer

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getTotalBytesToTransfer

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getTotalFilesToTransfer

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getTotalFilesToTransfer

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getTotalTransferredBytes

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getTotalTransferredBytes

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

isCanceled

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

isCanceled

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

isFinished

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

isFinished

Unknown macro: {span}

()

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setProgressCallBack

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

setProgressCallBack

Unknown macro: {span}

(function, interval)

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

{Function} function – the Function to call back at the specified interval
{Number} interval – the interval (in seconds) to use

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

JSProgressMonitor – this for chaining

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

// call the progressCallbackFuntion every 2 and a half seconds (with a delay of 200ms in developer):
monitor.setProgressCallBack(progressCallbackFunction, 2.5, (application.isInDeveloper() ? 200 : 0));

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setProgressCallBack

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}