Page History

{hiddendiv:style=display:none}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACTAUTO CHANGES FROMUPDATE THE PAGECONTENT ANDTHROUGH MERGETHE THEM BACK INTO SERVOY SOURCE{hiddenDOC GENERATOR{div}
{sub-sectiondiv:id=description|text=}{sub-sectiondiv}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#cancel]\()
Cancels the transfer process.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentBytesToTransfer]\()
Returns the number of bytes to transfer for the current file.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentFileIndex]\()
Returns the index of the current file being transferred.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentTransferredBytes]\()
Returns the number of bytes already transferred for the current file.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getCurrentTransferredFileName]\()
Returns the name of the current file being transferred.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalBytesToTransfer]\()
Returns the total bytes to transfer to or from the server (sum of all the files size){td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalFilesToTransfer]\()
Returns the total number of files to transfer.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalTransferredBytes]\()
Returns the total bytes already transferred (for all files){td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isCanceled]\()
Returns true if the process was canceled.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isFinished]\()
Returns true if the process is finished.{td}{tr}{tbody}{tbody}{tr}{td}[JSProgressMonitor]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[JSProgressMonitor]{td}{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.{td}{tr}{tbody}{table}\\ 

{table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=cancel|class=node}{tr:id=name}{td}h6.cancel{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}cancel{span}{span:id=iets|style=float: left;}\()}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=desret}{td}{sub-section:cancel_des|trigger=button|text=}{sub-section}{sub-section:cancel_des|trigger=none|*Returns*\\{div:class=sIndent}Replace with description{sub-section[Boolean]{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sncsam}{td}*SinceSample*\\{sub-section:cancel_snc|trigger=button|text=}{sub-section}{sub-section:cancel_snc|trigger=none|class=sIndent} Replace with version info{sub-sectiondiv:class=sIndent}{code:language=javascript}
monitor.cancel();
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{builder-showtbody}{builder-showtbody:permissionid=editgetCurrentBytesToTransfer}{tr:id=prsname}{td}*Parameters*\\{sub-section:cancel_prs|trigger=button|text=}{sub-section}{sub-section:cancel_prs|trigger=none|class=sIndent}{sub-sectionh6.getCurrentBytesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getCurrentBytesToTransfer{span}{span}\(){span}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:cancel_ret|trigger=button|text=}{sub-section}{sub-section:cancel_ret|trigger=none|class=div:class=sIndent}[BooleanNumber]{sub-sectiondiv}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:cancel_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:cancel_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:cancel_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:cancel_link|trigger=none}{sub-sectioncode:language=javascript}
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!')
}
{code}{div}{td}{tr}{builder-show}{tr:idclass=samlastDetailRow}{td}*Sample*\\{sub-section:cancel_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:cancel_sam|trigger=none}{code:language=javascript}
monitor.cancel();
{code}{sub-section}{div}{{td}{tr}{tbody}{tbody:id=getCurrentFileIndex}{tr:id=name}{td}h6.getCurrentFileIndex{td}{tr}{tr:classid=lastDetailRowsig}{td}{td}{tr}{tbody}{tbody:id=getCurrentBytesToTransfer|class=node}{tr:id=name}{td}h6.getCurrentBytesToTransferspan:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getCurrentFileIndex{span}{span}\(){span}{td}{tr}{tr:id=sigret}{td}*Returns*\\{spandiv:style=float: left; margin-right: 5px;class=sIndent}[Number]{spandiv}{span:id=iets|style=float: left; font-weight: bold;}getCurrentBytesToTransfer{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getCurrentBytesToTransfer_des|trigger=button|text=}{sub-section}{sub-section:getCurrentBytesToTransfer_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentBytesToTransfer_snc|trigger=button|text=}{sub-section}{sub-section:getCurrentBytesToTransfer_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getCurrentBytesToTransfer_prs|trigger=button|text=}{sub-section}{sub-section:getCurrentBytesToTransfer_prs|trigger=none|class=sIndent}{sub-sectiontd}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
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!')
}
{code}{div}{td}{tr}{builder-show}{tr:id=retclass=lastDetailRow}{td}{td}*Returns*\\{sub-section:getCurrentBytesToTransfer_ret|trigger=button|text=}{sub-section}{sub-section:getCurrentBytesToTransfer_ret|trigger=none|class=sIndent}[Number]{sub-section}{tr}{tbody}{tbody:id=getCurrentTransferredBytes}{tr:id=name}{td}h6.getCurrentTransferredBytes{td}{tr}{builder-show:permission=edit}{tr:id=seesig}{td}*Also see*\\{sub-section:getCurrentBytesToTransfer_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentBytesToTransfer_see|trigger=none}{sub-section}{div{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getCurrentTransferredBytes{span}{span}\(){span}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External linksReturns*\\{sub-section:getCurrentBytesToTransfer_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentBytesToTransfer_link|trigger=none}{sub-section}{[Number]{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getCurrentBytesToTransfer_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentBytesToTransfer_sam|trigger=nonediv:class=sIndent}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentFileIndex|class=node}{tr:id=name}{td}h6.getCurrentFileIndex{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getCurrentFileIndex{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getCurrentFileIndex_des|trigger=button|text=}{sub-section}{sub-section:getCurrentFileIndex_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentFileIndex_snc|trigger=button|text=}{sub-section}{sub-section:getCurrentFileIndex_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getCurrentFileIndex_prs|trigger=button|text=}{sub-section}{sub-section:getCurrentFileIndex_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getCurrentFileIndex_ret|trigger=button|text=}{sub-section}{sub-section:getCurrentFileIndex_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getCurrentFileIndex_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentFileIndex_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getCurrentFileIndex_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentFileIndex_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getCurrentFileIndex_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentFileIndex_sam|trigger=none}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentTransferredBytes|class=node}{tr:id=name}{td}h6.getCurrentTransferredBytes{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getCurrentTransferredBytes{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getCurrentTransferredBytes_des|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredBytes_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentTransferredBytes_snc|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredBytes_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getCurrentTransferredBytes_prs|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredBytes_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getCurrentTransferredBytes_ret|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredBytes_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getCurrentTransferredBytes_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentTransferredBytes_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getCurrentTransferredBytes_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentTransferredBytes_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getCurrentTransferredBytes_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentTransferredBytes_sam|trigger=none}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentTransferredFileName|class=node}{tr:id=name}{td}h6.getCurrentTransferredFileName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getCurrentTransferredFileName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getCurrentTransferredFileName_des|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredFileName_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentTransferredFileName_snc|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredFileName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getCurrentTransferredFileName_prs|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredFileName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getCurrentTransferredFileName_ret|trigger=button|text=}{sub-section}{sub-section:getCurrentTransferredFileName_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getCurrentTransferredFileName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentTransferredFileName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getCurrentTransferredFileName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentTransferredFileName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getCurrentTransferredFileName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentTransferredFileName_sam|trigger=none}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTotalBytesToTransfer|class=node}{tr:id=name}{td}h6.getTotalBytesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getTotalBytesToTransfer{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getTotalBytesToTransfer_des|trigger=button|text=}{sub-section}{sub-section:getTotalBytesToTransfer_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getTotalBytesToTransfer_snc|trigger=button|text=}{sub-section}{sub-section:getTotalBytesToTransfer_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getTotalBytesToTransfer_prs|trigger=button|text=}{sub-section}{sub-section:getTotalBytesToTransfer_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getTotalBytesToTransfer_ret|trigger=button|text=}{sub-section}{sub-section:getTotalBytesToTransfer_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getTotalBytesToTransfer_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalBytesToTransfer_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getTotalBytesToTransfer_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalBytesToTransfer_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getTotalBytesToTransfer_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalBytesToTransfer_sam|trigger=none}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTotalFilesToTransfer|class=node}{tr:id=name}{td}h6.getTotalFilesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getTotalFilesToTransfer{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getTotalFilesToTransfer_des|trigger=button|text=}{sub-section}{sub-section:getTotalFilesToTransfer_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getTotalFilesToTransfer_snc|trigger=button|text=}{sub-section}{sub-section:getTotalFilesToTransfer_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getTotalFilesToTransfer_prs|trigger=button|text=}{sub-section}{sub-section:getTotalFilesToTransfer_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getTotalFilesToTransfer_ret|trigger=button|text=}{sub-section}{sub-section:getTotalFilesToTransfer_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getTotalFilesToTransfer_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalFilesToTransfer_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getTotalFilesToTransfer_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalFilesToTransfer_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getTotalFilesToTransfer_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalFilesToTransfer_sam|trigger=none}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTotalTransferredBytes|class=node}{tr:id=name}{td}h6.getTotalTransferredBytes{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getTotalTransferredBytes{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getTotalTransferredBytes_des|trigger=button|text=}{sub-section}{sub-section:getTotalTransferredBytes_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getTotalTransferredBytes_snc|trigger=button|text=}{sub-section}{sub-section:getTotalTransferredBytes_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getTotalTransferredBytes_prs|trigger=button|text=}{sub-section}{sub-section:getTotalTransferredBytes_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getTotalTransferredBytes_ret|trigger=button|text=}{sub-section}{sub-section:getTotalTransferredBytes_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getTotalTransferredBytes_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalTransferredBytes_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getTotalTransferredBytes_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalTransferredBytes_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getTotalTransferredBytes_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getTotalTransferredBytes_sam|trigger=none}{code:language=javascript}
application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )' ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentTransferredFileName}{tr:id=name}{td}h6.getCurrentTransferredFileName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getCurrentTransferredFileName{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current bytes transferredfile: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isCanceled|class=node}{tr:id=name}{td}h6.isCanceled{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}isCanceled{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:isCanceled_des|trigger=button|text=}{sub-section}{sub-section:isCanceled_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isCanceled_snc|trigger=button|text=}{sub-section}{sub-section:isCanceled_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:isCanceled_prs|trigger=button|text=}{sub-section}{sub-section:isCanceled_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:isCanceled_ret|trigger=button|text=}{sub-section}{sub-section:isCanceled_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:isCanceled_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isCanceled_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:isCanceled_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isCanceled_link|trigger=none}{sub-section}{div}{td}{tr}{builder-showmonitor.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!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTotalBytesToTransfer}{tr:id=name}{td}h6.getTotalBytesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getTotalBytesToTransfer{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{sub-section:isCanceled_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isCanceled_sam|trigger=none=sIndent}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isFinished|class=node:id=getTotalFilesToTransfer}{tr:id=name}{td}h6.getTotalFilesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getTotalFilesToTransfer{span}{span}\(){span}{td}{tr}{tr:id=nameret}{td}h6.isFinished*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sigsam}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}isFinished{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:isFinished_des|trigger=button|text=}{sub-section}{sub-section:isFinished_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isFinished_snc|trigger=button|text=}{sub-section}{sub-section:isFinished_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:isFinished_prs|trigger=button|text=}{sub-section}{sub-section:isFinished_prs|trigger=none|class=sIndent}{sub-section*Sample*\\{div:class=sIndent}{code:language=javascript}
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!')
}
{code}{div}{td}{tr}{builder-show}{tr:id=retclass=lastDetailRow}{td}{td}*Returns*\\{sub-section:isFinished_ret|trigger=button|text=}{sub-section}{sub-section:isFinished_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{tr}{tbody}{tbody:id=getTotalTransferredBytes}{tr:id=name}{td}h6.getTotalTransferredBytes{td}{tr}{builder-show:permission=edit}{tr:id=seesig}{td}*Also see*\\{sub-section:isFinished_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isFinished_see|trigger=none}{sub-section}{div{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getTotalTransferredBytes{span}{span}\(){span}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External linksReturns*\\{sub-section:isFinished_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isFinished_link|trigger=none}{sub-section}{[Number]{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:isFinished_sam|trigger=button|text=}{sub-section}\\{div:class=sIndent}{sub-section:isFinished_sam|trigger=none}{code:language=javascript}
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!')
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setProgressCallBack-Function_Number|class=node}{tr:id=name}{td}h6.setProgressCallBack{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSProgressMonitor]{span}{span:id=iets|style=float: left; font-weight: bold;}setProgressCallBack{span}{span:id=iets|style=float: left;}\(function, interval){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:setProgressCallBack-Function_Number_des|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_des|trigger=none|class=sIndent}Replace with description{sub-sectioncurrent bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{builder-show}{builder-show:permission=edittbody}{tbody:id=isCanceled}{tr:id=name}{td}h6.isCanceled{td}{tr}{tr:id=sncsig}{td}*Since*\\{sub-section:setProgressCallBack-Function_Number_snc|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isCanceled{span}{span}\(){span}{td}{tr}{builder-show}{tr:id=prsret}{td}*ParametersReturns*\\{sub-section:setProgressCallBack-Function_Number_prs|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_prs|trigger=none|class=sIndent}\{[Function]} function -- the Function to call back at the specified interval
\{[Number]} interval -- the interval (in seconds) to use
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setProgressCallBack-Function_Number_ret|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_ret|trigger=none|class=sIndent}[JSProgressMonitor] -- this for chaining{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setProgressCallBack-Function_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack-Function_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setProgressCallBack-Function_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack-Function_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setProgressCallBack-Function_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack-Function_Number_sam|trigger=none}{code:language=javascript}
// 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));
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setProgressCallBack-Function_Number_Number|class=node}{tr:id=name}{td}h6.setProgressCallBackdiv:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
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!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isFinished}{tr:id=name}{td}h6.isFinished{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isFinished{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
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!')
}
{code}{div}{td}{tr}{tr:idclass=siglastDetailRow}{td}{span:style=float: left; margin-right: 5px;}[JSProgressMonitor]{span}{span:id=iets|style=float: left; font-weight: bold;}setProgressCallBack{span}{span:id=iets|style=float: left;}\(function, interval, delay){span}{td}{tr}{builder-show:permission=edittd}{tr}{tbody}{tbody:id=setProgressCallBack-Function_Number}{tr:id=name}{td}h6.setProgressCallBack{td}{tr}{tr:id=dessig}{td}{sub-section:setProgressCallBack-Function_Number_Number_des|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_Number_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=editspan:style=margin-right: 5px;}[JSProgressMonitor]{span}{span:style=font-weight: bold;}setProgressCallBack{span}{span}\(function, interval){span}{td}{tr}{tr:id=sncprs}{td}*SinceParameters*\\{sub-section:setProgressCallBack-Function_Number_Number_snc|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-sectiondiv:class=sIndent}\{[Function]} function -- the Function to call back at the specified interval
\{[Number]} interval -- the interval (in seconds) to use
{div}{td}{tr}{builder-show}{tr:id=prsret}{td}*ParametersReturns*\\{sub-section:setProgressCallBack-Function_Number_Number_prs|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_Number_prs|trigger=none|class=sIndent}\{[Function]} function -- the Function to call back at the specified interval
\{[Number]} interval -- the interval (in seconds) to use
\{[Number]} delay -- adds a delay for testing purpose in Developer
{sub-sectiondiv:class=sIndent}[JSProgressMonitor] -- this for chaining{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
// 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));
{code}{div}{td}{tr}{tr:id=retclass=lastDetailRow}{td}{td}*Returns*\\{sub-section:}{tr}{tbody}{tbody:id=setProgressCallBack-Function_Number_Number_ret|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_Number_ret|trigger=none|class=sIndent}[JSProgressMonitor] -- this for chaining{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=name}{td}h6.setProgressCallBack{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSProgressMonitor]{span}{span:style=font-weight: bold;}setProgressCallBack{span}{span}\(function, interval, delay){span}{td}{tr}{tr:id=seeprs}{td}*Also seeParameters*\\{sub-section:setProgressCallBack-Function_Number_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack-Function_Number_Number_see|trigger=none}{sub-section}div:class=sIndent}\{[Function]} function -- the Function to call back at the specified interval
\{[Number]} interval -- the interval (in seconds) to use
\{[Number]} delay -- adds a delay for testing purpose in Developer
{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External links*\\{sub-section:setProgressCallBack-Function_Number_Number_link|trigger=button|text=}{sub-section}Returns*\\{div:class=sIndent}{sub-section:setProgressCallBack-Function_Number_Number_link|trigger=none}{sub-section}[JSProgressMonitor] -- this for chaining{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setProgressCallBack-Function_Number_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack-Function_Number_Number_sam|trigger=none}{code:language=javascript}
// 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));
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}