/// <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";
/// <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,
}
}
/// <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;
/// <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);
/// <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>
/// <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()
{
/// 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()
{
}
/// <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>
/// <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>
/// <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>
/// <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>
/// <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)
/// <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>
/// <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>
/// <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>
/// <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>
/// <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>
/// <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>
/// <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; }
}
}
projects / platform / core / csapi / tizenfx.git / commitdiff