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