Newer Version Available

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

Returning Data from an Apex Server-Side Controller

Return results from a server-side controller to a client-side controller using the return statement. Results data must be serializable into JSON format.
Return data types can be any of the following.

Returning Apex Objects

Here’s an example of a controller that returns a collection of custom Apex objects.

When an instance of an Apex class is returned from a server-side action, the instance is serialized to JSON by the framework. Only the values of public instance properties and methods annotated with @AuraEnabled are serialized and returned.

For example, here’s a simple “wrapper” Apex class that contains a few details for an account record. This class is used to package a few details of an account record in a serializable format.
When returned from a remote Apex controller action, the Id and Name properties are defined on the client-side. However, because it doesn’t have the @AuraEnabled annotation, the Phone property isn’t serialized on the server side, and isn’t returned as part of the result data.