Collection of operations which currently tracked by service and must be displayed on UI.
This collection is managed by trackStatus and changeStatus methods.
Current status of the service.
It is equal to OperationStatus.Progress if operationsList contains any operation. This means that mask can be displayed on UI for example.
When operationsList becomes empty this property becomes equal to OperationStatus.Done.
Specifies how much time must elapse from moment when operation becomes OperationStatus.Done to it's disappearing from UI.
In fact this is minimal time of operation visibility. If operation was completed right after progressDelayInterval it will be displayed at least specified in this property amount of milliseconds.
Specifies how much time must elapse from start of operation to it's appearance on UI.
This means that if operation was performed faster than that interval it wouldn't be displayed on UI at all.
This approach helps to avoid situations when mask is hided right after it was rendered since it can be pretty irritating.
true, if current status doesn't equal to OperationStatus.Done.
Changes tracked operation status.
operation identifier that was returned by trackStatus.
status that must be applied to operation.
In case when applied status doesn't equal to OperationStatus.Progress, operation will be deleted from operationsList after elementVisibilityInterval interval elapsed.
Registers operation for tracking.
operation description that must be displayed on UI.
identifier of setTimeout on elapsing of which operation will be added to operationsList
Global timing settings.
These settings are static and their values are copied to the properties of the same name for each instance of StatusTrackingService type.
So, changing of this settings will affect all instances of StatusTrackingService type that will be created after such changes. If you want to change settings of concrete object you can use it the same name properties.
Generated using TypeDoc
Used to manage operations which description must be displayed on UI.
It can be used to implement application-defined UI component to display visual mask that hides part of UI controls until some operations aren't completed.
The typical usage scenario is: