Home > @i2analyze/i2connect > services > ILongRunningState
services.ILongRunningState interface
A collection of methods through which an i2 Connect service can communicate with a user who initiated a long-running operation.
Signature:
interface ILongRunningState
Introduced: API version 2.0
Remarks
The i2 Connect server provides an ILongRunningState object when the longRunning property is set to true in the addService() acquire callback.
Properties
| Property | Type | Description |
|---|---|---|
| isCanceled | boolean | Indicates whether the user has canceled the long-running operation. |
Methods
| Method | Description |
|---|---|
| addSubstatus(type, message) | Provides a piece of information about the progress of the long-running operation to the user. |
| clearSubstatuses() | Clears all the substatuses from the ILongRunningState object. |