Class orion.status.StatusReportingService

Service for reporting status
Defined in: </shared/eclipse/e4/orion/I201107200200/plugins/org.eclipse.orion.client.core/web/orion/status.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	orion.status.StatusReportingService(serviceRegistry, domId, progressDomId) Service for reporting status

Method Summary
Method Attributes	Method Name and Description
	setErrorMessage(st) Displays an error message to the user.
	setMessage(msg, Number) Displays a status message to the user.
	setProgressMessage(message) Set a message that will be shown in the progress reporting area on the page.
	setProgressResult(message) Set a message that indicates that a long-running (progress) task is complete.
	showWhile(deferred, message) Shows a progress message until the given deferred is resolved.

Class Detail

orion.status.StatusReportingService(serviceRegistry, domId, progressDomId)

Service for reporting status

Parameters:
{orion.serviceregistry.ServiceRegistry} serviceRegistry
{String} domId: ID of the DOM node under which status will be displayed.
{String} progressDomId: ID of the DOM node used to display progress messages.

Method Detail

setErrorMessage(st)

Displays an error message to the user.

Parameters:
{String|dojoError|orionError} st: The error to display. Can be a simple String, or an error object from a dojo XHR error callback, or the body of an error response from the Orion server.

setMessage(msg, Number)

Displays a status message to the user.

Parameters:
{String} msg: Message to display.
Number Optional: timeout Optional time to display the message before hiding it.

setProgressMessage(message)

Set a message that will be shown in the progress reporting area on the page.

setProgressResult(message)

Set a message that indicates that a long-running (progress) task is complete.

Parameters:
{String|dojoError|orionError} message: The error to display. Can be a simple String, or an error object from a dojo XHR error callback, or the body of an error response from the Orion server.

showWhile(deferred, message)

Shows a progress message until the given deferred is resolved. Returns a deferred that resolves when the operation completes.

Classes