doc/synchronization.txt in rhodes-3.4.2 vs doc/synchronization.txt in rhodes-3.5.1.12
- old
+ new
@@ -493,21 +493,24 @@
render :action => :index
else
render :action => :login
end
-### `dosync(show_sync_status = true, query_params = "")`
+### `dosync(show_sync_status = true, query_params = "", sync_only_sources_with_local_changes = false )`
Start the `SyncEngine` process and display an optional status popup (defaults to true).
-query_params will pass to sync server
+query_params will pass to sync server. sync_only_sources_with_local_changes indicates that only sources that have local changes will be synced.
:::ruby
SyncEngine.dosync(false)
#=> no status popups are displayed
SyncEngine.dosync(false, "param1=12¶m2=abc")
#=> no status popups are displayed and parameters will pass to sync server
+ SyncEngine.dosync(false, "", true)
+ #=> no status popups are displayed and synchronization will be performed only for sources with local changes.
+
### `dosync_source(source_id_or_name, show_sync_status = true, query_params = "")`
Star the `SyncEngine` process for a given source id or source name and display an optional status popup (defaults to true).
query_params will pass to sync server
:::ruby
@@ -696,5 +699,8 @@
[Sync engine AJAX API](syncengine-ajax-api) has been implemented to provide access to low-level control on
synchronization process right from plain HTML/javascript UI pages.
It isn't intended to be used in every application. It requires deep knowledge of SyncEngine functionality and operations.
It may broke your application if used improperly so use it with care please.
+
+## Backround synchronization on iOS
+On iOS, if application is put to background, it will be suspended. To allow application finish sync after application goes to background, you can use 'finish_sync_in_background' parameter in [`rhoconfig.txt`](/rhodes/configuration). When this parameter is set to '1', if sync is active in the time of background transition ( e.g. started from app_deactivate handler ), application will not be suspended until sync is finished.
\ No newline at end of file