Interface: ProgressItem

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

QuickNav

Fields


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

ProgressItem

Version:
  • 7.1.0
Since:
  • 4.0.0
Module:
  • ojprogresslist

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To use this interface, import as below.
import {ProgressItem} from "ojs/ojprogresslist";

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

This interface defines the API for oj.ProgressItem. It can be implemented in order to the track progress and status of an arbitrary task (e.g. a file being uploaded)

Fields

(static) EventType :string

ProgressItem event types
Properties:
Name Type Default Description
LOADSTART string loadstart Triggered when the progress start
PROGRESS string progress Triggered for upload progress events.
ABORT string abort Triggered when an upload has been aborted.
ERROR string error Triggered when an upload failed.
LOAD string load Triggered when an upload succeeded.
TIMEOUT string timeout Triggered when timeout has passed before upload completed
LOADEND string loadend Triggered when an upload completed (success or failure).

(static) Status :string

ProgressItem status
Properties:
Name Type Default Description
QUEUED string queued initial state before any progress events
LOADSTARTED string loadstarted upload is in progress
ABORTED string aborted upload aborted
ERRORED string errored upload failed
TIMEDOUT string timedout upload timeout
LOADED string loaded upload is completed

Methods

addEventListener(eventType, listener) → {void}

Attach an event handler
Parameters:
Name Type Description
eventType oj.ProgressItem.EventType eventType
listener EventListener The event listener to add.
Returns:
Type
void

removeEventListener(eventType, listener) → {void}

Detach an event handler
Parameters:
Name Type Description
eventType oj.ProgressItem.EventType eventType
listener EventListener The event listener to remove.
Returns:
Type
void