Child pages
  • JSProgressMonitor

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\ 

{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=des}{td}{sub-section:cancel_des|trigger=button|text=}{sub-section}{sub-section:cancel_des|trigger=none|class=sIndent}CancelsReplace the transfer process.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:cancel_snc|trigger=button|text=}{sub-section}{sub-section:cancel_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:cancel_prs|trigger=button|text=}{sub-section}{sub-section:cancel_prs|trigger=none|class=sIndent}{sub-section}{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=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{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-section}{div}{td}{tr}{builder-show}{tr:id=sam}{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}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentBytesToTransfer|class=node}{tr:id=name}{td}h6.getCurrentBytesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{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}ReturnsReplace the number of bytes to transfer for the current file.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-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getCurrentBytesToTransfer_ret|trigger=button|text=}{sub-section}{sub-section:getCurrentBytesToTransfer_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getCurrentBytesToTransfer_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentBytesToTransfer_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getCurrentBytesToTransfer_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentBytesToTransfer_link|trigger=none}{sub-section}{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=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=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}ReturnsReplace the index of the current file being transferred.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}ReturnsReplace the number of bytes already transferred for the current file.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}ReturnsReplace the name of the current file being transferred.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}ReturnsReplace the total bytes to transfer to or from the server (sum of all the files size)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}ReturnsReplace the total number of files to transfer.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}ReturnsReplace the total bytes already transferred (for all files)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() + ' )');
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=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}ReturnsReplace true if the process was canceled.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-show}{tr:id=sam}{td}*Sample*\\{sub-section:isCanceled_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isCanceled_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=isFinished|class=node}{tr:id=name}{td}h6.isFinished{td}{tr}{tr:id=sig}{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}ReturnsReplace true if the process is finished.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}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:isFinished_ret|trigger=button|text=}{sub-section}{sub-section:isFinished_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:isFinished_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isFinished_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:isFinished_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isFinished_link|trigger=none}{sub-section}{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}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. Can use an optional delay (for testing purpose in developer).Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{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}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{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.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, delay){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:setProgressCallBack-Function_Number_Number_des|trigger=button|text=}{sub-section}{sub-section:setProgressCallBack-Function_Number_Number_des|trigger=none|class=sIndent}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. Can use an optional delay (for testing purpose in developer).Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{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-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{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-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section: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=see}{td}*Also see*\\{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}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setProgressCallBack-Function_Number_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack-Function_Number_Number_link|trigger=none}{sub-section}{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}