Home > @i2analyze/i2connect > IAsyncState
IAsyncState interface
A collection of methods through which an i2 Connect service method can communicate with a user who initiated a long-running operation.
Signature:
export interface IAsyncState
Introduced: API version 1.0
Remarks
The i2 Connect server injects an IAsyncState object when the async property is set to true in the @service decorator, and one of the service method parameters has the @asyncState decorator.
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 IAsyncState object. |