(Quick Reference)
remoteFunction
Purpose
Creates a remote javascript function that can be assigned to a DOM event to call the remote method
Examples
Example controller for an application called
shop:
class BookControlller {
def list = {
[ books: Book.list( params ) ]
}
def show = {
[ book : Book.get( params['id'] ) ]
}
def bookByName = {
[ book : Book.findByName( params.bookName ) ] }
}Example usages for above controller:
$('mydiv').onclick = <g:remoteFunction action="show" id="1" />Example as a method call in GSP only:
<select onchange="${remoteFunction(action:'bookByName',update:[success:'great', failure:'ohno'], params:'\'bookName=\' + this.value' )}">
<option>first</option>
<option>second</option>
</select>Example changing the asynchronous option to false:
<select from="[1,2,3,4,5]" onchange="${remoteFunction(action:'bookByName', update:[success:'great', failure:'ohno'], options=[asynchronous:false]}" />Description
Attributes
action (optional) - the name of the action to use in the link, if not specified the default action will be linkedcontroller (optional) - the name of the controller to use in the link, if not specified the current controller will be linkedid (optional) - The id to use in the linkupdate (optional) - Either a map containing the elements to update for 'success' or 'failure' states, or a string with the element to update in which cause failure events would be ignoredbefore (optional) - The javascript function to call before the remote function callafter (optional) - The javascript function to call after the remote function callasynchronous (optional) - Whether to do the call asynchronously or not (defaults to true, specified in 'options' array)method (optional) - The method to use the execute the call (defaults to "post", specified in 'options' array)
Events
onSuccess (optional) - The javascript function to call if successfulonFailure (optional) - The javascript function to call if the call failedon_ERROR_CODE (optional) - The javascript function to call to handle specified error codes (eg on404="alert('not found!')")onUninitialized (optional) - The javascript function to call the a ajax engine failed to initialiseonLoading (optional) - The javascript function to call when the remote function is loading the responseonLoaded (optional) - The javascript function to call when the remote function is completed loading the responseonComplete (optional) - The javascript function to call when the remote function is complete, including any updates
Source
