Artifacts/bin/public/Tizen.Account.SyncManager.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Account.SyncManager</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Interop.Libraries">
   8             <summary>
   9             Wrapper class for maintaining names of dependent native libraries.
  10             </summary>
  11         </member>
  12         <member name="T:Tizen.Account.SyncManager.SyncOption">
  13             <summary>
  14             Enumeration for the Sync option
  15             </summary>
  16         </member>
  17         <member name="F:Tizen.Account.SyncManager.SyncOption.None">
  18             <summary>
  19             Sync job will be operated normally
  20             </summary>
  21         </member>
  22         <member name="F:Tizen.Account.SyncManager.SyncOption.Expedited">
  23             <summary>
  24             Sync job will be operated as soon as possible
  25             </summary>
  26         </member>
  27         <member name="F:Tizen.Account.SyncManager.SyncOption.NoRetry">
  28             <summary>
  29             Sync job will not be performed again when it fails
  30             </summary>
  31         </member>
  32         <member name="T:Tizen.Account.SyncManager.SyncPeriod">
  33             <summary>
  34             Enumeration for the Sync period
  35             </summary>
  36         </member>
  37         <member name="F:Tizen.Account.SyncManager.SyncPeriod.ThirtyMin">
  38             <summary>
  39             Sync within 30 minutes
  40             </summary>
  41         </member>
  42         <member name="F:Tizen.Account.SyncManager.SyncPeriod.OneHour">
  43             <summary>
  44             Sync within 1 hour
  45             </summary>
  46         </member>
  47         <member name="F:Tizen.Account.SyncManager.SyncPeriod.TwoHours">
  48             <summary>
  49             Sync within 2 hours
  50             </summary>
  51         </member>
  52         <member name="F:Tizen.Account.SyncManager.SyncPeriod.ThreeHours">
  53             <summary>
  54             Sync within 3 hours
  55             </summary>
  56         </member>
  57         <member name="F:Tizen.Account.SyncManager.SyncPeriod.SixHours">
  58             <summary>
  59             Sync within 6 hours
  60             </summary>
  61         </member>
  62         <member name="F:Tizen.Account.SyncManager.SyncPeriod.TwelveHours">
  63             <summary>
  64             Sync within 12 hours
  65             </summary>
  66         </member>
  67         <member name="F:Tizen.Account.SyncManager.SyncPeriod.OneDay">
  68             <summary>
  69             Sync within 1 day
  70             </summary>
  71         </member>
  72         <member name="T:Tizen.Account.SyncManager.SyncAdapter">
  73             <summary>
  74             The class contains the delegates to be called upon scheduling a sync operation
  75             </summary>
  76         </member>
  77         <member name="T:Tizen.Account.SyncManager.SyncAdapter.StartSyncCallback">
  78             <summary>
  79             Callback function for Sync Adapter's start sync request
  80             </summary>
  81             <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
  82             <returns> true if sync operation is success, @c false otherwise. </returns>
  83         </member>
  84         <member name="T:Tizen.Account.SyncManager.SyncAdapter.CancelSyncCallback">
  85             <summary>
  86             Callback function for Sync Adapter's cancel sync request.
  87             </summary>
  88             <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
  89         </member>
  90         <member name="M:Tizen.Account.SyncManager.SyncAdapter.SetSyncEventCallbacks(Tizen.Account.SyncManager.SyncAdapter.StartSyncCallback,Tizen.Account.SyncManager.SyncAdapter.CancelSyncCallback)">
  91             <summary>
  92             Sets client (Sync Adapter) callback functions
  93             </summary>
  94             <param name="startSyncCb"> A callback function to be called by Sync Manager for performing sync operation. </param>
  95             <param name="cancelSyncCb"> A callback function to be called by Sync Manager for cancelling sync operation. </param>
  96             <exception cref="T:System.ArgumentNullException"> Thrown when any of the arguments are null. </exception>
  97             <exception cref="T:System.InvalidOperationException"> Thrown when the application calling this API cannot be a sync adapter. </exception>
  98         </member>
  99         <member name="M:Tizen.Account.SyncManager.SyncAdapter.UnsetSyncEventCallbacks">
 100             <summary>
 101             Unsets client (Sync Adapter) callback functions
 102             </summary>
 103             <exception cref="T:System.Exception"> Thrown when sync manager internal error occurs. </exception>
 104         </member>
 105         <member name="T:Tizen.Account.SyncManager.SyncClient">
 106             <summary>
 107             The SyncClient APIs for managing the sync operations. Applications will call these APIs to schedule their sync operations.
 108             Sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations.
 109             </summary>
 110         </member>
 111         <member name="M:Tizen.Account.SyncManager.SyncClient.#cctor">
 112             <summary>
 113             The constructor
 114             </summary>
 115         </member>
 116         <member name="M:Tizen.Account.SyncManager.SyncClient.RequestOnDemandSyncJob(Tizen.Account.SyncManager.SyncJobData,Tizen.Account.SyncManager.SyncOption)">
 117             <summary>
 118             Requests Sync Manager to perform one time sync operation
 119             </summary>
 120             <param name="request"> Sync job information of the sync job request. </param>
 121             <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
 122             <exception cref="T:System.ArgumentNullException"> Thrown when any of the arugments are null. </exception>
 123             <exception cref="T:System.InvalidOperationException"> Thrown when the application calling this api doesn't have a sync adapter. </exception>
 124             <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
 125         </member>
 126         <member name="M:Tizen.Account.SyncManager.SyncClient.AddPeriodicSyncJob(Tizen.Account.SyncManager.SyncJobData,Tizen.Account.SyncManager.SyncPeriod,Tizen.Account.SyncManager.SyncOption)">
 127             <summary>
 128             Requests Sync Manager to perform periodic sync operations
 129             </summary>
 130             <param name="request"> Sync job information of the sync job request. </param>
 131             <param name="period"> Determines time interval of periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee exact time. The minimum value is 30 minutes. </param>
 132             <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
 133             <privilege>http://tizen.org/privilege/alarm.set</privilege>
 134             <exception cref="T:System.UnauthorizedAccessException"> In case of privilege not defined. </exception>
 135             <exception cref="T:System.ArgumentNullException"> Thrown when any of the arguments are null. </exception>
 136             <exception cref="T:System.InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
 137             <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
 138         </member>
 139         <member name="M:Tizen.Account.SyncManager.SyncClient.AddDataChangeSyncJob(Tizen.Account.SyncManager.SyncJobData,Tizen.Account.SyncManager.SyncOption)">
 140             <summary>
 141             Requests Sync Manager to perform sync operations whenever corresponding DB changed
 142             </summary>
 143             <param name="request"> Sync job information of the sync job request. </param>
 144             <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
 145             <privilege>http://tizen.org/privilege/calendar.read</privilege>
 146             <privilege>http://tizen.org/privilege/contact.read</privilege>
 147             <exception cref="T:System.UnauthorizedAccessException"> In case of privilege not defined. </exception>
 148             <exception cref="T:System.ArgumentNullException"> Thrown when any of the arguments are null. </exception>
 149             <exception cref="T:System.InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
 150             <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
 151         </member>
 152         <member name="M:Tizen.Account.SyncManager.SyncClient.GetAllSyncJobs">
 153             <summary>
 154             Get all the sync jobs registered with the sync manager
 155             </summary>
 156             <returns>
 157             Returns the list of SyncJobData corresponding to sync requests.
 158             </returns>
 159         </member>
 160         <member name="M:Tizen.Account.SyncManager.SyncClient.RemoveSyncJob(System.Int32)">
 161             <summary>
 162             Requests Sync Manager to remove corresponding sync job job based on id
 163             </summary>
 164             <param name="id"> A unique value of each sync job, it can be used to search specific sync job and remove it. </param>
 165             <exception cref="T:System.ArgumentException"> Thrown if the input arugments is invalid. </exception>
 166         </member>
 167         <member name="T:Tizen.Account.SyncManager.SyncJobData">
 168             <summary>
 169             Class represents information about a sync job request
 170             </summary>
 171         </member>
 172         <member name="F:Tizen.Account.SyncManager.SyncJobData.CalendarCapability">
 173             <summary>
 174             Represents calendar capability
 175             </summary>
 176             <remarks>
 177             If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object.
 178             </remarks>
 179         </member>
 180         <member name="F:Tizen.Account.SyncManager.SyncJobData.ContactCapability">
 181             <summary>
 182             Represents contact capability
 183             </summary>
 184             <remarks>
 185             If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object.
 186             </remarks>
 187         </member>
 188         <member name="F:Tizen.Account.SyncManager.SyncJobData.ImageCapability">
 189             <summary>
 190             Represents image capability
 191             </summary>
 192             <remarks>
 193             If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object.
 194             </remarks>
 195         </member>
 196         <member name="F:Tizen.Account.SyncManager.SyncJobData.VideoCapability">
 197             <summary>
 198             Represents video capability
 199             </summary>
 200             <remarks>
 201             If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object.
 202             </remarks>
 203         </member>
 204         <member name="F:Tizen.Account.SyncManager.SyncJobData.SoundCapability">
 205             <summary>
 206             Represents sound capability
 207             </summary>
 208             <remarks>
 209             If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object.
 210             </remarks>
 211         </member>
 212         <member name="F:Tizen.Account.SyncManager.SyncJobData.MusicCapability">
 213             <summary>
 214             Represents music capability
 215             </summary>
 216             <remarks>
 217             If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object.
 218             </remarks>
 219         </member>
 220         <member name="P:Tizen.Account.SyncManager.SyncJobData.Account">
 221             <summary>
 222             The account instance on which sync operation was requested or @c null in the case of accountless sync operation
 223             </summary>
 224         </member>
 225         <member name="P:Tizen.Account.SyncManager.SyncJobData.UserData">
 226             <summary>
 227             User data which contains additional information related registered sync job
 228             </summary>
 229         </member>
 230         <member name="P:Tizen.Account.SyncManager.SyncJobData.SyncJobName">
 231             <summary>
 232             A string representing a sync job which has been operated or capability setting to operate data change sync job
 233             </summary>
 234         </member>
 235     </members>
 236 </doc>