RhoConnect.js API Reference

RhoConnect.js API is implemented as public fields of a global RhoConnect object. Those are methods and ERRORS hash.

If you have properties in the class, list and define them here.

• login
• init
• logout
• isLoggedIn
• syncAllSources
• dataAccessObjects
• setModelNotification
• clearModelNotification
• setAllNotification
• clearAllNotification
• setObjectsNotification
• clearObjectsNotification
• addObjectNotify
• clearObjectsNotify
• RhoConnect.ERRORS

login

Returns a jQuery promise object.

Authenticates the RhoConnect application on the server. On success, the done handler is called. On failure, the fail handler is called with the following arguments:

• errCode - The error code value from RhoConnect.ERRORS.
• errorMessage - More detailed error message if available.

The syntax and parameters are as follows.

RhoConnect.login(username, password, doDataReset)

Example

function loginRhoConnect(username, password) {
    persistence.store.rhoconnect.config(persistence);
    return $.Deferred(function(dfr){
        // login with username, password, and a DB reset
        RhoConnect.login(username, password,
                new RhoConnect.SyncNotification(), true /*do db init*/).done(function(){
            // Init DB for the user on success
            initRhoconnect(username, false).done(function(){
                dfr.resolve();
            }).fail(function(errCode, err){
                alert('DB init error: ' +errCode);
                dfr.reject(errCode, err);
            });
        }).fail(function(errCode, err){
            //alert('RhoConnect login error: ' +errCode);
            dfr.reject(errCode, err);
        });
    }).promise();
}

init

Performs rhoconnect.js and data API initialization.

Returns a jQuery promise object. On success, the done handler is called. On failure, the fail handler is called with the following arguments:

• errCode - The error code value from RhoConnect.ERRORS.
• errorMessage - More detailed error message if available.

The syntax and parameters are as follows.

RhoConnect.init(modelDefinitions, dataApiType, syncProgressCallback)

Example

// RhoConnect.js initialization
function initRhoconnect(username, doReset) {
    return RhoConnect.init(modelDefinitions, 'persistencejs', doReset);
}

modelDefinitions is a hash, such as:

var modelDefinitions = [
        {
            name: 'User',
            fields: [
                {name: 'username',      type: 'string'},
                {name: 'email',         type: 'string'},
                {name: 'first_name',    type: 'string'},
                {name: 'last_name',     type: 'string'},
                {name: 'title',         type: 'string'},
                {name: 'company',       type: 'string'},
                {name: 'created_at',    type: 'string'},
                {name: 'updated_at',    type: 'string'}
            ]
       },
//...

logout

Disconnects the RhoConnect application from the server.

Returns a jQuery promise object. On success, the done handler is called. On failure, the fail handler is called with the following arguments:

• errCode - The error code value from RhoConnect.ERRORS.
• errorMessage - More detailed error message if available.

The syntax is as follows.

RhoConnect.logout()

isLoggedIn

Returns true if the application is logged in on the server.

RhoConnect.isLoggedIn()

syncAllSources

Synchronizes that application data with the RhoConnect server.

Returns a jQuery promise object. On success, the done handler is called. On failure, the fail handler is called with the following arguments:

• errCode - The error code value from RhoConnect.ERRORS.
• errorMessage - More detailed error message if available.

The syntax is as follows.

RhoConnect.syncAllSources()

Example

function sync(){
    RhoConnect.syncAllSources().done(function(){
        alert('sync successful');
    }).fail(function(errCode, err){
        alert('Data sync error: ' +errCode);
    });
}

dataAccessObjects

Returns the hash of data access objects which are data API specific. The returned hash contains:

• key - model name.
• value - An instance of one of the following objects.
• Ext.data.Store - for ‘extjs’ type of data API
• model - for ‘persistencejs’ type of data API

The syntax is as follows.

RhoConnect.dataAccessObjects()

Example

function pull_data(model) {
    // passed a model name, returns hash of data access objects.
    var store = RhoConnect.dataAccessObjects()[model];

    current_model = model;
    persistence.loadFromRhoConnect(function() {
        storeLoaded();
    });

setModelNotification

Set the handler for the exact model synchronization notification.

RhoConnect.setModelNotification(modelName, callback, removeAfterFire)

clearModelNotification

Resets the handler for the model synchronization notification.

RhoConnect.clearModelNotification(modelName)

setAllNotification

Sets the handler for all models synchronization notifications.

RhoConnect.setAllNotification(callback, removeAfterFire)

clearAllNotification

Reset handler for all models synchronization notifications.

RhoConnect.clearAllNotification()

setObjectsNotification

Set handler for all object change notifications.

RhoConnect.setObjectsNotification(callback, removeAfterFire)

clearObjectsNotification

Reset the handler for all object change notifications.

RhoConnect.clearObjectsNotification()

addObjectNotify

Subscribe an object for changes notification.

RhoConnect.addObjectNotify(modelName, objectId)

clearObjectsNotify

Unsubscribe all objects from changes notification.

RhoConnect.clearObjectsNotify()

RhoConnect.ERRORS

RhoConnect.ERRORS are defined as:

• ERR_NONE: ‘No error’
• ERR_NETWORK: ‘Network error’
• ERR_REMOTESERVER: ‘Remote server access error’
• ERR_RUNTIME: ‘Runtime error’
• ERR_UNEXPECTEDSERVERRESPONSE: ‘Unexpected server response’
• ERR_DIFFDOMAINSINSYNCSRC: ‘Different synchronization domain error’
• ERR_NOSERVERRESPONSE: ‘No server response’
• ERR_CLIENTISNOTLOGGEDIN: ‘Client not logged in’
• ERR_CUSTOMSYNCSERVER: ‘Custom sync server’
• ERR_UNATHORIZED: ‘Unauthorized access’
• ERR_CANCELBYUSER: ‘Canceled by user’
• ERR_SYNCVERSION: ‘Synchronization version error’
• ERR_GEOLOCATION: ‘Geolocation error’