1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. AppProgressEvent

AppProgressEvent

    ProgressEvent is emitted when a potentially long-running engine process is in progress.

    Properties

    • type enum required
      The type of process (e.g. plugin download, plugin install).
      Values: plugin-download, plugin-install
    • id string required
      A unique identifier for the process.
    • message string required
      A message accompanying the process.
    • received integer required
      The number of items completed so far (e.g. bytes received, items installed, etc.)
    • total integer required
      The total number of items that must be completed.
    • done boolean required
      True if and only if the process has completed.