Returns true if the related list with the given listName is refreshed, false otherwise. When this method is called within the Salesforce console, only the related list with the given list name in the currently focused view will be refreshed. This method is only available in API version 28.0 or later.
| Name | Type | Description |
|---|
listName | string | The name of the related list to refresh. For example, Contact for Contacts related list or Activity for Open Activities related list.Note that to refresh a custom related list created from a custom lookup field, listName must specify the ID of the custom lookup field. |
callback | function | JavaScript method executed when the API method call is completed. |
| Name | Type | Description |
|---|
result | boolean | Returns true if the related list with the given name is refreshed, false otherwise. |
error | string | If the API call was successful, this variable is undefined. If the API call failed, this variable returns an error message. |
- This method cannot refresh related lists created from
<apex:relatedList>.
- This method cannot refresh a related list from an overridden Visualforce page in the Salesforce console.
- If called from within the Salesforce console, this method will only search for the related list to refresh in the currently focused view.