Retrieving Records with Remote Objects

Retrieve records by calling retrieve() on a Remote Objects model instance.

retrieve() requires two arguments, one for query criteria and one for a callback handler.

1RemoteObjectModel.retrieve({criteria}, callback_function)

criteria can be a Remote Objects query object or a function that returns one. The following two calls are equivalent.

1var ct = new RemoteObjectModel();
2
3// Empty callback functions for simplicity
4ct.retrieve({where: {FirstName: {eq: 'Marc' }}}, function() {}); // query object
5
6ct.retrieve(function(){
7	return({where: {FirstName: {eq: 'Marc' }}});
8}, function() {}); // function returning query object

See Format and Options for Remote Objects Query Criteria for an explanation of the query object.

retrieve() doesn’t return a result directly. The callback function enables you to handle the server response asynchronously.

All server operations that use Remote Objects are performed asynchronously. Any code that depends on the request being completed, including handling returned results, must be placed in the callback function.

Note

Your callback function can accept up to three arguments.

1function callback(Error error, Array results, Object event) { // ... }

See Remote Objects Callback Functions for details about writing Remote Objects callback functions.

To retrieve records using dates, pass in the JavaScript date object to the query.

1var myDate = new Date('2017-01-20');
2ct.retrieve({where: {CloseDate: {eq: myDate}}}, function() {});

Visualforce Developer Guide

Retrieving Records with Remote Objects

See Also: