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

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