Review system-settings API cs files
[platform/core/csapi/system-settings.git] / Tizen.System.SystemSettings / Tizen.System.SystemSettings / SystemSettingsEnums.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 namespace Tizen.System
18 {
19     /// <summary>
20     /// Enumeration for all the available system settings.
21     /// </summary>
22     public enum SystemSettingsKeys : int
23     {
24         /// <summary>
25         /// GET (string) The file path of the current ringtone.
26         /// </summary>
27         IncomingCallRingtone = 0,
28         /// <summary>
29         /// GET (string) The file path of the current home-screen wallpaper.
30         /// </summary>
31         WallpaperHomeScreen,
32         /// <summary>
33         /// GET (string) The file path of the current lock-screen wallpaper.
34         /// </summary>
35         WallpaperLockScreen,
36         /// <summary>
37         /// GET (int) The current system font size.
38         /// </summary>
39         FontSize,
40         /// <summary>
41         /// GET (string) The current system font type.
42         /// </summary>
43         FontType,
44         /// <summary>
45         /// GET (bool) Indicates whether the motion service is activated.
46         /// </summary>
47         MotionActivationEnabled,
48         /// <summary>
49         /// GET (string) The file path of the current email alert ringtone.
50         /// </summary>
51         EmailAlertRingtone,
52         /// <summary>
53         /// GET (bool) Indicates whether the USB debugging is enabled.
54         /// </summary>
55         UsbDebuggingEnabled,
56         /// <summary>
57         /// GET (bool) Indicates whether the 3G-data network is enabled.
58         /// </summary>
59         Data3GNetworkEnabled,
60         /// <summary>
61         /// GET (string) Indicates the lock-screen application package name.
62         /// </summary>
63         LockscreenApp = Data3GNetworkEnabled + 2,
64         /// <summary>
65         /// GET (string) The current system default font type (only supports Get).
66         /// </summary>
67         DefaultFontType,
68         /// <summary>
69         /// GET (string) Indicates the current country setting in the &lt;LANGUAGE&gt;_&lt;REGION&gt; syntax.
70         /// The country setting is in the ISO 639-2 format,
71         /// and the region setting is in the ISO 3166-1 alpha-2 format.
72         /// </summary>
73         LocaleCountry,
74         /// <summary>
75         /// GET (string) Indicates the current language setting in the &lt;LANGUAGE&gt;_&lt;REGION&gt; syntax.
76         /// The language setting is in the ISO 639-2 format,
77         /// and the region setting is in the ISO 3166-1 alpha-2 format.
78         /// </summary>
79         LocaleLanguage,
80         /// <summary>
81         /// GET (bool) Indicates whether the 24-hour clock is used.
82         /// If the value is false, the 12-hour clock is used.
83         /// </summary>
84         LocaleTimeFormat24HourEnabled,
85         /// <summary>
86         /// GET (string) Indicates the current time zone, for example, Pacific/Tahiti.
87         /// </summary>
88         LocaleTimeZone,
89         /// <summary>
90         /// GET (int) Once system changes the time, this event occurs to notify the time change.
91         /// </summary>
92         Time,
93         /// <summary>
94         /// GET (bool) Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
95         /// </summary>
96         SoundLockEnabled,
97         /// <summary>
98         /// GET (bool) Indicates whether the device is in the silent mode.
99         /// </summary>
100         SoundSilentModeEnabled,
101         /// <summary>
102         /// GET (bool) Indicates whether the screen touch sound is enabled on the device.
103         /// </summary>
104         SoundTouchEnabled,
105         /// <summary>
106         /// GET (bool) Indicates whether the rotation control is automatic.
107         /// </summary>
108         DisplayScreenRotationAutoEnabled,
109         /// <summary>
110         /// GET (string) Indicates the device name.
111         /// </summary>
112         DeviceName,
113         /// <summary>
114         /// GET (bool) Indicates whether the device user has the enabled motion feature.
115         /// </summary>
116         MotionEnabled,
117         /// <summary>
118         /// GET (bool) Indicates whether WiFi-related notifications are enabled on the device.
119         /// </summary>
120         NetworkWifiNotificationEnabled,
121         /// <summary>
122         /// GET (bool) Indicates whether the device is in the flight mode.
123         /// </summary>
124         NetworkFlightModeEnabled,
125         /// <summary>
126         /// GET (int) Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600.
127         /// </summary>
128         ScreenBacklightTime,
129         /// <summary>
130         /// GET (string) Indicates the file path of the current notification tone set by the user.
131         /// </summary>
132         SoundNotification,
133         /// <summary>
134         /// GET (int) Indicates the time period for notification repetitions.
135         /// </summary>
136         SoundNotificationRepetitionPeriod,
137         /// <summary>
138         /// GET (int) Indicates the current lock state.
139         /// </summary>
140         LockState,
141         /// <summary>
142         /// GET (string) Indicates the ADS ID for each device.
143         /// </summary>
144         AdsId,
145         /// <summary>
146         /// GET (int) Indicates the Ultra Data Save status, one of the #SystemSettingsUdsState values.
147         /// </summary>
148         UltraDataSave,
149         /// <summary>
150         /// GET (string) Indicates the Ultra Data Save Package List. Since 4.0, the list is a string containing whitelisted package names separated with semicolons (;).
151         /// </summary>
152         UltraDataSavePackageList
153     }
154     /// <summary>
155     /// Enumeration for the Idle Lock State.
156     /// </summary>
157     public enum SystemSettingsIdleLockState : int
158     {
159         /// <summary>
160         /// The device is unlocked.
161         /// </summary>
162         Unlock = 0,
163         /// <summary>
164         /// The device is locked.
165         /// </summary>
166         Lock,
167         /// <summary>
168         /// The device is being locked.
169         /// </summary>
170         LaunchingLock
171     }
172     /// <summary>
173     /// Enumeration for the font size.
174     /// </summary>
175     public enum SystemSettingsFontSize : int
176     {
177         /// <summary>
178         /// A small size.
179         /// </summary>
180         Small = 0,
181         /// <summary>
182         /// A normal size.
183         /// </summary>
184         Normal,
185         /// <summary>
186         /// A large size.
187         /// </summary>
188         Large,
189         /// <summary>
190         /// A huge size.
191         /// </summary>
192         Huge,
193         /// <summary>
194         /// A giant size.
195         /// </summary>
196         Giant
197     }
198     /// <summary>
199     /// Enumeration for the ultra data save.
200     /// </summary>
201     public enum SystemSettingsUdsState : int
202     {
203         /// <summary>
204         /// UDS Off.
205         /// </summary>
206         UdsOff = 0,
207         /// <summary>
208         /// UDS On.
209         /// </summary>
210         UdsOn,
211         /// <summary>
212         /// UDS On and the application is whitelisted.
213         /// </summary>
214         UdsOnWhitelisted,
215     }
216 }