Class orion.progress.ProgressService
Service for tracking operations changes
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/progress.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
orion.progress.ProgressService(serviceRegistry, operationsClient)
Service for tracking operations changes
|
Method Attributes | Method Name and Description |
---|---|
init(progressPane)
|
|
progress(deferred, operationName, progressMonitor)
|
|
removeOperation(operationLocation)
|
|
setProgressResult(result)
|
|
showWhile(promise, message, avoidDisplayError)
Shows a progress message until the given promise is resolved.
|
|
writeOperation(operationIndex, operation, deferred)
|
Class Detail
orion.progress.ProgressService(serviceRegistry, operationsClient)
Service for tracking operations changes
- Parameters:
- {orion.serviceregistry.ServiceRegistry} serviceRegistry
- {orion.operationsclient.OperationsClient} operationsClient
Method Detail
init(progressPane)
- Parameters:
- progressPane
progress(deferred, operationName, progressMonitor)
- Parameters:
- deferred
- operationName
- progressMonitor
removeCompletedOperations()
removeOperation(operationLocation)
- Parameters:
- operationLocation
setProgressResult(result)
- Parameters:
- result
{orion.Promise}
showWhile(promise, message, avoidDisplayError)
Shows a progress message until the given promise is resolved. Returns a promise that resolves when
the operation completes. If the given promise rejects, the default behavior is to show an error
message, but this can be suppressed by passing avoidDisplayError == true.
- Parameters:
- {orion.Promise} promise
- Promise to track
- {String} message
- Message to display
- {Boolean} avoidDisplayError
- Do not display error when promise is rejected
- Returns:
- {orion.Promise}
writeOperation(operationIndex, operation, deferred)
- Parameters:
- operationIndex
- operation
- deferred