aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs')
-rw-r--r--Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs17
1 files changed, 17 insertions, 0 deletions
diff --git a/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs b/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
index 7abd8ad7e..75d28af5b 100644
--- a/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
+++ b/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
@@ -10,8 +10,18 @@ using Tango.Synchronization.Local;
namespace Tango.Synchronization.Remote
{
+ /// <summary>
+ /// Represents a remote database to SQLite file synchronizer.
+ /// </summary>
public class RemoteDBSynchronizer
{
+ /// <summary>
+ /// Synchronizes the specified SQLite file by a machine serial number.
+ /// </summary>
+ /// <param name="sqliteDbFile">The SQLite database file.</param>
+ /// <param name="serialNumber">The machine serial number.</param>
+ /// <param name="overrideLocal">if set to <c>true</c> will erase the SQLite file before performing the synchronization.</param>
+ /// <returns></returns>
public static List<Diff> Synchronize(String sqliteDbFile, String serialNumber, bool overrideLocal = false)
{
if (overrideLocal)
@@ -41,6 +51,13 @@ namespace Tango.Synchronization.Remote
}
}
+ /// <summary>
+ /// Synchronizes the specified SQLite file by a machine serial number.
+ /// </summary>
+ /// <param name="sqliteDbFile">The SQLite database file.</param>
+ /// <param name="serialNumber">The machine serial number.</param>
+ /// <param name="overrideLocal">if set to <c>true</c> will erase the SQLite file before performing the synchronization.</param>
+ /// <returns></returns>
public static Task<List<Diff>> SynchronizeAsync(String sqliteDBFile, String serialNumber, bool overrideLocal = false)
{
return Task.Factory.StartNew<List<Diff>>(() =>