i2 Connect SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/i2connect > services > ILongRunningState > addSubstatus

    services.ILongRunningState.addSubstatus() method

    Provides a piece of information about the progress of the long-running operation to the user.

    Signature:

    addSubstatus(type: SubstatusType, message: string): ISubstatus;
    

    Introduced: API version 1.0

    Parameters

    Parameter Type Description
    type SubstatusType The type of the substatus.
    message string The message associated with the substatus.

    Returns:

    ISubstatus

    The substatus that was added to the ILongRunningState object.

    Remarks

    Substatuses make extra information available to the client. By polling the server during execution, the client can display the information to users. As well as adding substatus information, you can also update previously provided information by editing the object that this method returns.

    In this article
    Back to top © N. Harris Computer Corporation