Invoking a Sync Service

Prerequisites

Download the required Quantum Fabric Sync JS files for Cordova, and perform Init and relevant Sync operations.

To download Quantum Fabric Sync JS files, follow these steps:

1. In your Quantum Fabric portal > Apps > Publish tab, navigate to your published app.
2. Click Download, and then click Sync client Code (PhoneGap) shown below:

   

   The system prompts you to save the zip (for example, Sync_kony.zip) file into your local system.

3. Extract the zip file that you just downloaded. The zip file contains KonySyncDDL.js  and  KonySyncScopes.js, and respective model files that are specific to an application.

4. Include these JS files in your app by using the following script tag. For example:

    
   //say the files are KonySyncDDL.js and KonySyncScopes.js that are placed in a folder called "js"
   
   < script type = "text/javascript"
   src = "js/KonySyncDDL.js" < /script>
   
   <script type="text/javascript
   " src="
   js / KonySyncScopes.js "</script>
   
   
   
   // say there is one model file called as CustomerModel.js
   
   <script type="
   text / javascript " src="
   js / CustomerModel.js "</script>

Use the following code for instantiating sync object to call sync related APIs.

 
//Sample code to instantiate sync services

syncObj = konySDKObj.getSyncService();

The syncObj can call sync related APIs, as shown below:

Init

This method creates backend mobile SQLite database.

 syncObj.init (syncInitSuccessCallback, syncInitFailureCallback);

For more information, refer to Sync Framework Documentation > sync.init.

startSession

This method initiates bi-directional sync between a server and mobile clientInformation.

 syncObj.startSession(config);

Config: a JavaScript object containing various callbacks and parameters, and is required for every sync process. For more information, refer to Sync Framework Documentation > sync.startSession.

For other sync APIs, refer to Sync Framework Documentation.

To perform database operations, there are ORM APIs, which are exposed by Sync framework. For more details, click Sync Services ORM APIs.