Visualforce Developer Guide

Introducing Visualforce
Tools for Visualforce Development
Getting a Quick Start with Visualforce
Customizing the Appearance and Output of Visualforce Pages
Standard Controllers
Standard List Controllers
Custom Controllers and Controller Extensions
Advanced Examples
Override Buttons, Links, and Tabs with Visualforce
Using Static Resources
Creating and Using Custom Components
Dynamic Visualforce Bindings
Dynamic Visualforce Components
Integrate Email with Visualforce
Visualforce Charting
Creating Maps with Visualforce
Render Flows with Visualforce
Templating with Visualforce
Developing Salesforce Apps with Visualforce
Adding Visualforce to a Salesforce AppExchange App
Using JavaScript in Visualforce Pages
Using $Component to Reference Components from JavaScript
Using JavaScript Libraries with Visualforce
JavaScript Remoting for Apex Controllers
What Is JavaScript Remoting?
When to Use JavaScript Remoting
Adding JavaScript Remoting to a Visualforce Page
Declaring a Remote Method in Apex
Scope and Visibility of @RemoteAction Methods
Remote Methods and Inheritance
Declaring a Remote Method with Interface Parameters
Handling the Remote Response
Debugging JavaScript Remoting
JavaScript Remoting Limits and Considerations
JavaScript Remoting Example
Common Visualforce JavaScript Remoting API Validation Errors
Visualforce Remote Objects
Communicating Across the DOM with Lightning Message Service
Visualforce Best Practices
Standard Visualforce Component Reference
Appendices
PDF

Newer Version Available

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

Declaring a Remote Method in Apex

You can call almost any Apex method as a JavaScript remoting remote action. To do so, the method needs to conform to some simple rules.
In your controller, your Apex method declaration is preceded with the @RemoteAction annotation like this:
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.

Methods used for JavaScript remoting must be uniquely identified by name and number of parameters; overloading isn’t possible. For instance, with the method above, you can’t also have a getItemId(Integer productNumber) method. Instead, declare multiple methods with different names:
  • getItemIdFromName(String objectName)
  • getItemIdFromProductNumber(Integer productNumber)