Class orion.progress.ProgressService
Service for tracking operations changes
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.core/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 |
---|---|
followOperation(operationJson, deferred, operationLocation)
Checks every 2 seconds for the operation update.
|
|
followTopic(topic, topicListener)
Add a listener to be notified about a finish of a operation on given topic
|
|
Gets information when operations list was last updated.
|
|
init(progressPane)
|
|
removeOperation(operationLocation, operationId)
|
|
removeOperationFromTheList(operationId)
|
|
setProgressResult(result)
|
|
showWhile(deferred, message)
Shows a progress message until the given deferred is resolved.
|
|
writeOperation(operationj)
|
Class Detail
orion.progress.ProgressService(serviceRegistry, operationsClient)
Service for tracking operations changes
- Parameters:
- {orion.serviceregistry.ServiceRegistry} serviceRegistry
- {orion.operationsclient.OperationsClient} operationsClient
Method Detail
{dojo.Deferred}
followOperation(operationJson, deferred, operationLocation)
Checks every 2 seconds for the operation update.
- Parameters:
- operationJson
- {Object} json operation description to follow
- deferred
- {dojo.Deferred} [optional] deferred to be notified when operation is done, if not provided created by function
- operationLocation
- Returns:
- {dojo.Deferred} notified when operation finishes
followTopic(topic, topicListener)
Add a listener to be notified about a finish of a operation on given topic
- Parameters:
- topic
- {String} a topic to track
- topicListener
- {function} a listener to be notified NOTE: Notifications are not implemented yet!
{Date}
getLastListUpdate()
Gets information when operations list was last updated.
- Returns:
- {Date}
init(progressPane)
- Parameters:
- progressPane
removeCompletedOperations()
removeOperation(operationLocation, operationId)
- Parameters:
- operationLocation
- operationId
removeOperationFromTheList(operationId)
- Parameters:
- operationId
setProgressResult(result)
- Parameters:
- result
showWhile(deferred, message)
Shows a progress message until the given deferred is resolved. Returns a deferred that resolves when
the operation completes.
- Parameters:
- deferred
- {dojo.Deferred} Deferred to track
- message
- {String} Message to display
- Returns:
writeOperation(operationj)
- Parameters:
- operationj