4 <name>Tizen.Account.SyncManager</name>
7 <member name="T:Interop.Libraries">
9 Wrapper class for maintaining names of dependent native libraries.
12 <member name="T:Tizen.Account.SyncManager.SyncOption">
14 Enumeration for the Sync option
17 <member name="F:Tizen.Account.SyncManager.SyncOption.None">
19 Sync job will be operated normally
22 <member name="F:Tizen.Account.SyncManager.SyncOption.Expedited">
24 Sync job will be operated as soon as possible
27 <member name="F:Tizen.Account.SyncManager.SyncOption.NoRetry">
29 Sync job will not be performed again when it fails
32 <member name="T:Tizen.Account.SyncManager.SyncPeriod">
34 Enumeration for the Sync period
37 <member name="F:Tizen.Account.SyncManager.SyncPeriod.ThirtyMin">
39 Sync within 30 minutes
42 <member name="F:Tizen.Account.SyncManager.SyncPeriod.OneHour">
47 <member name="F:Tizen.Account.SyncManager.SyncPeriod.TwoHours">
52 <member name="F:Tizen.Account.SyncManager.SyncPeriod.ThreeHours">
57 <member name="F:Tizen.Account.SyncManager.SyncPeriod.SixHours">
62 <member name="F:Tizen.Account.SyncManager.SyncPeriod.TwelveHours">
67 <member name="F:Tizen.Account.SyncManager.SyncPeriod.OneDay">
72 <member name="T:Tizen.Account.SyncManager.SyncAdapter">
74 The class contains the delegates to be called upon scheduling a sync operation
77 <member name="T:Tizen.Account.SyncManager.SyncAdapter.StartSyncCallback">
79 Callback function for Sync Adapter's start sync request
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>
84 <member name="T:Tizen.Account.SyncManager.SyncAdapter.CancelSyncCallback">
86 Callback function for Sync Adapter's cancel sync request.
88 <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
90 <member name="M:Tizen.Account.SyncManager.SyncAdapter.SetSyncEventCallbacks(Tizen.Account.SyncManager.SyncAdapter.StartSyncCallback,Tizen.Account.SyncManager.SyncAdapter.CancelSyncCallback)">
92 Sets client (Sync Adapter) callback functions
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>
99 <member name="M:Tizen.Account.SyncManager.SyncAdapter.UnsetSyncEventCallbacks">
101 Unsets client (Sync Adapter) callback functions
103 <exception cref="T:System.Exception"> Thrown when sync manager internal error occurs. </exception>
105 <member name="T:Tizen.Account.SyncManager.SyncClient">
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.
111 <member name="M:Tizen.Account.SyncManager.SyncClient.#cctor">
116 <member name="M:Tizen.Account.SyncManager.SyncClient.RequestOnDemandSyncJob(Tizen.Account.SyncManager.SyncJobData,Tizen.Account.SyncManager.SyncOption)">
118 Requests Sync Manager to perform one time sync operation
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>
126 <member name="M:Tizen.Account.SyncManager.SyncClient.AddPeriodicSyncJob(Tizen.Account.SyncManager.SyncJobData,Tizen.Account.SyncManager.SyncPeriod,Tizen.Account.SyncManager.SyncOption)">
128 Requests Sync Manager to perform periodic sync operations
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>
139 <member name="M:Tizen.Account.SyncManager.SyncClient.AddDataChangeSyncJob(Tizen.Account.SyncManager.SyncJobData,Tizen.Account.SyncManager.SyncOption)">
141 Requests Sync Manager to perform sync operations whenever corresponding DB changed
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>
152 <member name="M:Tizen.Account.SyncManager.SyncClient.GetAllSyncJobs">
154 Get all the sync jobs registered with the sync manager
157 Returns the list of SyncJobData corresponding to sync requests.
160 <member name="M:Tizen.Account.SyncManager.SyncClient.RemoveSyncJob(System.Int32)">
162 Requests Sync Manager to remove corresponding sync job job based on id
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>
167 <member name="T:Tizen.Account.SyncManager.SyncJobData">
169 Class represents information about a sync job request
172 <member name="F:Tizen.Account.SyncManager.SyncJobData.CalendarCapability">
174 Represents calendar capability
177 If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object.
180 <member name="F:Tizen.Account.SyncManager.SyncJobData.ContactCapability">
182 Represents contact capability
185 If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object.
188 <member name="F:Tizen.Account.SyncManager.SyncJobData.ImageCapability">
190 Represents image capability
193 If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object.
196 <member name="F:Tizen.Account.SyncManager.SyncJobData.VideoCapability">
198 Represents video capability
201 If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object.
204 <member name="F:Tizen.Account.SyncManager.SyncJobData.SoundCapability">
206 Represents sound capability
209 If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object.
212 <member name="F:Tizen.Account.SyncManager.SyncJobData.MusicCapability">
214 Represents music capability
217 If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object.
220 <member name="P:Tizen.Account.SyncManager.SyncJobData.Account">
222 The account instance on which sync operation was requested or @c null in the case of accountless sync operation
225 <member name="P:Tizen.Account.SyncManager.SyncJobData.UserData">
227 User data which contains additional information related registered sync job
230 <member name="P:Tizen.Account.SyncManager.SyncJobData.SyncJobName">
232 A string representing a sync job which has been operated or capability setting to operate data change sync job