RemoteAction Annotation

The RemoteAction annotation provides support for Apex methods used in Visualforce to be called via JavaScript. This process is often referred to as JavaScript remoting.

Note

Note

Methods with the RemoteAction annotation must be static and either global or public.

A simple JavaScript remoting invocation takes the following form.
[namespace.]controller.method(
    [parameters...,]
    callbackFunction,
    [configuration]
);
Table 1. Remote Request Elements
Element Description
namespace The namespace of the controller class. This is required if your organization has a namespace defined, or if the class comes from an installed package.
controller The name of your Apex controller.
method The name of the Apex method you’re calling.
parameters A comma-separated list of parameters that your method takes.
callbackFunction The name of the JavaScript function that will handle the response from the controller. You can also declare an anonymous function inline. callbackFunction receives the status of the method call and the result as parameters.
configuration Configures the handling of the remote call and response. Use this to change the behavior of a remoting call, such as whether or not to escape the Apex method’s response.
In your controller, your Apex method declaration is preceded with the @RemoteAction annotation like this:
@RemoteAction
global static String getItemId(String objectName) { ... }
Apex @RemoteAction methods must be static and either global or public.

Your method can take Apex primitives, collections, typed and generic sObjects, and user-defined Apex classes and interfaces as arguments. Generic sObjects must have an ID or sobjectType value to identify actual type. Interface parameters must have an apexType to identify actual type. Your method can return Apex primitives, sObjects, collections, user-defined Apex classes and enums, SaveResult, UpsertResult, DeleteResult, SelectOption, or PageReference.

For more information, see “JavaScript Remoting for Apex Controllers” in the Visualforce Developer's Guide.

Previous
Next