Class UFQueueableActionAbstract

A base class implementation of IUFQueueableAction that can be used to implement actions. It adds support for IUFWeightedProgress.

Subclasses must implement the run method.

Hierarchy (view full)

Implements

Constructors

constructor

Accessors

progress progressWeight

Methods

run

Constructors

constructor

Accessors

progress

  • get progress(): number

  • The progress, a value between 0.0 and 1.0 (inclusive).

    Returns number

progressWeight

  • get progressWeight(): number

  • Gets the progress weight.

    Returns number

Methods

Abstract run

  • run(aToken): Promise<boolean>

  • Runs the action asynchronously.

    Parameters

    • aToken: IUFCancellationToken

      A cancellation token which the action can check while running if the action still can continue.

    Returns Promise<boolean>

    true if the action was successful, false if the action failed or was cancelled.

Settings

Member Visibility

Theme

On This Page

constructorprogressprogressWeightrun