[Multimedia] Updated the doc-comments to fix the grammar errors.
[platform/core/csapi/tizenfx.git] / src / Tizen.Account.SyncManager / Tizen.Account.SyncManager / SyncJobData.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 using Tizen.Applications;
18 using Tizen.Account.AccountManager;
19
20 namespace Tizen.Account.SyncManager
21 {
22     /// <summary>
23     /// Class represents information about a sync job request
24     /// </summary>
25     public class SyncJobData
26     {
27         /// <summary>
28         /// Represents calendar capability
29         /// </summary>
30         /// <remarks>
31         /// If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object.
32         /// </remarks>
33         public const string CalendarCapability = "http://tizen.org/sync/capability/calendar";
34
35         /// <summary>
36         /// Represents contact capability
37         /// </summary>
38         /// <remarks>
39         /// If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object.
40         /// </remarks>
41         public const string ContactCapability = "http://tizen.org/sync/capability/contact";
42
43         /// <summary>
44         /// Represents image capability
45         /// </summary>
46         /// <remarks>
47         /// If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object.
48         /// </remarks>
49         public const string ImageCapability = "http://tizen.org/sync/capability/image";
50
51         /// <summary>
52         /// Represents video capability
53         /// </summary>
54         /// <remarks>
55         /// If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object.
56         /// </remarks>
57         public const string VideoCapability = "http://tizen.org/sync/capability/video";
58
59         /// <summary>
60         /// Represents sound capability
61         /// </summary>
62         /// <remarks>
63         /// If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object.
64         /// </remarks>
65         public const string SoundCapability = "http://tizen.org/sync/capability/sound";
66
67         /// <summary>
68         /// Represents music capability
69         /// </summary>
70         /// <remarks>
71         /// If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object.
72         /// </remarks>
73         public const string MusicCapability = "http://tizen.org/sync/capability/music";
74
75         /// <summary>
76         /// The account instance on which sync operation was requested or @c null in the case of accountless sync operation
77         /// </summary>
78         public AccountManager.Account Account { get; set; }
79
80         /// <summary>
81         /// User data which contains additional information related registered sync job
82         /// </summary>
83         public Bundle UserData { get; set; }
84
85         /// <summary>
86         /// A string representing a sync job which has been operated or capability setting to operate data change sync job
87         /// </summary>
88         public string SyncJobName { get; set; }
89     }
90 }
91