rhodes 3.3.3.beta.4 → 3.3.3

data/doc/introduction.txt

@@ -8,19 +8,22 @@ The [Tutorial](tutorial) describes how to install Rhodes and build your apps. Th
 
 ## Supported Operating Systems
 ### BlackBerry
-BlackBerry 4.6, 4.7, 5.0, 6.0
+BlackBerry 4.6, 4.7, 5.0, 6.0, 7.0
 
 NOTE: 4.2 and 4.5 are supported but database access is very slow on these devices.
 
 ### Windows Mobile
-Windows Mobile 6.1 Professional, 6.0 Standard
+Windows Mobile 6.x Professional, 6.0 Standard
 
 ### Android
-Android 1.6 and greater
+Android 2.1 and greater
 
 ### iPhone
 All versions of iPhone 3.0 or greater, iPad
 
+### Windows Phone 7
+Latest Windows Phone devices
+
 ## Rhodes Application
 
 A Rhodes application is a web application that runs locally on your mobile device. It is implemented with the standard MVC architecture:

data/doc/jqt-jqm-transition.txt

@@ -15,15 +15,16 @@ Target platform should be [supported by jQuery Mobile framework](http://jquerymo
 You need to use [Rhodes application template code](https://github.com/rhomobile/rhodes/tree/master/res/generators/templates/application/) (*rhodes_root_dir/res/generators/templates/application*) as the source of files to copy from.
 
 1. Backup your application as it is before any changes.
-1. Copy all content of *public/jquery* directory to the *public/jquery* directory of your application.
-1. Copy all content of *public/jqmobile* directory to the *public/jqmobile* directory of your application.
-1. Copy all content of *public/css* directory to the *public/css* directory of your application.
-1. Copy all content of *public/js* directory to the *public/js* directory of your application.
-1. Rename your *app/layout.erb* to some other name, say *app/layout-legacy.erb*.
-1. Copy *app/layout.erb* file to the *app* directory of your application.
-1. Replace all instances of **'<%%'** symbol combination in the new *app/layout.erb* to the **'<%'** combination.
-1. Use your *app/layout-legacy.erb* as reference to implement needed customization and styling in the *app/layout.erb* file.
-1. Change the HTML structure of all application pages so they will meet jQuery Mobile requirements (see below).
+2. Copy all content of *public/jquery* directory to the *public/jquery* directory of your application.
+3. Copy all content of *public/jqmobile* directory to the *public/jqmobile* directory of your application.
+4. Copy all content of *public/css* directory to the *public/css* directory of your application.
+5. Copy all content of *public/js* directory to the *public/js* directory of your application.
+6. Rename your *app/layout.erb* to some other name, say *app/layout-legacy.erb*.
+7. Copy *app/layout.erb* file to the *app* directory of your application.
+8. Replace all instances of **'<%%'** symbol combination in the new *app/layout.erb* to the **'<%'** combination.
+9. Replace "<%= class_name %>" inside the title tag in the header for the name of your app, ex "My App"
+10. Use your *app/layout-legacy.erb* as reference to implement needed customization and styling in the *app/layout.erb* file.
+11. Change the HTML structure of all application pages so they will meet jQuery Mobile requirements (see below).
 
 ### Application pages structure changes
 

data/doc/release.txt

@@ -215,7 +215,10 @@ Same procedure as for plug-in
 
 2. Import project into Eclipse (File/Import/'Existing project into Workspace')
 
-3. Install DLTK 2.0
+3. Install additional components 
+
+   3.1 DLTK 2.0 (eclipse update site - http://download.eclipse.org/technology/dltk/updates/)
+   3.2 Egit plugin (eclipse update site - http://download.eclipse.org/egit/updates)
 
 4. Import into workspace DLTK plugins
 
@@ -229,6 +232,7 @@ Same procedure as for plug-in
     org.eclipse.dltk.console
     org.eclipse.dltk.core
     org.eclipse.dltk.debug.ui
+    org.eclipse.egit.ui
 
     After import procedure in workspace should appears seven plugin projects.
 

data/doc/rhodes-command-line.txt

@@ -0,0 +1,130 @@
+Rhodes Command Line
+========
+This section describes how to use Rhodes from the command line (as opposed to using RhoStudio, an Eclipse-based IDE) to build native mobile apps for all shipping smartphones.  Specifically it describes how to write Rhodes controllers and templates and refers to the RhoConnect tutorial on how to write RhoConnect source adapters to sync data from backend apps to the device. The architecture of this is shown [here](https://img.skitch.com/20110111-1snnuchj3ph1hu41cafkb23jng.png).
+
+Install Rhodes
+--------------
+
+Install and Setup Rhodes following instructions [here](install).
+
+Generating A Rhodes Application
+-------------------------------
+The first step is to generate the application and base files.  First we will generate an application called StoreManager with the following command:
+
+    :::term
+    $ rhodes app storemanager http://localhost:9292/application
+
+This will generate an application directory called "storemanager" with several files.  Note also that the third argument above is the URL to the RhoConnect server data source (required if you want to do synchronized data as we describe in the next section).  Specifically it will set the rhoconfig.txt file to have the following option:
+
+    syncserver = 'http://localhost:9292/application'
+
+If you do not need synchronized offline data, you can leave the third argument out.
+
+
+The default home screen of the app is defined in the storemanager/app/index.erb file.  You can edit the HTML there to create what your app displays.  You can link to other HTML files and ERB files from there with standard HTML techniques.  Then you can build your app with rake tasks.  For example, to build for the iPhone and run the simulator, type the following commands:
+
+    :::term
+    $ cd storemanager
+    $ rake run:iphone
+
+<img src="https://s3.amazonaws.com/rhodocs/rhodes-jquerymobile-tutorial/jquerymobile-index-iphone.png" heigth='300' width='200'/>
+
+To build for other platforms/simulators, you execute the appropriate rake tasks, such as "rake run:bb" to run it on the BlackBerry emulator. To see all possible rake tasks:
+
+    :::term
+    $ rake -T
+
+Generating Models
+-----------------
+
+Now that your app compiles and runs, you can start adding models and controllers. When the model is generated, Rhodes will also create files for a standard UI for displaying and editing the model. This follows the standard model-view-controller paradigm.
+
+Let's generate a model called "product" and give it some attributes.
+
+    :::term
+    $ cd storemanager
+    $ rhodes model product brand,name,price,quantity,sku
+      Generating with model generator:
+        [ADDED]  app/Product/index.erb
+        [ADDED]  app/Product/edit.erb
+        [ADDED]  app/Product/new.erb
+        [ADDED]  app/Product/show.erb
+        [ADDED]  app/Product/index.bb.erb
+        [ADDED]  app/Product/edit.bb.erb
+        [ADDED]  app/Product/new.bb.erb
+        [ADDED]  app/Product/show.bb.erb
+        [ADDED]  app/Product/product_controller.rb
+        [ADDED]  app/Product/product.rb
+        [ADDED]  app/test/product_spec.rb
+
+Editing Rhodes Views
+--------------------
+
+You can edit the generated ERB files to customize the HTML as you see fit.  Typically you will provide links to the model index page from the home screen.  Below is the generated top level index.erb file for the Store Manager app (app/index.erb).
+
+
+    :::ruby
+    <div data-role="page" data-url="<%= Rho::RhoConfig.start_path %>/">
+
+      <div data-role="header" data-position="inline">
+        <h1>Storemanager</h1>
+        <% if SyncEngine::logged_in > 0 %>
+            <a href="<%= url_for :controller => :Settings, :action => :do_sync %>" class="ui-btn-left" data-icon="refresh">Sync</a>
+            <a href="<%= url_for :controller => :Settings, :action => :logout %>" class="ui-btn-right" data-icon="star">Logout</a>
+        <% else %>
+            <a href="<%= url_for :controller => :Settings, :action => :login %>" class="ui-btn-right" data-icon="star">Login</a>
+        <% end %>
+      </div>
+
+      <div data-role="content">
+        <ul data-role="listview">
+          <li>
+            <a href="#">Add Links Here...</a>
+          </li>
+        </ul>
+      </div>
+
+      <div data-role="footer" data-position="inline">
+        <p>it is optional part of page..</p>
+      </div>
+
+    </div>
+
+
+To provide a link to the Product model's index page and templates you can replace the list item with the title "Add links here" with:
+
+    :::ruby
+    <li>
+        <a href="Product">Products</a>
+    </li>
+
+<img src="https://s3.amazonaws.com/rhodocs/rhodes-jquerymobile-tutorial/ipod.png" heigth='300' width='200' />
+
+
+**NOTE:** You can edit this top level page or any of the other pages with any arbitrary HTML you wish.   We don't attempt to teach you HTML or Ruby here but there are many good external references for both topics.
+
+Doing More With Rhodes
+----------------------
+
+See the comprehensive and exhaustive [Rhodes Developer Reference](/rhodes/introduction) for details on all Rhodes capabilities.
+
+Code samples of each and every Rhodes capability are in the
+[Rhodes API samples](http://github.com/rhomobile/rhodes-system-api-samples).
+
+You should take a look at the [Rhodes 2.0 training webinar](http://vimeo.com/channels/rhomobile#12214213).
+
+There is a [technical FAQ](/faq) that describes how to perform certain specific tasks in Rhodes.
+
+The following sections describe how to add synchronized data to our app with RhoConnect.
+
+Adding Synchronized Data to Your App with RhoConnect
+----------------------------------------------------
+To add synchronized data to your application, see the [RhoConnect Tutorial](/rhoconnect/tutorial).  Also check out the [RhoConnect training video](http://vimeo.com/channels/rhomobile#28789274).
+
+More Info
+---------
+There are training webinars on various Rhomobile related topics held weekly.  Videos of these are on [the Rhomobile Vimeo channel](http://vimeo.com/channels/rhomobile).
+
+There is also the following [book on Rhomobile](http://www.apress.com/book/view/9781430228684).
+
+For more questions, [write to us](mailto:info@rhomobile.com) or join the [Rhomobile Google Group](http://groups.google.com/group/rhomobile) and post.

data/doc/rhom.txt

@@ -444,13 +444,12 @@ Calls `find` with a limit on the # of records.  This emulates rails' classic pag
 	  :order => 'name'
 	) #=> you can have :conditions and :order as well
 
-### `sync(callback = nil, callback_data = "", show_status_popup = nil, query_params = "")`
+### `sync(callback, callback_data, show_status_popup, query_params)`
 Start the sync process for a model. If the callback is set, `SyncEngine.set_notification` is called before `SyncEngine.dosync`.
-query_params will pass to sync server
+query_params (this is optional) will pass to sync server. The query_params value must be URL encoded. In this example, the value for @params["sku"] -- the value of the sku -- must be URL encoded.
 	
 	:::ruby
-	Account.sync( url_for(:action => :sync_callback) )
-	Account.sync( url_for(:action => :sync_callback), "", false, "param1=123&param2=abc" )
+	Product.sync( url_for(:action => :sync_callback), "", false, "query=#{@params["sku"]}" )
 
 ### `set_notification(url, params = nil)`
 Set a notification to be called when the sync is complete for this model.  This is useful for example if you want to refresh the current list page or display an alert when new data is synchronized. See the [sync notification docs](/rhodes/synchronization#notifications) for more information.
@@ -520,12 +519,16 @@ Assigns the [metadata](/rhoconnect/metadata) for a given model.
 
 	:::ruby
 	Product.metadata = { 'foo' => 'bar' }.to_json
-	
 
 ## Associations
-For sync-enabled models, Rhom offers associations as a means to automatically trigger sync updates for dependent objects.  This is useful where you have relationships between backend service objects.
 
-For example, you can have a list of customers who have purchased a product:
+Rhom does not support Ruby on Rails associations. However, Rhom has a [sync  association](/rhodes/rhom#sync-associations) called `belongs_to` which you can use to trigger updates on sync-enabled models.
+
+## Sync Associations
+
+For sync-enabled models, Rhom has a `belongs_to` sync association as a means to automatically trigger sync updates for dependent objects. This is useful where you have relationships between backend service objects.
+
+For example, you can have a list of customers who have purchased a product, and thus you can have them belong to that product:
 
 	:::ruby
 	class Customer
@@ -535,7 +538,7 @@ For example, you can have a list of customers who have purchased a product:
 	  belongs_to :product_id, 'Product'
 	end
 
-In your `product_controller.rb`, assign the `:belongs_to` attribute when a product is created:
+In your `product_controller.rb`, assign the `belongs_to` attribute when a product is created:
 
 	:::ruby
 	def create
@@ -548,7 +551,7 @@ In your `product_controller.rb`, assign the `:belongs_to` attribute when a produ
 	  redirect :action => :index
 	end
 
-You can also define polymorphic associations, or associations across multiple classes.
+You can also define polymorphic sync associations, or sync associations across multiple classes.
 
 Using array notation:
 	
@@ -561,9 +564,11 @@ Or multiple declarations:
 	belongs_to :parent_id, 'Product'
 	belongs_to :parent_id, 'Cases'
 
-
 **NOTE: After a new product is created, the `:product_id` for the `Customer` records will be updated to the new value.**
 
+If you are planning to use bulk sync feature for your associated models, then you should take into consideration 
+corresponding support on RhoConnect server side. See [RhoConnect Bulk Sync associations](/rhoconnect/bulk-sync#bulk-sync-associations).
+
 ## Freezed models
 If you want to limit model attributes by specific list - you can 'freeze' model:
 
@@ -593,7 +598,7 @@ For such models if you try to add not listed property - you will get ArgumentErr
     obj.update_attributes(:wrong_address => 'test') #will raise ArgumentError exception
 
 
-NOTE: FixedSchema models 'freezed' by default.
+**NOTE: FixedSchema models are 'freezed' by default.**
 
     
 ## Accessing Sync Info with RhomSource

data/doc/rhostudio-eclipse.txt

@@ -1,15 +1,15 @@
 Installing RhoStudio as an Eclipse Plugin
 ==============
 
-RhoStudio, which facilitates development of native smartphone applications, can be installed into Eclipse for developers not using RhoStudio for Macintosh or RhoStudio for Windows.
+RhoStudio, which facilitates development of native smartphone applications, can be installed into Eclipse as a plug-in.
 
 Prerequisites
 ----------------
 You need to have installed:
 
 * Java Runtime Environment, minimum of Java 5 JRE or JDK.
-* [Rhodes gem](install#rhodes-gem-for-linux-and-non-rhostudio).
-* For RhoConnect, you also need the [RhoConnect gem](/rhoconnect/install#rhoconnect-gem-for-linux-and-non-rhostudio).
+* [Rhodes gem](/install#installing-rhodes-from-the-command-line).
+* For RhoConnect, you also need the [RhoConnect gem](/rhoconnect/install#installing-rhoconnect-from-the-command-line).
 
 Checking the Eclipse Installation
 ----------------

data/doc/simulator.txt

@@ -4,14 +4,10 @@ RhoSimulator allows to [run](#run-application-in-rhosimulator) Rhodes applicatio
 
 ## Install RhoSimulator
 
-If you have [Rhodes gem](install#rhodes-gem-for-linux-and-non-rhostudio), then RhoSimulator is installed already.
-(Note: If you're going to use RhoSimulator from rhodes-3.1.0 gem on Mac, you need to put missing Qt libraries
-(QtDBus.framework and QtXml.framework) from [RhoSimulator31Mac_fix.zip](http://rhosimulator.s3.amazonaws.com/RhoSimulator31Mac_fix.zip)
-to 'platform/osx/bin/RhoSimulator/RhoSimulator.app/Contents/Frameworks' folder within rhodes SDK home directory,
-e.g. '/Library/Ruby/Gems/1.8/gems/rhodes-3.1.0/')
+If you have [Rhodes gem](/install#installing-rhodes-from-the-command-line), then RhoSimulator is installed already.
 
 If you would like to run RhoSimulator without Rhodes gem, download [Windows](http://rhosimulator.s3.amazonaws.com/RhoSimulator.zip) or
-[Mac OS X](http://rhosimulator.s3.amazonaws.com/RhoSimulatorMac.zip) version, unzip and specify path to `rhosimulator.exe` or `RhoSimulator.app` respectively at `rhodes/rhobuild.yml`:
+[Mac OS X](http://rhosimulator.s3.amazonaws.com/RhoSimulator.tbz2) version, extract it and specify path to `rhosimulator.exe` or `RhoSimulator.app` respectively at `rhodes/rhobuild.yml`:
 
         env: 
            paths:    
@@ -70,49 +66,51 @@ Follow these instructions to build your own customized version of RhoSimulator.
 
 ### Preliminary steps for Windows
 
-* Currently only <b>Visual Studio 2005 Service Pack 1</b> is supported
+* Currently only <b>Visual Studio 2008</b> is supported
 * Follow [Build for Windows - Prerequisites](build#build-for-windows), but do not install the Rhodes gem since you're going to use Rhodes SDK source.
 * Get the `rhodes` source (if haven't done it already) as described [here](build#setup-rhodes-source-code). Don't forget to add the `bin` folder to your path, run `rhodes-setup` and update Rhodes SDK path in `build.yml` at your application root folder.
-* First build the Qt libraries for VS 2005:
+* First build the Qt libraries for VS 2008:
     * Download the Qt source:
         * Go to [http://qt.nokia.com/downloads](http://qt.nokia.com/downloads)
         * Jump to `Qt libraries`
-        * Download the [source code as a zip](http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.4.zip) (236 MB)
-        * Extract the downloaded archive, e.g. into `C:\Qt\4.7.4-msvc2005`
+        * Download the [source code as a zip](http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.4.zip) (237 MB)
+        * Extract the downloaded archive, e.g. into `C:\Qt\4.7.4`
     * Prepare to build the OpenSSL library:
-        * Download [v0.9 source code](http://www.openssl.org/source/openssl-0.9.8s.tar.gz) from [www.openssl.org](http://www.openssl.org/) and extract the downloaded archive, e.g. into `C:\Qt\openssl-0.9.8s`
+        * Download [v1.0 source code](http://www.openssl.org/source/openssl-1.0.1.tar.gz) from [www.openssl.org](http://www.openssl.org/) and extract the downloaded archive, e.g. into `C:\Qt\openssl-1.0.1`
         * Install Perl interpreter (if it's not installed yet), e.g. [ActiveState Perl](http://www.activestate.com/activeperl)
+        * Install [Netwide Assembler (NASM)](http://www.nasm.us/pub/nasm/releasebuilds/2.10/win32/nasm-2.10-installer.exe) from [www.nasm.us](http://www.nasm.us/) (if it's not installed yet)
     * Open Control Panel » System » Advanced system settings » Environment Variables and then:
-        * Create new system variable `QTDIR` = `C:\Qt\4.7.4-msvc2005`
-        * Add to the `PATH` variable: `C:\Qt\4.7.4-msvc2005\bin;C:\Qt\openssl-0.9.8s\bin` (it doesn't matter that `C:\Qt\openssl-0.9.8s\bin` folder does not exist yet)
+        * Create new system variable `QTDIR` = `C:\Qt\4.7.4`
+        * Add to the `PATH` variable: `C:\Qt\4.7.4\bin;C:\Qt\openssl-1.0.1\bin` (it doesn't matter that `C:\Qt\openssl-1.0.1\bin` folder does not exist yet)
+        * Add to the `PATH` variable the path to `nasm.exe` (usually `C:\Program Files\nasm`)
         * Either close all command prompts and Visual Studio instances, or reboot the computer so the new settings take effect.
-    * Open Visual Studio 2005 Command Prompt. This is accomplished using Start » All Programs » Microsoft Visual Studio 2005 » Visual Studio Tools » Visual Studio 2005 Command Prompt. Run in Visual Studio 2005 Command Prompt:
+    * Open Visual Studio 2008 Command Prompt. This is accomplished using Start » All Programs » Microsoft Visual Studio 2008 » Visual Studio Tools » Visual Studio 2008 Command Prompt. Run in Visual Studio 2008 Command Prompt:
 
 			> vcvarsall.bat x86
 			> C:
 
     * To build OpenSSL library run in the same command prompt:
 
-			> cd \Qt\openssl-0.9.8s
-			> perl Configure VC-WIN32 --prefix=C:/Qt/openssl-0.9.8s
-			> ms\do_masm
+			> cd \Qt\openssl-1.0.1
+			> perl Configure VC-WIN32 enable-static-engine --prefix=C:/Qt/openssl-1.0.1
+			> ms\do_nasm
 			> nmake -f ms\ntdll.mak
 			> nmake -f ms\ntdll.mak install
 			> nmake -f ms\ntdll.mak clean
 
     * To build Qt library run in the same command prompt:
 
-			> cd \Qt\4.7.4-msvc2005
-			> configure -opensource -platform win32-msvc2005
+			> cd \Qt\4.7.4
+			> configure -opensource -platform win32-msvc2008
 			  -nomake examples -nomake demos -nomake docs
-			  -qt-libpng -qt-libjpeg -qt-libtiff -qt-gif -qt-libmng
-			  -openssl-linked -I C:/Qt/openssl-0.9.8s/include
-			  -L C:/Qt/openssl-0.9.8s/lib
+			  -qt-libpng -qt-libjpeg -qt-libtiff -qt-libmng -qt-gif
+			  -openssl-linked -I C:/Qt/openssl-1.0.1/include
+			  -L C:/Qt/openssl-1.0.1/lib
 			> nmake
 			> nmake clean
 
       Be aware that it will take a while to build the Qt libraries from sources (maybe few hours or so). Particularly the `configure` command may run for a few minutes, and the `nmake` command may run for a few hours.
-    * After the build process is completed exit Visual Studio 2005 Command Prompt
+    * After the build process is completed exit Visual Studio 2008 Command Prompt
 
 ### Preliminary steps for Mac OS X
 
@@ -122,8 +120,8 @@ Follow these instructions to build your own customized version of RhoSimulator.
     * Download the Qt source:
         * Go to [http://qt.nokia.com/downloads](http://qt.nokia.com/downloads)
         * Jump to `Qt libraries`
-        * Download the [source code as a zip](http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.4.zip) (236 MB)
-        * Extract the downloaded archive, e.g. into `~/QtSource`
+        * Download the [source code as a gzipped tar](http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.8.1.tar.gz) (229 MB)
+        * Extract the downloaded archive, e.g. into `~/qt-4.8.1`
     * Make sure that your `PATH` environment variable does not contain the path to any previously installed Qt binaries
     * Add to your `~/.profile` the new environment variable `QTDIR` by adding the line (or by changing the existing `QTDIR` variable):
 
@@ -131,12 +129,11 @@ Follow these instructions to build your own customized version of RhoSimulator.
 
     * Open `Terminal.app` and issue commands:
 
-			$ cd ~/QtSource
-			$ make confclean
+			$ cd ~/qt-4.8.1
 			$ ./configure -opensource -platform macx-g++
 			  -nomake examples -nomake demos -nomake docs
-			  -qt-libpng -qt-libjpeg -qt-libtiff -qt-gif -qt-libmng
-			  -prefix /Developer/SDKs/Qt -release
+			  -qt-libpng -qt-libjpeg -qt-libtiff -qt-libmng
+			  -webkit -prefix /Developer/SDKs/Qt -release
 			$ make
 			$ sudo make install
 
@@ -160,10 +157,10 @@ When you've finished all the preliminary steps for your OS, the only thing you n
 
 To run Rhodes applications in the custom built RhoSimulator, please ensure that no `env:` » `paths:` » `rhosimulator:` line is present at your `rhobuild.yml` (if present, remove that line).
 
-### Build RhoSimulator for Windows in Visual Studio 2005:
+### Build RhoSimulator for Windows in Visual Studio 2008:
 
 * Open the solution:
-  `C:\Rhomobile\rhodes\platform\wm\rhodes\rhodes.vcproj`
+  `C:\Rhomobile\rhodes\platform\wm\rhodes.sln`
 * Build solution for the configuration `SimulatorRelease|Win32`
 * Specify the path to custom built RhoSimulator at `rhobuild.yml`:
         env:

data/doc/syncengine-ajax-api.txt

@@ -0,0 +1,246 @@
+# SyncEngine AJAX API
+
+## Introduction
+SyncEngine AJAX API provides ability for HTML/javascript based application to control SyncEngine using AJAX calls.
+It is implemented as a plain javascript library which doesn't require to use any side libraries or frameworks.
+
+NOTE: It is just for SyncEngine control and at the moment it doesn't provide any methods to read or manipulate stored objects.
+
+## Sample project
+
+[Rhodes API samples](http://github.com/rhomobile/rhodes-system-api-samples) has [SyncEngine AJAX API demo code](https://github.com/rhomobile/rhodes-system-api-samples/tree/master/app/SyncengineJs).
+
+## Usage sample code
+
+    :::html
+    <!DOCTYPE html>
+    <html>
+        <head><title>SyncEngine AJAX API sample</title>
+            <script src="/public/js/syncengine.js" type="text/javascript"></script>
+
+            <script type="text/javascript">
+                function put(msg, container) {
+                    document.getElementById(container).innerHTML = msg;
+                }
+                api = window.Rho.syncengine;
+            </script>
+
+        </head>
+        <body>
+            API functions tests:
+            <ul>
+                <li>
+                    <a href="#" onclick="api.set_syncserver('http://some.server.url', function(res){put(res, 'result_set_syncserver');}); return false;">
+                        set_syncserver('http://rhodes-samples-server.heroku.com/application')</a>&nbsp;
+                    <span id="result_set_syncserver"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.set_pollinterval(60, function(res){put(res, 'result_set_pollinterval');}); return false;">
+                        set_pollinterval(60)</a>&nbsp;
+                    <span id="result_set_pollinterval"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.get_pollinterval(function(res){put(res, 'result_get_pollinterval');}); return false;">
+                        get_pollinterval()</a>&nbsp;
+                    <span id="result_get_pollinterval"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.login('abc', '123', function(result){alert(result);} ,function(res){put(res, 'result_login');}); return false;">
+                        login('abc', '123', '')</a>&nbsp;
+                    <span id="result_login"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.logged_in(function(res){put(res, 'result_logged_in');}); return false;">
+                        logged_in()</a>&nbsp;
+                    <span id="result_logged_in"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.logout(function(res){put(res, 'result_logout');}); return false;">
+                        logout()</a>&nbsp;
+                    <span id="result_logout"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.dosync(false, '', function(res){put(res, 'result_dosync');}); return false;">
+                        dosync()</a>&nbsp;
+                    <span id="result_dosync"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.dosync_source('Metadata', false, '', function(res){put(res, 'result_dosync_source');}); return false;">
+                        dosync_source('Metadata')</a>&nbsp;
+                    <span id="result_dosync_source"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.is_syncing(function(res){put(res, 'result_is_syncing');}); return false;">
+                        is_syncing()</a>&nbsp;
+                    <span id="result_is_syncing"></span>
+                </li>
+
+                <li>
+                    <a href="#" onclick="api.stop_sync(function(res){put(res, 'result_stop_sync');}); return false;">
+                        stop_sync()</a>&nbsp;
+                    <span id="result_stop_sync"></span>
+                </li>
+            </ul>
+
+        </body>
+    </html>
+
+
+## API reference
+
+All API methods are defined in the *Rho.syncengine* namespace. Each method is accessible in javascript as *window.Rho.syncengine.method_name*.
+Each API method receives callback functions as two last parameters, those are:
+
+* success - Success handler function. Paremeters are:
+    * result - String value with AJAX response. Contains just "ok" value if different behavior is not described for exact API method as *RETURNED* value.
+    * status - Number value with HTTP response status
+    * xhr - XmlHttpRequest object associated with response
+
+* error - Error and timeout handler function. Parameters are:
+    * message - String with error message if any. May be empty or null.
+    * status - String with "error" or "timeout" values possible
+    * xhr - XmlHttpRequest object associated with error or timeout
+
+They are the same for every API method and will not be explained for each method description.
+
+### set_threaded_mode
+	:::cplusplus
+    set_threaded_mode(/*boolean*/ threaded, /*function*/ success, /*function*/ error);
+Where:
+
+* threaded - Boolean value, it defines is threaded mode is used. By default SyncEngine works in threaded mode.
+
+### enable_status_popup
+	:::cplusplus
+    enable_status_popup(/*boolean*/ enable, /*function*/ success, /*function*/ error);
+Where:
+
+* enable - Boolean value, it defines are UI status pop-ups enabled or disabled.
+
+### set_ssl_verify_peer
+	:::cplusplus
+    set_ssl_verify_peer(/*boolean*/ verify, /*function*/ success, /*function*/ error);
+Where:
+
+* verify - Boolean value, it defines will SSL peers verification be performed or not.
+
+### register_push
+It register device on push server for push notifications. Have no control parameters, just result handlers.
+	:::cplusplus
+    register_push(/*function*/ success, /*function*/ error);
+
+### set_syncserver
+	:::cplusplus
+    set_syncserver(/*string*/ syncserver, /*function*/ success, /*function*/ error);
+Where:
+
+* syncserver - String value with a new URL of synchronization server to be used.
+
+### set_pollinterval
+	:::cplusplus
+    set_pollinterval(/*number*/ interval, /*function*/ success, /*function*/ error);
+Where:
+
+* interval - Number value with a new poll interval.
+* RETURNED - String with an old value of poll interval.
+
+### get_pollinterval
+	:::cplusplus
+    get_pollinterval(/*function*/ success, /*function*/ error);
+Where:
+
+* RETURNED - String with a value of poll interval.
+
+### set_pagesize
+	:::cplusplus
+    set_pagesize(/*number*/ size, /*function*/ success, /*function*/ error);
+Where:
+
+* size - Number value with a new sync page size.
+* RETURNED - String with an old value of sync page size.
+
+### get_pagesize
+	:::cplusplus
+    get_pagesize(/*function*/ success, /*function*/ error);
+Where:
+
+* RETURNED - String with a value of sync page size.
+
+### set_objectnotify
+This method make it possible to set handler function to watch for changes in exact object during synchronization process.
+	:::cplusplus
+    set_objectnotify(/*function*/ notify, /*function*/ success, /*function*/ error);
+Where:
+
+* notify - Object changes notification handler function. Parameters are:
+    * objectNotifyQuery - String value with URL-encoded parameters for changed object.
+
+### clean_objectnotify
+This method cleans all object notifications.
+	:::cplusplus
+    clean_objectnotify(/*function*/ success, /*function*/ error);
+
+### login
+This method makes user logged in.
+    :::cplusplus
+    login(/*string*/ login, /*string*/ password, /*function*/ callback, /*function*/ success, /*function*/ error)
+Where:
+
+* login - String value with login.
+* password - String value with password.
+* callback - Login status callback handler function. Parameters are:
+    * loginStatusQuery - String value with URL-encoded parameters of login status.
+
+### logged_in
+This methods checks if user is logged in.
+	:::cplusplus
+    logged_in(/*function*/ success, /*function*/ error);
+Where:
+
+* RETURNED - String with a "true" or "false" value.
+
+### logout
+This method makes user logged out.
+	:::cplusplus
+    logout(/*function*/ success, /*function*/ error);
+
+### dosync
+This method runs synchronization for all sources.
+	:::cplusplus
+    dosync(/*bool*/ show_status_popup, /*string*/ query_params, /*function*/ success, /*function*/ error);
+Where:
+
+* show_status_popup - Boolean value, it defines are UI status pop-ups enabled or disabled.
+* query_params - String with synchronization query parameters
+
+### dosync_source
+This method runs synchronization for exact named source.
+	:::cplusplus
+    dosync_source(/*string*/ srcName, /*bool*/ show_status_popup, /*string*/ query_params, /*function*/ success, /*function*/ error);
+Where:
+
+* srcName - String value with exact source name.
+* show_status_popup - Boolean value, it defines are UI status pop-ups enabled or disabled.
+* query_params - String with synchronization query parameters
+
+### is_syncing
+This methods checks if synchronization still in a progress.
+	:::cplusplus
+    is_syncing(/*function*/ success, /*function*/ error);
+Where:
+
+* RETURNED - String with a "true" or "false" value.
+
+### stop_sync
+This method stops synchronization process.
+	:::cplusplus
+    stop_sync(/*function*/ success, /*function*/ error);
+