Newer Version Available
Configuring a JavaScript Remoting Request
Configure a remoting request by providing an object with configuration settings when you
declare the remoting request.
For example, the default configuration parameters look like
this:
These
configuration parameters aren’t ordered, and you can omit parameters you don’t want to change
from the default.
1{ buffer: true, escape: true, timeout: 30000 }JavaScript remoting supports the following
configuration parameters:
| Name | Data Type | Description |
|---|---|---|
| buffer | Boolean | Whether to group requests executed close to each other in time into a single request.
The default is true. JavaScript remoting optimizes requests that are executed close to each other in time and groups the calls into a single request. This buffering improve the efficiency of the overall request-and-response cycle, but sometimes it’s useful to ensure all requests execute independently. |
| escape | Boolean | Whether to escape the Apex method’s response. The default is true. |
| timeout | Integer | The timeout for the request, in milliseconds. The default is 30,000 (30 seconds). The maximum is 120,000 (120 seconds, or 2 minutes). |
The request timeout can also be configured for all requests made by a page, by setting the
timeout using the Visualforce remoting
object:
1<script type="text/javascript">
2
3 Visualforce.remoting.timeout = 120000; // Set timeout at page level
4
5 function getRemoteAccount() {
6 var accountName = document.getElementById('acctSearch').value;
7
8 // This remoting call will use the page's timeout value
9 Visualforce.remoting.Manager.invokeAction(
10 '{!$RemoteAction.AccountRemoter.getAccount}',
11 accountName,
12 handleResult
13 );
14 }
15
16 function handleResult(result, event) { ... }
17</script>Override a page-level timeout configuration on a per-request basis by setting the timeout in the configuration object for that request, as described above.