summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIckhee Woo <ickhee.woo@samsung.com>2017-09-22 17:04:46 +0900
committerIckhee Woo <ickhee.woo@samsung.com>2017-09-22 17:04:46 +0900
commitd85bc1b7c4340e32b5b4b85623ec9f311114d223 (patch)
treeb947921405ea3793fa93e5e06b21d76573d9367c
parent688779388e5a92220fcd44c9e2468488ccc46bda (diff)
downloadsync-manager-tizen.tar.gz
sync-manager-tizen.tar.bz2
sync-manager-tizen.zip
added API Leveltizen
Change-Id: Ia85d5ef9c0d55a5a31ffa13a6d175d9f4a68715e Signed-off-by: Ickhee Woo <ickhee.woo@samsung.com>
-rwxr-xr-xTizen.Account.SyncManager/Interop/Interop.Libraries.cs1
-rwxr-xr-xTizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs12
-rwxr-xr-xTizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs5
-rwxr-xr-xTizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs7
-rwxr-xr-xTizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs10
5 files changed, 35 insertions, 0 deletions
diff --git a/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs b/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs
index a1d3410..8e62734 100755
--- a/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs
+++ b/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs
@@ -19,6 +19,7 @@ internal static partial class Interop
/// <summary>
/// The Wrapper class for maintaining names of dependent native libraries.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
internal static partial class Libraries
{
public const string SyncManager = "libcore-sync-client.so.1";
diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs
index 7bfb265..4ce919d 100755
--- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs
+++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs
@@ -21,63 +21,75 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Enumeration for the sync option.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
[Flags]
public enum SyncOption
{
/// <summary>
/// The sync job will be operated normally.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
None = 0,
/// <summary>
/// The sync job will be operated as soon as possible.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
Expedited = 0X01,
/// <summary>
/// The sync job will not be performed again when it fails.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
NoRetry = 0X02,
}
/// <summary>
/// Enumeration for the sync period.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum SyncPeriod
{
/// <summary>
/// Sync within 30 minutes.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
ThirtyMin = 0,
/// <summary>
/// Sync within 1 hour.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
OneHour,
/// <summary>
/// Sync within 2 hours.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
TwoHours,
/// <summary>
/// Sync within 3 hours.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
ThreeHours,
/// <summary>
/// Sync within 6 hours.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
SixHours,
/// <summary>
/// Sync within 12 hours.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
TwelveHours,
/// <summary>
/// Sync within 1 day.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
OneDay,
}
}
diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs
index 4a25dee..5b95f22 100755
--- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs
+++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs
@@ -23,6 +23,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// This class contains the delegates to be called upon scheduling a sync operation.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SyncAdapter
{
Interop.Adapter.SyncAdapterStartSyncCallback _startSyncCallback;
@@ -31,6 +32,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// The callback function for the sync adapter's start sync request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
/// <returns> true if the sync operation is success, @c false otherwise. </returns>
public delegate bool StartSyncCallback(SyncJobData syncParameters);
@@ -38,12 +40,14 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// The callback function for the sync adapter's cancel sync request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
public delegate void CancelSyncCallback(SyncJobData syncParameters);
/// <summary>
/// Sets the client (sync adapter) callback functions.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="startSyncCb"> A callback function to be called by the sync manager for performing the sync operation. </param>
/// <param name="cancelSyncCb"> A callback function to be called by the sync manager for cancelling the sync operation. </param>
/// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception>
@@ -100,6 +104,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Unsets the client (sync adapter) callback functions.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <exception cref="System.Exception"> Thrown when sync manager internal error occurs. </exception>
public void UnsetSyncEventCallbacks()
{
diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs
index f86747b..97c739e 100755
--- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs
+++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs
@@ -25,11 +25,13 @@ namespace Tizen.Account.SyncManager
/// The SyncClient APIs for managing the sync operations. Applications will call these APIs to schedule their sync operations.
/// The sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class SyncClient
{
/// <summary>
/// The constructor.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
static SyncClient()
{
}
@@ -37,6 +39,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Requests the sync manager to perform one time sync operation.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="request"> The sync job information of the sync job request. </param>
/// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <exception cref="ArgumentNullException"> Thrown when any of the arugments are null. </exception>
@@ -65,6 +68,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Requests the sync manager to perform periodic sync operations.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="request"> The sync job information of the sync job request. </param>
/// <param name="period"> Determines the time interval of the periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee the exact time. The minimum value is 30 minutes. </param>
/// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
@@ -96,6 +100,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Requests the sync manager to perform sync operations whenever the corresponding DB is changed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="request"> The sync job information of the sync job request. </param>
/// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
@@ -127,6 +132,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Gets all the sync jobs registered with the sync manager.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <returns>
/// Returns the list of SyncJobData corresponding to sync requests.
/// </returns>
@@ -162,6 +168,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Requests the sync manager to remove the corresponding sync job based on the ID.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="id"> A unique value of each sync job, it can be used to search a specific sync job and remove it. </param>
/// <exception cref="ArgumentException"> Thrown if the input arugments is invalid. </exception>
public static void RemoveSyncJob(int id)
diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs
index e9f88da..08a483d 100755
--- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs
+++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs
@@ -22,11 +22,13 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// This class represents information about the sync job request.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class SyncJobData
{
/// <summary>
/// Represents the calendar capability.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// If you want to receive notification about the calendar database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
@@ -35,6 +37,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Represents the contact capability.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// If you want to receive notification about the contact database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
@@ -43,6 +46,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Represents the image capability.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// If you want to receive notification about the image database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
@@ -51,6 +55,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Represents the video capability.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// If you want to receive notification about the video database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
@@ -59,6 +64,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Represents the sound capability.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// If you want to receive notification about the sound database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
@@ -67,6 +73,7 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// Represents the music capability.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <remarks>
/// If you want to receive notification about the music database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
@@ -75,16 +82,19 @@ namespace Tizen.Account.SyncManager
/// <summary>
/// The account instance on which the sync operation was requested or @c null in the case of the accountless sync operation.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public AccountManager.Account Account { get; set; }
/// <summary>
/// User data which contains an additional information related to the registered sync job.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Bundle UserData { get; set; }
/// <summary>
/// A string representing a sync job which has been operated or capability setting to operate the data change sync job.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string SyncJobName { get; set; }
}
}