Module: alfresco/renderers/ProgressActions

alfresco/renderers/ProgressActions

This renderer is specifically designed report progress to the user. It was originally written to support the download folder action in Alfresco Share so it's default configuration (e.g. labels, topics and payload properties) are intended for that purpose. To use this widget for reporting the progress on alternative activities then the default configuration should be overridden.

The requestProgressTopic should be configured as the topic to publish to begin requesting progress information to be generated.

Author:
  • David Webster
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Members

completedMessage :string

The message to display when progress is complete.
Type:
  • string
Default Value:
  • "renderer.progress.complete"
Source:

creatingMessage :string

The message to display when progress is being initialized. By default this includes a message that was originally created to support the original use-case for reporting progress on generating an archive to download. This should be overridden for alternative use cases.
Type:
  • string
Default Value:
  • "renderer.progress.creating"
Source:

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/Progress.css"}]
Source:

doneProperty :string

The dot-notation address of the property in the progress publication that contains the amount "done". This is expected to be an integer.
Type:
  • string
Default Value:
  • "response.done"
Source:

errorMessage :string

The message to display when an error occurs reporting progress.
Type:
  • string
Default Value:
  • "renderer.progress.error"
Source:

i18nRequirements :object[]

An array of the i18n files to use with this widget.
Type:
  • object[]
Default Value:
  • [{i18nFile: "./i18n/Progress.properties"}]
Source:

<readonly> isCancelled :boolean

Whether the task(s) have been cancelled
Type:
  • boolean
Since:
  • 1.0.44
Default Value:
  • false
Source:

itemsAddedProperty :string

The dot-notation address of the property in the progress publication that contains the number of items completed towards the target.
Type:
  • string
Default Value:
  • "response.filesAdded"
Source:

progressCancelledTopic :string

The topic to publish on to indicate that the task has been cancelled
Type:
  • string
Default Value:
  • "ALF_PROGRESS_CANCELLED"
Source:

progressCompleteTopic :string

The topic to publish on to indicate the task has completed.
Type:
  • string
Default Value:
  • "ALF_PROGRESS_COMPLETED"
Source:

progressErrorTopic :string

The topic to publish on to indicate that there has been an error processing the task
Type:
  • string
Default Value:
  • "ALF_PROGRESS_ERROR"
Source:

progressUpdateTopic :string

The topic to publish on to provide progress updates.
Type:
  • string
Default Value:
  • "ALF_PROGRESS_UPDATED"
Source:

renderProgressUITopic :String

renderProgressUI
Type:
  • String
Default Value:
  • "ALF_PROGRESS_RENDER"
Source:

requestProgressTopic :string

This is the topic that will be published to request the start of progress updates. It will publish a payload on this topic containing scoped topics that should be used to provide update, [completion]{@link module:alfresco/renderers/Progress#progressCompleteTopic}, cancellation and [error]{@link module:alfresco/renderers/Progress#progressErrorTopic} events.
Type:
  • string
Default Value:
  • null
Source:

statusMessage :string

The message to display that reports the current status. This message will be provided two tokens that indicate the number of items processed and the total number of items to process.
Type:
  • string
Default Value:
  • "renderer.progress.status"
Source:

totalItemsProperty :string

The dot-notation address of the property in the progress publication that contains the total number of items to process.
Type:
  • string
Default Value:
  • "response.totalFiles"
Source:

totalProperty :string

The dot-notation address of the property in the progress publication that contains the total amount "to do". This is expected to be an integer. The percentage complete will be measured by the value of the doneProperty divided by the value represented by this property.
Type:
  • string
Default Value:
  • "response.total"
Source:

Methods

cleanProgressListeners(payload)

Parameters:
Name Type Description
payload object
Source:

cleanUp(payload)

Parameters:
Name Type Description
payload object
Source:

createWidgetDom()

Overrides the inherited function to construct the DOM for the widget using native browser capabilities.
Since:
  • 1.0.101
Source:

displayUIMessage(message)

Display the specified message in the dialog
Parameters:
Name Type Description
message string
Source:

onProgressCancelled(payload)

Called when action has been cancelled.
Parameters:
Name Type Description
payload object
Source:

onProgressComplete(payload)

Called when progress is finished.
Parameters:
Name Type Description
payload object
Source:

onProgressError(payload)

Called when there has been a fatal error. Progress has stopped and will not resume. Error status contained in payload.errorMessage.
Parameters:
Name Type Description
payload object
Source:

onProgressUpdate(payload)

Called when progress returns & updates progress dialog.
Parameters:
Name Type Description
payload object
Source:

onRenderUI(payload)

Called to update the UI with the data.
Parameters:
Name Type Description
payload object
Source:

onRequestProgress()

Called when progress returns & updates progress dialog.
Source:

postCreate() → {object}

Sets up the form specific configuration for the dialog.
Source:
Returns:
The dialog configuration.
Type
object

updateProgressBar(percentageRemaining)

Parameters:
Name Type Description
percentageRemaining number
Source: