Added SYSTEM_SETTINGS_KEY_VIBRATION.
[platform/core/api/system-settings.git] / include / system_settings.h
1 /* * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
2  *
3  * Licensed under the Apache License, Version 2.0 (the License);
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an AS IS BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #ifndef __TIZEN_SYSTEM_SYSTEM_SETTINGS_H__
17 #define __TIZEN_SYSTEM_SYSTEM_SETTINGS_H__
18
19 #include <tizen.h>
20
21 #ifdef __cplusplus
22 extern "C"
23 {
24 #endif
25
26 /**
27  * @file system_settings.h
28  */
29
30 /**
31  * @addtogroup CAPI_SYSTEM_SYSTEM_SETTINGS_MODULE
32  * @{
33  */
34
35
36 /**
37  * @brief Enumeration for system settings error.
38  * @since_tizen 2.3
39  */
40 typedef enum {
41         SYSTEM_SETTINGS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
42         SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
43         SYSTEM_SETTINGS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
44         SYSTEM_SETTINGS_ERROR_IO_ERROR =  TIZEN_ERROR_IO_ERROR, /**< Internal I/O error */
45         SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED =  TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
46         SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED =  TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported @if MOBILE (Since 2.3.1) @endif */
47         SYSTEM_SETTINGS_ERROR_CALL_UNSUPPORTED_API = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported @if MOBILE (Since 2.3.1) @endif */
48
49         /* lock screen app error code */
50         SYSTEM_SETTINGS_ERROR_LOCKSCREEN_APP_PASSWORD_MODE = TIZEN_ERROR_SYSTEM_SETTING | 0x01, /**< Current lock screen app set 'password' type */
51 }
52 system_settings_error_e;
53
54
55 /**
56  * @brief Enumeration for System Settings Key.
57  * @since_tizen 2.3
58  */
59 typedef enum {
60         SYSTEM_SETTINGS_KEY_INCOMING_CALL_RINGTONE, /**< (string) The file path of the current ringtone */
61         SYSTEM_SETTINGS_KEY_WALLPAPER_HOME_SCREEN, /**< (string) The file path of the current home screen wallpaper */
62         SYSTEM_SETTINGS_KEY_WALLPAPER_LOCK_SCREEN, /**< (string) The file path of the current lock screen wallpaper */
63         SYSTEM_SETTINGS_KEY_FONT_SIZE, /**< (int) The current system font size */
64         SYSTEM_SETTINGS_KEY_FONT_TYPE, /**< (string) The current system font type */
65         SYSTEM_SETTINGS_KEY_MOTION_ACTIVATION, /**< (bool) Indicates whether the motion service is activated */
66         SYSTEM_SETTINGS_KEY_EMAIL_ALERT_RINGTONE,  /**< (string) The file path of the current email alert ringtone */
67         SYSTEM_SETTINGS_KEY_USB_DEBUGGING_ENABLED,      /**< (bool) Indicates whether the USB debugging is enabled (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
68         SYSTEM_SETTINGS_KEY_3G_DATA_NETWORK_ENABLED,  /**< (bool) Indicates whether the 3G data network is enabled (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
69         SYSTEM_SETTINGS_KEY_LOCKSCREEN_APP = SYSTEM_SETTINGS_KEY_3G_DATA_NETWORK_ENABLED+2,      /**< (string) Indicates lockscreen app pkg name  */
70         SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE,/**< (string) The current system default font type (only support Get) */
71         SYSTEM_SETTINGS_KEY_LOCALE_COUNTRY,             /**< (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format */
72         SYSTEM_SETTINGS_KEY_LOCALE_LANGUAGE,    /**< (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format. */
73         SYSTEM_SETTINGS_KEY_LOCALE_TIMEFORMAT_24HOUR,   /**< (bool) Indicates whether the 24-hour clock is used. If the value is @c false, the 12-hour clock is used. */
74         SYSTEM_SETTINGS_KEY_LOCALE_TIMEZONE,    /**< (string) Indicates the current time zone. */
75         SYSTEM_SETTINGS_KEY_TIME_CHANGED,               /**< (int) Once System changes time, this event occurs to notify time change. */
76         SYSTEM_SETTINGS_KEY_SOUND_LOCK,                                 /**< GET (bool) Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound */
77         SYSTEM_SETTINGS_KEY_SOUND_SILENT_MODE,                  /**< GET (bool) Indicates whether the device is in the silent mode. */
78         SYSTEM_SETTINGS_KEY_SOUND_TOUCH,                                /**< GET (bool) Indicates whether the screen touch sound is enabled on the device. */
79         SYSTEM_SETTINGS_KEY_DISPLAY_SCREEN_ROTATION_AUTO,       /**< GET (bool) Indicates whether rotation control is automatic.*/
80         SYSTEM_SETTINGS_KEY_DEVICE_NAME,                                        /**< GET (string) Indicates device name. */
81         SYSTEM_SETTINGS_KEY_MOTION_ENABLED,                                     /**< GET (bool) Indicates whether the device user has enabled the motion feature. */
82         SYSTEM_SETTINGS_KEY_NETWORK_WIFI_NOTIFICATION,          /**< GET (bool) Indicates whether Wi-Fi-related notifications are enabled on the device. */
83         SYSTEM_SETTINGS_KEY_NETWORK_FLIGHT_MODE,                        /**< GET (bool) Indicates whether the device is in the flight mode. */
84         SYSTEM_SETTINGS_KEY_SCREEN_BACKLIGHT_TIME,                      /**< (int) Indicates the backlight time (in seconds). @internal The following values can be used: 15, 30, 60, 120, 300, and 600. */
85         SYSTEM_SETTINGS_KEY_SOUND_NOTIFICATION,                         /**< (string) Indicates the file path of the current notification tone set by the user. */
86         SYSTEM_SETTINGS_KEY_SOUND_NOTIFICATION_REPETITION_PERIOD,       /**< (int) Indicates the time period for notification repetitions. */
87         SYSTEM_SETTINGS_KEY_LOCK_STATE,         /**< (int) Indicates the current lock state */
88         SYSTEM_SETTINGS_KEY_ADS_ID, /**< (string) Indicates Ads ID for each device (Since 3.0) */
89         SYSTEM_SETTINGS_KEY_ULTRA_DATA_SAVE, /**< (int) Indicates Ultra Data Save status, one of #system_settings_uds_state_e values (Since 4.0) */
90         SYSTEM_SETTINGS_KEY_ULTRA_DATA_SAVE_PKG_LIST, /**< (string) Indicates Ultra Data Save Package List (Since 4.0), the list is a string containing whitelisted package names separated with semicolons (;) */
91         SYSTEM_SETTINGS_KEY_ACCESSIBILITY_TTS,                          /**< GET (bool) Indicates whether the accessibility TTS is enabled on the device. (Since 4.0) */
92         SYSTEM_SETTINGS_KEY_VIBRATION,                          /**< (bool) Indicates whether vibration is enabled on the device. (Since 4.0) */
93         SYSTEM_SETTINGS_KEY_MAX,
94 } system_settings_key_e;
95
96 /**
97  * @brief Enumeration for Idle Lock State
98  * @since_tizen 2.3.1
99  */
100 typedef enum {
101         SYSTEM_SETTINGS_LOCK_STATE_UNLOCK = 0, /**< Device is unlocked */
102         SYSTEM_SETTINGS_LOCK_STATE_LOCK, /**< Device is locked */
103         SYSTEM_SETTINGS_LOCK_STATE_LAUNCHING_LOCK /**< Device is being locked */
104 } system_settings_idle_lock_state_e;
105
106
107 /**
108  * @brief Enumeration for font size.
109  * @since_tizen 2.3
110  */
111 typedef enum {
112         SYSTEM_SETTINGS_FONT_SIZE_SMALL = 0, /**< A small size */
113         SYSTEM_SETTINGS_FONT_SIZE_NORMAL, /**< A normal size */
114         SYSTEM_SETTINGS_FONT_SIZE_LARGE, /**< A large size */
115         SYSTEM_SETTINGS_FONT_SIZE_HUGE, /**< A huge size */
116         SYSTEM_SETTINGS_FONT_SIZE_GIANT, /**< A giant size */
117 } system_settings_font_size_e;
118
119 /**
120  * @brief Enumeration for Ultra Data Save
121  * @since_tizen 4.0
122  */
123 typedef enum {
124         SYSTEM_SETTINGS_UDS_OFF = 0,                    /**< OFF */
125         SYSTEM_SETTINGS_UDS_ON,                                 /**< ON */
126         SYSTEM_SETTINGS_UDS_ON_WHITELISTED,             /**< UDS on and the app is whitelisted */
127 } system_settings_uds_state_e;
128
129
130
131 /**
132  * @brief Called when the system settings changes.
133  * @since_tizen 2.3
134  * @param[in] key The key name of the system settings changed system settings
135  * @param[in] user_data The user data passed from the callback registration function
136  * @pre system_settings_set_changed_cb() will invoke this callback function.
137  * @see system_settings_set_changed_cb()
138  * @see system_settings_unset_changed_cb()
139  */
140 typedef void (*system_settings_changed_cb)(system_settings_key_e key, void *user_data);
141
142 /**
143  * @platform
144  * @brief Sets the system settings value associated with the given key as an integer.
145  * @since_tizen 2.3
146  * @privlevel platform
147  * @privilege %http://tizen.org/privilege/systemsettings.admin
148  * @remarks When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
149  * @param[in] key The key name of the system settings
150  * @param[out] value The new system settings value of the given key
151  * @return @c 0 on success, otherwise a negative error value
152  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
153  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
154  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
155  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
156  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
157  */
158 int system_settings_set_value_int(system_settings_key_e key, int value);
159
160 /**
161  * @brief Gets the system settings value associated with the given key as an integer.
162  * @since_tizen 2.3
163  * @remarks When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
164  * @param[in] key The key name of the system settings
165  * @param[out] value The current system settings value of the given key
166  * @return @c 0 on success, otherwise a negative error value
167  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
168  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
169  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
170  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
171  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
172  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
173  */
174 int system_settings_get_value_int(system_settings_key_e key, int *value);
175
176
177 /**
178  * @platform
179  * @brief Sets the system settings value associated with the given key as a boolean.
180  * @since_tizen 2.3
181  * @privlevel platform
182  * @privilege %http://tizen.org/privilege/systemsettings.admin
183  * @remarks When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
184  * @param[in] key The key name of the system settings
185  * @param[out] value The new system settings value of the given key
186  * @return @c 0 on success, otherwise a negative error value
187  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
188  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
189  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
190  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
191  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
192  */
193 int system_settings_set_value_bool(system_settings_key_e key, bool value);
194
195 /**
196  * @brief Gets the system settings value associated with the given key as a boolean.
197  * @since_tizen 2.3
198  * @remarks When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
199  * @param[in] key The key name of the system settings
200  * @param[out] value The current system settings value of the given key
201  * @return @c 0 on success, otherwise a negative error value
202  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
203  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
204  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
205  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
206  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
207  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
208  */
209 int system_settings_get_value_bool(system_settings_key_e key, bool *value);
210
211 /**
212  * @platform
213  * @brief Sets the system settings value associated with the given key as a string.
214  * @since_tizen 2.3
215  * @privlevel platform
216  * @privilege %http://tizen.org/privilege/systemsettings.admin
217  * @remarks #SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE is not available for setting. When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
218  * @param[in] key The key name of the system settings
219  * @param[out] value The new system settings value of the given key
220  * @return @c 0 on success, otherwise a negative error value
221  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
222  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
223  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
224  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
225  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
226  */
227 int system_settings_set_value_string(system_settings_key_e key, const char *value);
228
229 /**
230  * @brief Gets the system settings value associated with the given key as a string.
231  * @since_tizen 2.3
232  * @remarks You must release @a value using free(). When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
233  * @param[in] key The key name of the system settings
234  * @param[out] value The current system settings value of the given key
235  * @return      0 on success, otherwise a negative error value
236  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
237  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
238  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
239  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
240  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
241  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
242  */
243 int system_settings_get_value_string(system_settings_key_e key, char **value);
244
245 /**
246  * @brief Registers a change event callback for the given system settings key.
247  * @since_tizen 2.3
248  * @remarks #SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE is not available for set_changed_cb. When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
249  * @param[in] key The key name of the system settings
250  * @param[in] callback The callback function to invoke
251  * @param[in] user_data The user data to be passed to the callback function
252  * @return      0 on success, otherwise a negative error value
253  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
254  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
255  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
256  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
257  * @post system_settings_changed_cb() will be invoked.
258  *
259  * @see system_settings_unset_changed_cb()
260  * @see system_settings_changed_cb()
261  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
262  *
263 */
264 int system_settings_set_changed_cb(system_settings_key_e key, system_settings_changed_cb callback, void *user_data);
265
266 /**
267  * @brief Unregisters the callback function.
268  * @since_tizen 2.3
269  * @remarks #SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE is not available for set_changed_cb. When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
270  * @param[in] key The key name of the system settings
271  * @return      0 on success, otherwise a negative error value
272  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
273  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
274  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
275  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
276  *
277  * @see system_settings_set_changed_cb()
278  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
279  */
280 int system_settings_unset_changed_cb(system_settings_key_e key);
281
282
283 /**
284  * @platform
285  * @brief Called to get each string value from string typed list.
286  * @since_tizen 3.0
287  * @param[in] index zero based number indicating index of node in a list
288  * @param[in] value value returned from the list
289  * @param[in] cb_data  The user data passed from the foreach function
290  * @return @c true to continue with the next iteration of the loop, otherwise false to break out of the loop
291  */
292 typedef bool (*system_settings_iter_cb)(int index, const char* value, void *cb_data);
293
294 /**
295  * @platform
296  * @brief Iterate the system settings value associated with the given key as a string type.
297  * @since_tizen 3.0
298  * @privlevel platform
299  * @privilege %http://tizen.org/privilege/systemsettings.admin
300  * @remarks When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
301  * @param[in] key The key name of the system settings
302  * @param[in] callback The callback-function name for iteration
303  * @param[in] user_data  The user data passed from caller-side
304  * @return @c 0 on success, otherwise a negative error value
305  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
306  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
307  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
308  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
309  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
310  */
311 int system_settings_foreach_value_string(system_settings_key_e key, system_settings_iter_cb callback, void *user_data);
312
313 /**
314  * @platform
315  * @brief Adds the system settings value associated with the given key as a string type if it supports List iteration.
316  * @since_tizen 3.0
317  * @privlevel platform
318  * @privilege %http://tizen.org/privilege/systemsettings.admin
319  * @remarks When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
320  * @param[in] key The key name of the system settings
321  * @param[in] value string typed value to be appended
322  * @return @c 0 on success, otherwise a negative error value
323  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
324  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
325  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
326  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
327  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
328  */
329 int system_settings_add_value_string(system_settings_key_e key, const char *value);
330
331 /**
332  * @platform
333  * @brief Delete the system settings value associated with the given key as an string type if it supports List iteration.
334  * @since_tizen 3.0
335  * @privlevel platform
336  * @privilege %http://tizen.org/privilege/systemsettings.admin
337  * @remarks When the feature related to the @a key is not supported on the device, #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED will be returned.
338  * @param[in] key The key name of the system settings
339  * @param[in] value string typed value to be removed
340  * @return @c 0 on success, otherwise a negative error value
341  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
342  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
343  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
344  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
345  * @retval      #SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED The related feature is not supported on the device
346  */
347 int system_settings_delete_value_string(system_settings_key_e key, const char *value);
348
349 /**
350  * @}
351  */
352
353
354 #ifdef __cplusplus
355 }
356 #endif
357
358 #endif /* __TIZEN_SYSTEM_SYSTEM_SETTINGS_H__ */