Lightning Aura Components Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
getError()
getName()
getParam()
getParams()
getReturnValue()
getState()
isBackground()
setAbortable()
setBackground()
setCallback()
setParam()
setParams()
setStorable()
Newer Version Available
Action
Action contains methods to work with JavaScript
actions that you can use to communicate with Apex classes.
Methods
-
getError()
Returns an array of error objects for server-side actions only. Each error object has a message field. In any mode except PROD mode, each object also has a stack field, which is a list describing the execution stack when the error occurred. -
getName()
Returns the name of an action. -
getParam()
Returns an action parameter value for a parameter name. -
getParams()
Returns the collection of parameters for an action. -
getReturnValue()
Gets the return value of an Apex action. An Apex action can return any object containing serializable JSON data. -
getState()
Returns the current state of an action. Check the state of the action in the callback after an Apex action completes. -
isBackground()
Returns true if the action is enqueued in the background, false if it’s enqueued in the foreground. -
setAbortable()
Sets an action as abortable. If the component is not valid, abortable actions are not sent to the server. A component is automatically destroyed and marked invalid by the framework when it is unrendered. Actions not marked abortable are always sent to the server regardless of the validity of the component. -
setBackground()
Sets the action to run as a background action. This cannot be unset. Background actions are usually long running and lower priority actions. A background action is useful when you want your app to remain responsive to a user while it executes a low priority, long-running action. A rough guideline is to use a background action if it takes more than five seconds for the response to return from the server. -
setCallback()
Sets the callback function that is executed after an Apex action returns. -
setParam()
Sets a single parameter for an action. Use parameters to pass data to an Apex action. -
setParams()
Sets parameters for an action. Use parameters to pass data to an Apex action. -
setStorable()
Marks an Apex action as storable to have its response stored in the framework’s client-side cache . Enhance your component’s performance by marking actions as storable (cacheable) to quickly show cached data from client-side storage without waiting for a server trip. If the cached data is stale, the framework retrieves the latest data from the server. Caching is especially beneficial for users on high latency, slow, or unreliable connections such as 3G networks.