i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > app > IApplication > runUntrackedMutations

    app.IApplication.runUntrackedMutations() method

    Warning: This API is now obsolete.

    Use the options-only overload and await the returned Promise instead.

    Queues a function that performs untracked mutations on the application contents at the next available opportunity, and can respond to the changes that the mutations cause.

    Signature:

    runUntrackedMutations(mutationHandler: UntrackedMutationHandler, responseHandler: MutationResponseHandler, options?: ITransactionOptions): Promise<IMutationResult>;
    

    Introduced: version 1.1

    Parameters

    Parameter Type Description
    mutationHandler UntrackedMutationHandler A function that performs one or more untracked mutations and reports on their success as a whole.
    responseHandler MutationResponseHandler A callback that receives the changes produced by the mutations.
    options ITransactionOptions (Optional) An object that can control the transaction.

    Returns:

    Promise<IMutationResult>

    A promise that is fulfilled with the result of the mutations if they complete successfully, or rejected if there is a problem performing them.

    Remarks

    A mutation is an operation that can read or modify the contents of the application. Untracked mutations are not added to the undo stack, and therefore cannot be undone.

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