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.

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

Note

Add the Apex class as a custom controller or a controller extension to your page.

1<apex:page controller="MyController" extension="MyExtension">

Adding a controller or controller extension grants access to all @RemoteAction methods in that Apex class, even if those methods aren’t used in the page. Anyone who can view the page can execute all @RemoteAction methods and provide fake or malicious data to the controller.

Warning

Then, add the request as a JavaScript function call. A simple JavaScript remoting invocation takes the following form.

1[namespace.]MyController.method(
2    [parameters...,]
3    callbackFunction,
4    [configuration]
5);

Table 1. Remote Request Elements
Element	Description
`namespace`	The namespace of the controller class. The namespace element is required if your organization has a namespace defined, or if the class comes from an installed package.
`MyController`, `MyExtension`	The name of your Apex controller or extension.
`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 handles 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 element 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:

1@RemoteAction
2global 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.

Apex Developer Guide

RemoteAction Annotation