Abortable Actions

Marking an Action as Abortable

Mark a server-side action as abortable by using the setAbortable() method on the Action object in JavaScript. For example:

1var action = cmp.get("c.serverEcho");
2action.setAbortable();

setCallback() has a third parameter that registers the action state that will invoke the callback. If you don't specify the third argument for setCallback(), it defaults to registering the SUCCESS and ERROR states.To check for aborted actions in your callback and take appropriate action, such as logging the aborted action, call setCallback() with the ABORTED state set explicitly in the third argument. For example:

1// Process default action states
2action.setCallback(this, function(response) {
3    var state = response.getState();
4    if (state === "SUCCESS") {
5        // Alert the user with the value returned from the server
6        alert("From server: " + response.getReturnValue());
7    }
8    // process other action states
9});
10// Explicitly register callback for ABORTED
11action.setCallback(this,
12    function(response) {
13        alert("The action was aborted");
14    },
15    "ABORTED"
16);

Rapid Clicking

Imagine a navigation menu where each action is a potentially slow request to the server. A user may click on several navigation items quickly so that none of the server responses return before the subsequent click. If all the actions are marked as abortable, none of the callbacks will be called except for the last click. This improves user experience by avoiding flickering due to sequential rendering of multiple server responses.