mobileservice

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

Unknown macro: {table}

Unknown macro: {tr}

Unknown macro: {th}

Return Types

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

OfflineDataDescription

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

OfflineDataDescription

Unknown macro: {td}

createOfflineDataDescription()
Create a descriptive model for offline data.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

OfflineDataDescription

Unknown macro: {td}

createOfflineDataDescription(prefix)
Create a descriptive model for offline data.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Array

Unknown macro: {td}

getRowDescriptions(fs, pks)
This method returns the description of rows as a json array object.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

performSync(data, version, authenticateResult)
If all the changes for a mobile client needs to come as once so that they can be in 1 transaction.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createOfflineDataDescription

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

OfflineDataDescription

Unknown macro: {span}

createOfflineDataDescription

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Create a descriptive model for offline data.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

OfflineDataDescription

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//plugins.mobile.getOfflineFoundSetData(foundset,null);
var data = plugins.mobileservice.createOfflineDataDescription('data_');

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createOfflineDataDescription

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

OfflineDataDescription

Unknown macro: {span}

createOfflineDataDescription

Unknown macro: {span}

(prefix)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Create a descriptive model for offline data.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} prefix – specified formname prefix used to retrieve row data from REST wise

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

OfflineDataDescription

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//plugins.mobile.getOfflineFoundSetData(foundset,null);
var data = plugins.mobileservice.createOfflineDataDescription('data_');

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getRowDescriptions

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Array

Unknown macro: {span}

getRowDescriptions

Unknown macro: {span}

(fs, pks)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

This method returns the description of rows as a json array object.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFoundSet} fs – the foundset
{Object[]} pks – the array of pks

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Array

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

/** @type {Array<Object>} */
var idsArray = new Array(100,200,300);
foundset.loadAllRecords();
var json = plugins.mobileservice.getRowDescriptions(foundset, idsArray)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

performSync

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

performSync

Unknown macro: {span}

(data, version, authenticateResult)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

If all the changes for a mobile client needs to come as once so that they can be in 1 transaction. Then the offline_data form should define a ws_update method.
This method will then get the complete data package which should be give to this function.
This will redispatch all the inserts,updates or deletes to the various data forms that has the real rest methods to handle the actual insert.
If something fails then an Exception will be thrown and you can do a rollback so that everything of this sync is reverted.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} data – The data package that is given to the offline_data form ws_update method.
{Number} version – The version number that is given to the offline_data form ws_update method.
{Object} authenticateResult – The authenticateResult object that is given to the offline_data form ws_update method. (generated by the offline_data.ws_authenticate)

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

try {
   databaseManager.startTransaction();
   plugins.mobileservice.performSync(data,version,authenticateResult);
   databaseManager.commitTransaction();
} catch (e) {
   databaseManager.rollbackTransaction();
   // log the error and return false to that the mobile client will know the sync did fail.
   application.output(e,LOGGINGLEVEL.ERROR);
   return false;
}

Unknown macro: {tr}

Unknown macro: {td}

Child pages

mobileservice

createOfflineDataDescription

createOfflineDataDescription

getRowDescriptions

performSync