Class OperationProgressTracker

Constructors

constructor

Accessors

operationId wasDisposed

Methods

dispose prepare start wait

Constructors

constructor

  • new OperationProgressTracker(
        operationService: IOperationService,
        onProgress: null | (val: number) => Promise<void>,
        options?: {
            createParams?: OperationCreateParams;
            deleteOperationOnDispose?: boolean;
            interval?: number;
            operationId?: string;
        },
    ): OperationProgressTracker

    Parameters

    • operationService: IOperationService
    • onProgress: null | (val: number) => Promise<void>
    • Optionaloptions: {
          createParams?: OperationCreateParams;
          deleteOperationOnDispose?: boolean;
          interval?: number;
          operationId?: string;
      }

    Returns OperationProgressTracker

Accessors

operationId

  • get operationId(): null | string

    Returns null | string

wasDisposed

  • get wasDisposed(): boolean

    Returns boolean

Methods

dispose

  • dispose(): void

    Returns void

prepare

  • prepare(): Promise<void>

    Returns Promise<void>

start

  • start(): Promise<boolean>

    Returns Promise<boolean>

wait

  • wait(): Promise<boolean>

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods