servoy sReturnTypes 2 100% height: 30px; 2 Supported Clients sWordList SmartClient sWordList WebClient sWordList NGClient
servoy sSummary 12% 30% 58% height: 30px; 3 Methods Summary Cancels the transfer process. Returns the number of bytes to transfer for the current file. Returns the index of the current file being transferred. Returns the number of bytes already transferred for the current file. Returns the name of the current file being transferred. Returns the total bytes to transfer to or from the server (sum of all the files size) Returns the total number of files to transfer. Returns the total bytes already transferred (for all files) Returns true if the process was canceled. Returns true if the process is finished. 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. 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.
function servoy sDetail 2 100% height:30px 2 Methods Details cancel name cancel() des sIndent Cancels the transfer process. ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow getCurrentBytesToTransfer name getCurrentBytesToTransfer() des sIndent Returns the number of bytes to transfer for the current file. {td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentFileIndex]\()
ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow getCurrentFileIndex name getCurrentFileIndex() des sIndent Returns the index of the current file being transferred. {td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentTransferredBytes]\()
ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow getCurrentTransferredBytes name getCurrentTransferredBytes() des sIndent Returns the number of bytes already transferred for the current file. {td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getCurrentTransferredFileName]\()
Returns ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow getCurrentTransferredFileName name getCurrentTransferredFileName() des sIndent Returns the name of the current file being transferred. {td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalBytesToTransfer]\()
Returns the ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow getTotalBytesToTransfer name getTotalBytesToTransfer() des sIndent 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 ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow getTotalFilesToTransfer name getTotalFilesToTransfer() des sIndent Returns the total number of files to transfer. {td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalTransferredBytes]\()
Returns the ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow getTotalTransferredBytes name getTotalTransferredBytes() des sIndent 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]\(progressCallbackFunction, interval, \[testDelay\])
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:padding=0px|width=100%}{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}{tr:id=des}{td}{sub-section:cancel_des|text=|trigger=button}{sub-section}{sub-section:cancel_des|trigger=none|class=sIndent}Cancels the transfer process.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:cancel_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:getCurrentBytesToTransfer_des|text=|trigger=button}{sub-section}{sub-section:getCurrentBytesToTransfer_des|trigger=none|class=sIndent}Returns the number of bytes to transfer for the current file.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentBytesToTransfer_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:getCurrentFileIndex_des|text=|trigger=button}{sub-section}{sub-section:getCurrentFileIndex_des|trigger=none|class=sIndent}Returns the index of the current file being transferred.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentFileIndex_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:getCurrentTransferredBytes_des|text=|trigger=button}{sub-section}{sub-section:getCurrentTransferredBytes_des|trigger=none|class=sIndent}Returns the number of bytes already transferred for the current file.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentTransferredBytes_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:getCurrentTransferredFileName_des|text=|trigger=button}{sub-section}{sub-section:getCurrentTransferredFileName_des|trigger=none|class=sIndent}Returns the name of the current file being transferred.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentTransferredFileName_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:getTotalBytesToTransfer_des|text=|trigger=button}{sub-section}{sub-section:getTotalBytesToTransfer_des|trigger=none|class=sIndent}Returns the total bytes to transfer to or from the server (sum of all the files size){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getTotalBytesToTransfer_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:getTotalFilesToTransfer_des|text=|trigger=button}{sub-section}{sub-section:getTotalFilesToTransfer_des|trigger=none|class=sIndent}Returns the total number of files to transfer.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getTotalFilesToTransfer_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:getTotalTransferredBytes_des|text=|trigger=button}{sub-section}{sub-section:getTotalTransferredBytes_des|trigger=none|class=sIndent}Returns the total bytes already transferred (for all files){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getTotalTransferredBytes_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:isCanceled_des|text=|trigger=button}{sub-section}{sub-section:isCanceled_des|trigger=none|class=sIndent}Returns true if the process was canceled.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isCanceled_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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}{tr:id=des}{td}{sub-section:isFinished_des|text=|trigger=button}{sub-section}{sub-section:isFinished_des|trigger=none|class=sIndent}Returns true if the process is finished.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isFinished_snc|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|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;}\(progressCallbackFunction, interval, \[testDelay\]){span}{td}{tr}{tr:id=des}{td}{sub-section:setProgressCallBack_des|text=|trigger=button}{sub-section}{sub-section:setProgressCallBack_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).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setProgressCallBack_snc|text=|trigger=button}{sub-section}{sub-section:setProgressCallBack_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setProgressCallBack_prs|text=|trigger=button}{sub-section}{sub-section:setProgressCallBack_prs|trigger=none|class=sIndent}progressCallbackFunction
interval
\[testDelay\]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setProgressCallBack_ret|text=|trigger=button}{sub-section}{sub-section:setProgressCallBack_ret|trigger=none|class=sIndent}[JSProgressMonitor]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setProgressCallBack_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setProgressCallBack_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setProgressCallBack_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setProgressCallBack_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} ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow isCanceled name isCanceled() des sIndent Returns true if the process was canceled. ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow isFinished name isFinished() des sIndent Returns true if the process is finished. ret Returns
sIndent clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow setProgressCallBack name setProgressCallBack(function, interval) des 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). prs Parameters
sIndent function the Function to call back at the specified interval interval the interval (in seconds) to use ret Returns
sIndent this for chaining clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow setProgressCallBack name setProgressCallBack(function, interval, delay) des 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). prs Parameters
sIndent function the Function to call back at the specified interval interval the interval (in seconds) to use delay adds a delay for testing purpose in Developer ret Returns
sIndent this for chaining clients Supported Clients
sIndent SmartClient,WebClient,NGClient sam Sample
sIdent javascript lastDetailRow