Lightning Aura Components Developer Guide

What Is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Testing Components with Lightning Testing Service
Debugging
Performance
Reference
Component Library
System Tag Reference
JavaScript API
$A namespace
createComponent()
createComponents()
enqueueAction()
error()
get()
getCallback()
getComponent()
getReference()
getRoot()
getToken()
log()
reportError()
run()
set()
warning()
Action
AuraLocalizationService
Component
Event
Util
PDF

Newer Version Available

This content describes an older version of this product. View Latest

enqueueAction()

Queue a call to an Apex action . The framework queues up actions before sending them to the server. This mechanism is largely transparent to you when you’re writing code but it enables the framework to minimize network traffic by batching multiple actions into one request (XHR).

The batching of actions is also known as boxcar’ing, similar to a train that couples boxcars together.

The framework uses a stack to keep track of the actions to send to the server. When the browser finishes processing events and JavaScript on the client, the enqueued actions on the stack are sent to the server in a batch.

Signature

enqueueAction (Action action, Boolean background)

Parameters

action
Type: Action
The action to enqueue.
background
Type: Boolean
Deprecated. Do not use.