blob: ec7d4405e3c555902cdec9ec0bab1c27f7215aaf [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
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
17package android.provider;
18
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080019
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080020
21import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Mike LeBeau5d34e9b2010-02-10 19:34:56 -080023import android.content.ComponentName;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080024import android.content.ContentResolver;
25import android.content.ContentValues;
26import android.content.Context;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -080027import android.content.IContentProvider;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028import android.content.Intent;
Dianne Hackbornb8b11a02010-03-10 15:53:11 -080029import android.content.pm.ActivityInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Configuration;
33import android.content.res.Resources;
34import android.database.Cursor;
35import android.database.SQLException;
36import android.net.Uri;
Irfan Sheriff36f74132010-11-04 16:57:37 -070037import android.net.wifi.WifiManager;
Svetoslav Ganov585f13f8d2010-08-10 07:59:15 -070038import android.os.BatteryManager;
39import android.os.Bundle;
40import android.os.RemoteException;
41import android.os.SystemProperties;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080042import android.text.TextUtils;
43import android.util.AndroidException;
Dan Egnor799f7212009-11-24 16:24:44 -080044import android.util.Config;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080045import android.util.Log;
46
47import java.net.URISyntaxException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080048import java.util.HashMap;
49import java.util.HashSet;
50
51
52/**
53 * The Settings provider contains global system-level device preferences.
54 */
55public final class Settings {
56
57 // Intent actions for Settings
58
59 /**
60 * Activity Action: Show system settings.
61 * <p>
62 * Input: Nothing.
63 * <p>
64 * Output: nothing.
65 */
66 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
67 public static final String ACTION_SETTINGS = "android.settings.SETTINGS";
68
69 /**
70 * Activity Action: Show settings to allow configuration of APNs.
71 * <p>
72 * Input: Nothing.
73 * <p>
74 * Output: nothing.
75 */
76 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
77 public static final String ACTION_APN_SETTINGS = "android.settings.APN_SETTINGS";
78
79 /**
80 * Activity Action: Show settings to allow configuration of current location
81 * sources.
82 * <p>
83 * In some cases, a matching Activity may not exist, so ensure you
84 * safeguard against this.
85 * <p>
86 * Input: Nothing.
87 * <p>
88 * Output: Nothing.
89 */
90 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
91 public static final String ACTION_LOCATION_SOURCE_SETTINGS =
92 "android.settings.LOCATION_SOURCE_SETTINGS";
93
94 /**
95 * Activity Action: Show settings to allow configuration of wireless controls
96 * such as Wi-Fi, Bluetooth and Mobile networks.
97 * <p>
98 * In some cases, a matching Activity may not exist, so ensure you
99 * safeguard against this.
100 * <p>
101 * Input: Nothing.
102 * <p>
103 * Output: Nothing.
104 */
105 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
106 public static final String ACTION_WIRELESS_SETTINGS =
107 "android.settings.WIRELESS_SETTINGS";
108
109 /**
110 * Activity Action: Show settings to allow entering/exiting airplane mode.
111 * <p>
112 * In some cases, a matching Activity may not exist, so ensure you
113 * safeguard against this.
114 * <p>
115 * Input: Nothing.
116 * <p>
117 * Output: Nothing.
118 */
119 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
120 public static final String ACTION_AIRPLANE_MODE_SETTINGS =
121 "android.settings.AIRPLANE_MODE_SETTINGS";
122
123 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -0700124 * Activity Action: Show settings for accessibility modules.
125 * <p>
126 * In some cases, a matching Activity may not exist, so ensure you
127 * safeguard against this.
128 * <p>
129 * Input: Nothing.
130 * <p>
131 * Output: Nothing.
132 */
133 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
134 public static final String ACTION_ACCESSIBILITY_SETTINGS =
135 "android.settings.ACCESSIBILITY_SETTINGS";
136
137 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800138 * Activity Action: Show settings to allow configuration of security and
139 * location privacy.
140 * <p>
141 * In some cases, a matching Activity may not exist, so ensure you
142 * safeguard against this.
143 * <p>
144 * Input: Nothing.
145 * <p>
146 * Output: Nothing.
147 */
148 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
149 public static final String ACTION_SECURITY_SETTINGS =
150 "android.settings.SECURITY_SETTINGS";
151
152 /**
Amith Yamasanic15255a2009-09-23 15:33:19 -0700153 * Activity Action: Show settings to allow configuration of privacy options.
154 * <p>
155 * In some cases, a matching Activity may not exist, so ensure you
156 * safeguard against this.
157 * <p>
158 * Input: Nothing.
159 * <p>
160 * Output: Nothing.
161 */
162 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
163 public static final String ACTION_PRIVACY_SETTINGS =
164 "android.settings.PRIVACY_SETTINGS";
165
166 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800167 * Activity Action: Show settings to allow configuration of Wi-Fi.
168
169 * <p>
170 * In some cases, a matching Activity may not exist, so ensure you
171 * safeguard against this.
172 * <p>
173 * Input: Nothing.
174 * <p>
175 * Output: Nothing.
176
177 */
178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
179 public static final String ACTION_WIFI_SETTINGS =
180 "android.settings.WIFI_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700181
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800182 /**
183 * Activity Action: Show settings to allow configuration of a static IP
184 * address for Wi-Fi.
185 * <p>
186 * In some cases, a matching Activity may not exist, so ensure you safeguard
187 * against this.
188 * <p>
189 * Input: Nothing.
190 * <p>
191 * Output: Nothing.
192 */
193 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
194 public static final String ACTION_WIFI_IP_SETTINGS =
195 "android.settings.WIFI_IP_SETTINGS";
196
197 /**
198 * Activity Action: Show settings to allow configuration of Bluetooth.
199 * <p>
200 * In some cases, a matching Activity may not exist, so ensure you
201 * safeguard against this.
202 * <p>
203 * Input: Nothing.
204 * <p>
205 * Output: Nothing.
206 */
207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
208 public static final String ACTION_BLUETOOTH_SETTINGS =
209 "android.settings.BLUETOOTH_SETTINGS";
210
211 /**
212 * Activity Action: Show settings to allow configuration of date and time.
213 * <p>
214 * In some cases, a matching Activity may not exist, so ensure you
215 * safeguard against this.
216 * <p>
217 * Input: Nothing.
218 * <p>
219 * Output: Nothing.
220 */
221 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
222 public static final String ACTION_DATE_SETTINGS =
223 "android.settings.DATE_SETTINGS";
224
225 /**
226 * Activity Action: Show settings to allow configuration of sound and volume.
227 * <p>
228 * In some cases, a matching Activity may not exist, so ensure you
229 * safeguard against this.
230 * <p>
231 * Input: Nothing.
232 * <p>
233 * Output: Nothing.
234 */
235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
236 public static final String ACTION_SOUND_SETTINGS =
237 "android.settings.SOUND_SETTINGS";
238
239 /**
240 * Activity Action: Show settings to allow configuration of display.
241 * <p>
242 * In some cases, a matching Activity may not exist, so ensure you
243 * safeguard against this.
244 * <p>
245 * Input: Nothing.
246 * <p>
247 * Output: Nothing.
248 */
249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
250 public static final String ACTION_DISPLAY_SETTINGS =
251 "android.settings.DISPLAY_SETTINGS";
252
253 /**
254 * Activity Action: Show settings to allow configuration of locale.
255 * <p>
256 * In some cases, a matching Activity may not exist, so ensure you
257 * safeguard against this.
258 * <p>
259 * Input: Nothing.
260 * <p>
261 * Output: Nothing.
262 */
263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
264 public static final String ACTION_LOCALE_SETTINGS =
265 "android.settings.LOCALE_SETTINGS";
266
267 /**
268 * Activity Action: Show settings to configure input methods, in particular
269 * allowing the user to enable input methods.
270 * <p>
271 * In some cases, a matching Activity may not exist, so ensure you
272 * safeguard against this.
273 * <p>
274 * Input: Nothing.
275 * <p>
276 * Output: Nothing.
277 */
278 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
279 public static final String ACTION_INPUT_METHOD_SETTINGS =
280 "android.settings.INPUT_METHOD_SETTINGS";
281
282 /**
Tadashi G. Takaokaf49688f2011-01-20 17:56:13 +0900283 * Activity Action: Show settings to enable/disable input method subtypes.
satok86417ea2010-10-27 14:11:03 +0900284 * <p>
285 * In some cases, a matching Activity may not exist, so ensure you
286 * safeguard against this.
287 * <p>
Tadashi G. Takaoka25480202011-01-20 23:13:02 +0900288 * To tell which input method's subtypes are displayed in the settings, add
289 * {@link #EXTRA_INPUT_METHOD_ID} extra to this Intent with the input method id.
290 * If there is no extra in this Intent, subtypes from all installed input methods
291 * will be displayed in the settings.
292 *
293 * @see android.view.inputmethod.InputMethodInfo#getId
294 * <p>
satok86417ea2010-10-27 14:11:03 +0900295 * Input: Nothing.
296 * <p>
297 * Output: Nothing.
298 */
299 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Tadashi G. Takaokaf49688f2011-01-20 17:56:13 +0900300 public static final String ACTION_INPUT_METHOD_SUBTYPE_SETTINGS =
301 "android.settings.INPUT_METHOD_SUBTYPE_SETTINGS";
satok86417ea2010-10-27 14:11:03 +0900302
303 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800304 * Activity Action: Show settings to manage the user input dictionary.
305 * <p>
306 * In some cases, a matching Activity may not exist, so ensure you
307 * safeguard against this.
308 * <p>
309 * Input: Nothing.
310 * <p>
311 * Output: Nothing.
312 */
313 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
314 public static final String ACTION_USER_DICTIONARY_SETTINGS =
315 "android.settings.USER_DICTIONARY_SETTINGS";
316
317 /**
318 * Activity Action: Show settings to allow configuration of application-related settings.
319 * <p>
320 * In some cases, a matching Activity may not exist, so ensure you
321 * safeguard against this.
322 * <p>
323 * Input: Nothing.
324 * <p>
325 * Output: Nothing.
326 */
327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
328 public static final String ACTION_APPLICATION_SETTINGS =
329 "android.settings.APPLICATION_SETTINGS";
330
331 /**
332 * Activity Action: Show settings to allow configuration of application
333 * development-related settings.
334 * <p>
335 * In some cases, a matching Activity may not exist, so ensure you safeguard
336 * against this.
337 * <p>
338 * Input: Nothing.
339 * <p>
340 * Output: Nothing.
341 */
342 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
343 public static final String ACTION_APPLICATION_DEVELOPMENT_SETTINGS =
344 "android.settings.APPLICATION_DEVELOPMENT_SETTINGS";
345
346 /**
347 * Activity Action: Show settings to allow configuration of quick launch shortcuts.
348 * <p>
349 * In some cases, a matching Activity may not exist, so ensure you
350 * safeguard against this.
351 * <p>
352 * Input: Nothing.
353 * <p>
354 * Output: Nothing.
355 */
356 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
357 public static final String ACTION_QUICK_LAUNCH_SETTINGS =
358 "android.settings.QUICK_LAUNCH_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700359
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800360 /**
361 * Activity Action: Show settings to manage installed applications.
362 * <p>
363 * In some cases, a matching Activity may not exist, so ensure you
364 * safeguard against this.
365 * <p>
366 * Input: Nothing.
367 * <p>
368 * Output: Nothing.
369 */
370 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
371 public static final String ACTION_MANAGE_APPLICATIONS_SETTINGS =
372 "android.settings.MANAGE_APPLICATIONS_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700373
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800374 /**
Winson Chung44e8ff92010-09-27 14:36:52 -0700375 * Activity Action: Show settings to manage all applications.
376 * <p>
377 * In some cases, a matching Activity may not exist, so ensure you
378 * safeguard against this.
379 * <p>
380 * Input: Nothing.
381 * <p>
382 * Output: Nothing.
383 */
384 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
385 public static final String ACTION_MANAGE_ALL_APPLICATIONS_SETTINGS =
386 "android.settings.MANAGE_ALL_APPLICATIONS_SETTINGS";
387
388 /**
Dianne Hackbornb7bb3b32010-06-06 22:47:50 -0700389 * Activity Action: Show screen of details about a particular application.
390 * <p>
391 * In some cases, a matching Activity may not exist, so ensure you
392 * safeguard against this.
393 * <p>
394 * Input: The Intent's data URI specifies the application package name
395 * to be shown, with the "package" scheme. That is "package:com.my.app".
396 * <p>
397 * Output: Nothing.
398 */
399 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
400 public static final String ACTION_APPLICATION_DETAILS_SETTINGS =
401 "android.settings.APPLICATION_DETAILS_SETTINGS";
402
403 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800404 * Activity Action: Show settings for system update functionality.
405 * <p>
406 * In some cases, a matching Activity may not exist, so ensure you
407 * safeguard against this.
408 * <p>
409 * Input: Nothing.
410 * <p>
411 * Output: Nothing.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700412 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800413 * @hide
414 */
415 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
416 public static final String ACTION_SYSTEM_UPDATE_SETTINGS =
417 "android.settings.SYSTEM_UPDATE_SETTINGS";
418
419 /**
420 * Activity Action: Show settings to allow configuration of sync settings.
421 * <p>
422 * In some cases, a matching Activity may not exist, so ensure you
423 * safeguard against this.
424 * <p>
Erikeebc8e22010-02-18 13:27:19 -0800425 * The account types available to add via the add account button may be restricted by adding an
426 * {@link #EXTRA_AUTHORITIES} extra to this Intent with one or more syncable content provider's
427 * authorities. Only account types which can sync with that content provider will be offered to
428 * the user.
429 * <p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800430 * Input: Nothing.
431 * <p>
432 * Output: Nothing.
433 */
434 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
435 public static final String ACTION_SYNC_SETTINGS =
436 "android.settings.SYNC_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700437
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800438 /**
Erikeebc8e22010-02-18 13:27:19 -0800439 * Activity Action: Show add account screen for creating a new account.
440 * <p>
441 * In some cases, a matching Activity may not exist, so ensure you
442 * safeguard against this.
443 * <p>
444 * The account types available to add may be restricted by adding an {@link #EXTRA_AUTHORITIES}
445 * extra to the Intent with one or more syncable content provider's authorities. Only account
446 * types which can sync with that content provider will be offered to the user.
447 * <p>
448 * Input: Nothing.
449 * <p>
450 * Output: Nothing.
451 */
452 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
453 public static final String ACTION_ADD_ACCOUNT =
454 "android.settings.ADD_ACCOUNT_SETTINGS";
455
456 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800457 * Activity Action: Show settings for selecting the network operator.
458 * <p>
459 * In some cases, a matching Activity may not exist, so ensure you
460 * safeguard against this.
461 * <p>
462 * Input: Nothing.
463 * <p>
464 * Output: Nothing.
465 */
466 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
467 public static final String ACTION_NETWORK_OPERATOR_SETTINGS =
468 "android.settings.NETWORK_OPERATOR_SETTINGS";
469
470 /**
471 * Activity Action: Show settings for selection of 2G/3G.
472 * <p>
473 * In some cases, a matching Activity may not exist, so ensure you
474 * safeguard against this.
475 * <p>
476 * Input: Nothing.
477 * <p>
478 * Output: Nothing.
479 */
480 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
481 public static final String ACTION_DATA_ROAMING_SETTINGS =
482 "android.settings.DATA_ROAMING_SETTINGS";
483
484 /**
485 * Activity Action: Show settings for internal storage.
486 * <p>
487 * In some cases, a matching Activity may not exist, so ensure you
488 * safeguard against this.
489 * <p>
490 * Input: Nothing.
491 * <p>
492 * Output: Nothing.
493 */
494 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
495 public static final String ACTION_INTERNAL_STORAGE_SETTINGS =
496 "android.settings.INTERNAL_STORAGE_SETTINGS";
497 /**
498 * Activity Action: Show settings for memory card storage.
499 * <p>
500 * In some cases, a matching Activity may not exist, so ensure you
501 * safeguard against this.
502 * <p>
503 * Input: Nothing.
504 * <p>
505 * Output: Nothing.
506 */
507 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
508 public static final String ACTION_MEMORY_CARD_SETTINGS =
509 "android.settings.MEMORY_CARD_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700510
Justin Mattsonef340352010-01-13 21:05:46 -0800511 /**
512 * Activity Action: Show settings for global search.
513 * <p>
514 * In some cases, a matching Activity may not exist, so ensure you
515 * safeguard against this.
516 * <p>
517 * Input: Nothing.
518 * <p>
519 * Output: Nothing
520 */
521 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
522 public static final String ACTION_SEARCH_SETTINGS =
523 "android.search.action.SEARCH_SETTINGS";
524
Daniel Sandler9d8b8762010-01-22 20:50:15 -0500525 /**
526 * Activity Action: Show general device information settings (serial
527 * number, software version, phone number, etc.).
528 * <p>
529 * In some cases, a matching Activity may not exist, so ensure you
530 * safeguard against this.
531 * <p>
532 * Input: Nothing.
533 * <p>
534 * Output: Nothing
535 */
536 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
537 public static final String ACTION_DEVICE_INFO_SETTINGS =
538 "android.settings.DEVICE_INFO_SETTINGS";
539
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800540 // End of Intent actions for Settings
541
Erikeebc8e22010-02-18 13:27:19 -0800542 /**
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800543 * @hide - Private call() method on SettingsProvider to read from 'system' table.
544 */
545 public static final String CALL_METHOD_GET_SYSTEM = "GET_system";
546
547 /**
548 * @hide - Private call() method on SettingsProvider to read from 'secure' table.
549 */
550 public static final String CALL_METHOD_GET_SECURE = "GET_secure";
551
552 /**
Erikeebc8e22010-02-18 13:27:19 -0800553 * Activity Extra: Limit available options in launched activity based on the given authority.
554 * <p>
555 * This can be passed as an extra field in an Activity Intent with one or more syncable content
556 * provider's authorities as a String[]. This field is used by some intents to alter the
557 * behavior of the called activity.
558 * <p>
559 * Example: The {@link #ACTION_ADD_ACCOUNT} intent restricts the account types available based
560 * on the authority given.
561 */
562 public static final String EXTRA_AUTHORITIES =
563 "authorities";
564
Tadashi G. Takaoka25480202011-01-20 23:13:02 +0900565 public static final String EXTRA_INPUT_METHOD_ID = "input_method_id";
566
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800567 private static final String JID_RESOURCE_PREFIX = "android";
568
569 public static final String AUTHORITY = "settings";
570
571 private static final String TAG = "Settings";
Dan Egnor799f7212009-11-24 16:24:44 -0800572 private static final boolean LOCAL_LOGV = Config.LOGV || false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800573
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800574 public static class SettingNotFoundException extends AndroidException {
575 public SettingNotFoundException(String msg) {
576 super(msg);
577 }
578 }
579
580 /**
581 * Common base for tables of name/value settings.
582 */
583 public static class NameValueTable implements BaseColumns {
584 public static final String NAME = "name";
585 public static final String VALUE = "value";
586
587 protected static boolean putString(ContentResolver resolver, Uri uri,
588 String name, String value) {
589 // The database will take care of replacing duplicates.
590 try {
591 ContentValues values = new ContentValues();
592 values.put(NAME, name);
593 values.put(VALUE, value);
594 resolver.insert(uri, values);
595 return true;
596 } catch (SQLException e) {
Dianne Hackborna33e3f72009-09-29 17:28:24 -0700597 Log.w(TAG, "Can't set key " + name + " in " + uri, e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800598 return false;
599 }
600 }
601
602 public static Uri getUriFor(Uri uri, String name) {
603 return Uri.withAppendedPath(uri, name);
604 }
605 }
606
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800607 // Thread-safe.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800608 private static class NameValueCache {
609 private final String mVersionSystemProperty;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800610 private final Uri mUri;
611
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800612 private static final String[] SELECT_VALUE =
613 new String[] { Settings.NameValueTable.VALUE };
614 private static final String NAME_EQ_PLACEHOLDER = "name=?";
615
616 // Must synchronize on 'this' to access mValues and mValuesVersion.
Dan Egnor799f7212009-11-24 16:24:44 -0800617 private final HashMap<String, String> mValues = new HashMap<String, String>();
618 private long mValuesVersion = 0;
619
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800620 // Initially null; set lazily and held forever. Synchronized on 'this'.
621 private IContentProvider mContentProvider = null;
622
623 // The method we'll call (or null, to not use) on the provider
624 // for the fast path of retrieving settings.
625 private final String mCallCommand;
626
627 public NameValueCache(String versionSystemProperty, Uri uri, String callCommand) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800628 mVersionSystemProperty = versionSystemProperty;
629 mUri = uri;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800630 mCallCommand = callCommand;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800631 }
632
Dan Egnor799f7212009-11-24 16:24:44 -0800633 public String getString(ContentResolver cr, String name) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800634 long newValuesVersion = SystemProperties.getLong(mVersionSystemProperty, 0);
Dan Egnor799f7212009-11-24 16:24:44 -0800635
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800636 synchronized (this) {
Dan Egnor799f7212009-11-24 16:24:44 -0800637 if (mValuesVersion != newValuesVersion) {
638 if (LOCAL_LOGV) {
639 Log.v(TAG, "invalidate [" + mUri.getLastPathSegment() + "]: current " +
640 newValuesVersion + " != cached " + mValuesVersion);
641 }
642
643 mValues.clear();
644 mValuesVersion = newValuesVersion;
645 }
646
647 if (mValues.containsKey(name)) {
648 return mValues.get(name); // Could be null, that's OK -- negative caching
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800649 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800650 }
Dan Egnor799f7212009-11-24 16:24:44 -0800651
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800652 IContentProvider cp = null;
653 synchronized (this) {
654 cp = mContentProvider;
655 if (cp == null) {
656 cp = mContentProvider = cr.acquireProvider(mUri.getAuthority());
657 }
658 }
659
660 // Try the fast path first, not using query(). If this
661 // fails (alternate Settings provider that doesn't support
662 // this interface?) then we fall back to the query/table
663 // interface.
664 if (mCallCommand != null) {
665 try {
666 Bundle b = cp.call(mCallCommand, name, null);
667 if (b != null) {
668 String value = b.getPairValue();
669 synchronized (this) {
670 mValues.put(name, value);
671 }
672 return value;
673 }
674 // If the response Bundle is null, we fall through
675 // to the query interface below.
676 } catch (RemoteException e) {
677 // Not supported by the remote side? Fall through
678 // to query().
679 }
680 }
681
Dan Egnor799f7212009-11-24 16:24:44 -0800682 Cursor c = null;
683 try {
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800684 c = cp.query(mUri, SELECT_VALUE, NAME_EQ_PLACEHOLDER,
685 new String[]{name}, null);
Dan Egnor799f7212009-11-24 16:24:44 -0800686 if (c == null) {
687 Log.w(TAG, "Can't get key " + name + " from " + mUri);
688 return null;
689 }
690
691 String value = c.moveToNext() ? c.getString(0) : null;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800692 synchronized (this) {
Dan Egnor799f7212009-11-24 16:24:44 -0800693 mValues.put(name, value);
694 }
695 if (LOCAL_LOGV) {
696 Log.v(TAG, "cache miss [" + mUri.getLastPathSegment() + "]: " +
697 name + " = " + (value == null ? "(null)" : value));
698 }
699 return value;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800700 } catch (RemoteException e) {
Dan Egnor799f7212009-11-24 16:24:44 -0800701 Log.w(TAG, "Can't get key " + name + " from " + mUri, e);
702 return null; // Return null, but don't cache it.
703 } finally {
704 if (c != null) c.close();
705 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800706 }
707 }
708
709 /**
710 * System settings, containing miscellaneous system preferences. This
711 * table holds simple name/value pairs. There are convenience
712 * functions for accessing individual settings entries.
713 */
714 public static final class System extends NameValueTable {
715 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_system_version";
716
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800717 // Populated lazily, guarded by class object:
718 private static NameValueCache sNameValueCache = null;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700719
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800720 private static final HashSet<String> MOVED_TO_SECURE;
721 static {
722 MOVED_TO_SECURE = new HashSet<String>(30);
723 MOVED_TO_SECURE.add(Secure.ADB_ENABLED);
724 MOVED_TO_SECURE.add(Secure.ANDROID_ID);
725 MOVED_TO_SECURE.add(Secure.BLUETOOTH_ON);
726 MOVED_TO_SECURE.add(Secure.DATA_ROAMING);
727 MOVED_TO_SECURE.add(Secure.DEVICE_PROVISIONED);
728 MOVED_TO_SECURE.add(Secure.HTTP_PROXY);
729 MOVED_TO_SECURE.add(Secure.INSTALL_NON_MARKET_APPS);
730 MOVED_TO_SECURE.add(Secure.LOCATION_PROVIDERS_ALLOWED);
Amith Yamasani156c4352010-03-05 17:10:03 -0800731 MOVED_TO_SECURE.add(Secure.LOCK_PATTERN_ENABLED);
732 MOVED_TO_SECURE.add(Secure.LOCK_PATTERN_VISIBLE);
733 MOVED_TO_SECURE.add(Secure.LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800734 MOVED_TO_SECURE.add(Secure.LOGGING_ID);
735 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_ENABLED);
736 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_LAST_UPDATE);
737 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_REDIRECT_URL);
738 MOVED_TO_SECURE.add(Secure.SETTINGS_CLASSNAME);
739 MOVED_TO_SECURE.add(Secure.USB_MASS_STORAGE_ENABLED);
740 MOVED_TO_SECURE.add(Secure.USE_GOOGLE_MAIL);
741 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON);
742 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY);
743 MOVED_TO_SECURE.add(Secure.WIFI_NUM_OPEN_NETWORKS_KEPT);
744 MOVED_TO_SECURE.add(Secure.WIFI_ON);
745 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE);
746 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_AP_COUNT);
747 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS);
748 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED);
749 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS);
750 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT);
751 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_MAX_AP_CHECKS);
752 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ON);
753 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_COUNT);
754 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_DELAY_MS);
755 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS);
756 }
757
758 /**
759 * Look up a name in the database.
760 * @param resolver to access the database with
761 * @param name to look up in the table
762 * @return the corresponding value, or null if not present
763 */
764 public synchronized static String getString(ContentResolver resolver, String name) {
765 if (MOVED_TO_SECURE.contains(name)) {
766 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
767 + " to android.provider.Settings.Secure, returning read-only value.");
768 return Secure.getString(resolver, name);
769 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800770 if (sNameValueCache == null) {
771 sNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI,
772 CALL_METHOD_GET_SYSTEM);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800773 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800774 return sNameValueCache.getString(resolver, name);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800775 }
776
777 /**
778 * Store a name/value pair into the database.
779 * @param resolver to access the database with
780 * @param name to store
781 * @param value to associate with the name
782 * @return true if the value was set, false on database errors
783 */
784 public static boolean putString(ContentResolver resolver, String name, String value) {
785 if (MOVED_TO_SECURE.contains(name)) {
786 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
787 + " to android.provider.Settings.Secure, value is unchanged.");
788 return false;
789 }
790 return putString(resolver, CONTENT_URI, name, value);
791 }
792
793 /**
794 * Construct the content URI for a particular name/value pair,
795 * useful for monitoring changes with a ContentObserver.
796 * @param name to look up in the table
797 * @return the corresponding content URI, or null if not present
798 */
799 public static Uri getUriFor(String name) {
800 if (MOVED_TO_SECURE.contains(name)) {
801 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
802 + " to android.provider.Settings.Secure, returning Secure URI.");
803 return Secure.getUriFor(Secure.CONTENT_URI, name);
804 }
805 return getUriFor(CONTENT_URI, name);
806 }
807
808 /**
809 * Convenience function for retrieving a single system settings value
810 * as an integer. Note that internally setting values are always
811 * stored as strings; this function converts the string to an integer
812 * for you. The default value will be returned if the setting is
813 * not defined or not an integer.
814 *
815 * @param cr The ContentResolver to access.
816 * @param name The name of the setting to retrieve.
817 * @param def Value to return if the setting is not defined.
818 *
819 * @return The setting's current value, or 'def' if it is not defined
820 * or not a valid integer.
821 */
822 public static int getInt(ContentResolver cr, String name, int def) {
823 String v = getString(cr, name);
824 try {
825 return v != null ? Integer.parseInt(v) : def;
826 } catch (NumberFormatException e) {
827 return def;
828 }
829 }
830
831 /**
832 * Convenience function for retrieving a single system settings value
833 * as an integer. Note that internally setting values are always
834 * stored as strings; this function converts the string to an integer
835 * for you.
836 * <p>
837 * This version does not take a default value. If the setting has not
838 * been set, or the string value is not a number,
839 * it throws {@link SettingNotFoundException}.
840 *
841 * @param cr The ContentResolver to access.
842 * @param name The name of the setting to retrieve.
843 *
844 * @throws SettingNotFoundException Thrown if a setting by the given
845 * name can't be found or the setting value is not an integer.
846 *
847 * @return The setting's current value.
848 */
849 public static int getInt(ContentResolver cr, String name)
850 throws SettingNotFoundException {
851 String v = getString(cr, name);
852 try {
853 return Integer.parseInt(v);
854 } catch (NumberFormatException e) {
855 throw new SettingNotFoundException(name);
856 }
857 }
858
859 /**
860 * Convenience function for updating a single settings value as an
861 * integer. This will either create a new entry in the table if the
862 * given name does not exist, or modify the value of the existing row
863 * with that name. Note that internally setting values are always
864 * stored as strings, so this function converts the given value to a
865 * string before storing it.
866 *
867 * @param cr The ContentResolver to access.
868 * @param name The name of the setting to modify.
869 * @param value The new value for the setting.
870 * @return true if the value was set, false on database errors
871 */
872 public static boolean putInt(ContentResolver cr, String name, int value) {
873 return putString(cr, name, Integer.toString(value));
874 }
875
876 /**
877 * Convenience function for retrieving a single system settings value
878 * as a {@code long}. Note that internally setting values are always
879 * stored as strings; this function converts the string to a {@code long}
880 * for you. The default value will be returned if the setting is
881 * not defined or not a {@code long}.
882 *
883 * @param cr The ContentResolver to access.
884 * @param name The name of the setting to retrieve.
885 * @param def Value to return if the setting is not defined.
886 *
887 * @return The setting's current value, or 'def' if it is not defined
888 * or not a valid {@code long}.
889 */
890 public static long getLong(ContentResolver cr, String name, long def) {
891 String valString = getString(cr, name);
892 long value;
893 try {
894 value = valString != null ? Long.parseLong(valString) : def;
895 } catch (NumberFormatException e) {
896 value = def;
897 }
898 return value;
899 }
900
901 /**
902 * Convenience function for retrieving a single system settings value
903 * as a {@code long}. Note that internally setting values are always
904 * stored as strings; this function converts the string to a {@code long}
905 * for you.
906 * <p>
907 * This version does not take a default value. If the setting has not
908 * been set, or the string value is not a number,
909 * it throws {@link SettingNotFoundException}.
910 *
911 * @param cr The ContentResolver to access.
912 * @param name The name of the setting to retrieve.
913 *
914 * @return The setting's current value.
915 * @throws SettingNotFoundException Thrown if a setting by the given
916 * name can't be found or the setting value is not an integer.
917 */
918 public static long getLong(ContentResolver cr, String name)
919 throws SettingNotFoundException {
920 String valString = getString(cr, name);
921 try {
922 return Long.parseLong(valString);
923 } catch (NumberFormatException e) {
924 throw new SettingNotFoundException(name);
925 }
926 }
927
928 /**
929 * Convenience function for updating a single settings value as a long
930 * integer. This will either create a new entry in the table if the
931 * given name does not exist, or modify the value of the existing row
932 * with that name. Note that internally setting values are always
933 * stored as strings, so this function converts the given value to a
934 * string before storing it.
935 *
936 * @param cr The ContentResolver to access.
937 * @param name The name of the setting to modify.
938 * @param value The new value for the setting.
939 * @return true if the value was set, false on database errors
940 */
941 public static boolean putLong(ContentResolver cr, String name, long value) {
942 return putString(cr, name, Long.toString(value));
943 }
944
945 /**
946 * Convenience function for retrieving a single system settings value
947 * as a floating point number. Note that internally setting values are
948 * always stored as strings; this function converts the string to an
949 * float for you. The default value will be returned if the setting
950 * is not defined or not a valid float.
951 *
952 * @param cr The ContentResolver to access.
953 * @param name The name of the setting to retrieve.
954 * @param def Value to return if the setting is not defined.
955 *
956 * @return The setting's current value, or 'def' if it is not defined
957 * or not a valid float.
958 */
959 public static float getFloat(ContentResolver cr, String name, float def) {
960 String v = getString(cr, name);
961 try {
962 return v != null ? Float.parseFloat(v) : def;
963 } catch (NumberFormatException e) {
964 return def;
965 }
966 }
967
968 /**
969 * Convenience function for retrieving a single system settings value
970 * as a float. Note that internally setting values are always
971 * stored as strings; this function converts the string to a float
972 * for you.
973 * <p>
974 * This version does not take a default value. If the setting has not
975 * been set, or the string value is not a number,
976 * it throws {@link SettingNotFoundException}.
977 *
978 * @param cr The ContentResolver to access.
979 * @param name The name of the setting to retrieve.
980 *
981 * @throws SettingNotFoundException Thrown if a setting by the given
982 * name can't be found or the setting value is not a float.
983 *
984 * @return The setting's current value.
985 */
986 public static float getFloat(ContentResolver cr, String name)
987 throws SettingNotFoundException {
988 String v = getString(cr, name);
Brian Muramatsue1d46982010-12-06 17:34:20 -0800989 if (v == null) {
990 throw new SettingNotFoundException(name);
991 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800992 try {
993 return Float.parseFloat(v);
994 } catch (NumberFormatException e) {
995 throw new SettingNotFoundException(name);
996 }
997 }
998
999 /**
1000 * Convenience function for updating a single settings value as a
1001 * floating point number. This will either create a new entry in the
1002 * table if the given name does not exist, or modify the value of the
1003 * existing row with that name. Note that internally setting values
1004 * are always stored as strings, so this function converts the given
1005 * value to a string before storing it.
1006 *
1007 * @param cr The ContentResolver to access.
1008 * @param name The name of the setting to modify.
1009 * @param value The new value for the setting.
1010 * @return true if the value was set, false on database errors
1011 */
1012 public static boolean putFloat(ContentResolver cr, String name, float value) {
1013 return putString(cr, name, Float.toString(value));
1014 }
1015
1016 /**
1017 * Convenience function to read all of the current
1018 * configuration-related settings into a
1019 * {@link Configuration} object.
1020 *
1021 * @param cr The ContentResolver to access.
1022 * @param outConfig Where to place the configuration settings.
1023 */
1024 public static void getConfiguration(ContentResolver cr, Configuration outConfig) {
1025 outConfig.fontScale = Settings.System.getFloat(
1026 cr, FONT_SCALE, outConfig.fontScale);
1027 if (outConfig.fontScale < 0) {
1028 outConfig.fontScale = 1;
1029 }
1030 }
1031
1032 /**
1033 * Convenience function to write a batch of configuration-related
1034 * settings from a {@link Configuration} object.
1035 *
1036 * @param cr The ContentResolver to access.
1037 * @param config The settings to write.
1038 * @return true if the values were set, false on database errors
1039 */
1040 public static boolean putConfiguration(ContentResolver cr, Configuration config) {
1041 return Settings.System.putFloat(cr, FONT_SCALE, config.fontScale);
1042 }
1043
Dianne Hackbornb8b11a02010-03-10 15:53:11 -08001044 /** @hide */
1045 public static boolean hasInterestingConfigurationChanges(int changes) {
1046 return (changes&ActivityInfo.CONFIG_FONT_SCALE) != 0;
1047 }
Jaikumar Ganesh545e6702010-06-04 10:23:03 -07001048
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001049 public static boolean getShowGTalkServiceStatus(ContentResolver cr) {
1050 return getInt(cr, SHOW_GTALK_SERVICE_STATUS, 0) != 0;
1051 }
1052
1053 public static void setShowGTalkServiceStatus(ContentResolver cr, boolean flag) {
1054 putInt(cr, SHOW_GTALK_SERVICE_STATUS, flag ? 1 : 0);
1055 }
1056
1057 /**
1058 * The content:// style URL for this table
1059 */
1060 public static final Uri CONTENT_URI =
1061 Uri.parse("content://" + AUTHORITY + "/system");
1062
1063 /**
1064 * Whether we keep the device on while the device is plugged in.
1065 * Supported values are:
1066 * <ul>
1067 * <li>{@code 0} to never stay on while plugged in</li>
1068 * <li>{@link BatteryManager#BATTERY_PLUGGED_AC} to stay on for AC charger</li>
1069 * <li>{@link BatteryManager#BATTERY_PLUGGED_USB} to stay on for USB charger</li>
1070 * </ul>
1071 * These values can be OR-ed together.
1072 */
1073 public static final String STAY_ON_WHILE_PLUGGED_IN = "stay_on_while_plugged_in";
1074
1075 /**
1076 * What happens when the user presses the end call button if they're not
1077 * on a call.<br/>
1078 * <b>Values:</b><br/>
1079 * 0 - The end button does nothing.<br/>
1080 * 1 - The end button goes to the home screen.<br/>
1081 * 2 - The end button puts the device to sleep and locks the keyguard.<br/>
1082 * 3 - The end button goes to the home screen. If the user is already on the
1083 * home screen, it puts the device to sleep.
1084 */
1085 public static final String END_BUTTON_BEHAVIOR = "end_button_behavior";
1086
1087 /**
David Brown458e8062010-03-08 21:52:11 -08001088 * END_BUTTON_BEHAVIOR value for "go home".
1089 * @hide
1090 */
1091 public static final int END_BUTTON_BEHAVIOR_HOME = 0x1;
1092
1093 /**
1094 * END_BUTTON_BEHAVIOR value for "go to sleep".
1095 * @hide
1096 */
1097 public static final int END_BUTTON_BEHAVIOR_SLEEP = 0x2;
1098
1099 /**
1100 * END_BUTTON_BEHAVIOR default value.
1101 * @hide
1102 */
1103 public static final int END_BUTTON_BEHAVIOR_DEFAULT = END_BUTTON_BEHAVIOR_SLEEP;
1104
1105 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001106 * Whether Airplane Mode is on.
1107 */
1108 public static final String AIRPLANE_MODE_ON = "airplane_mode_on";
1109
1110 /**
1111 * Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.
1112 */
1113 public static final String RADIO_BLUETOOTH = "bluetooth";
1114
1115 /**
1116 * Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.
1117 */
1118 public static final String RADIO_WIFI = "wifi";
1119
1120 /**
1121 * Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.
1122 */
1123 public static final String RADIO_CELL = "cell";
1124
1125 /**
1126 * A comma separated list of radios that need to be disabled when airplane mode
1127 * is on. This overrides WIFI_ON and BLUETOOTH_ON, if Wi-Fi and bluetooth are
1128 * included in the comma separated list.
1129 */
1130 public static final String AIRPLANE_MODE_RADIOS = "airplane_mode_radios";
1131
1132 /**
Mike Lockwoodbd5ddf02009-07-29 21:37:14 -07001133 * A comma separated list of radios that should to be disabled when airplane mode
1134 * is on, but can be manually reenabled by the user. For example, if RADIO_WIFI is
1135 * added to both AIRPLANE_MODE_RADIOS and AIRPLANE_MODE_TOGGLEABLE_RADIOS, then Wifi
1136 * will be turned off when entering airplane mode, but the user will be able to reenable
1137 * Wifi in the Settings app.
1138 *
1139 * {@hide}
1140 */
1141 public static final String AIRPLANE_MODE_TOGGLEABLE_RADIOS = "airplane_mode_toggleable_radios";
1142
1143 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001144 * The policy for deciding when Wi-Fi should go to sleep (which will in
1145 * turn switch to using the mobile data as an Internet connection).
1146 * <p>
1147 * Set to one of {@link #WIFI_SLEEP_POLICY_DEFAULT},
1148 * {@link #WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED}, or
1149 * {@link #WIFI_SLEEP_POLICY_NEVER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001150 */
1151 public static final String WIFI_SLEEP_POLICY = "wifi_sleep_policy";
1152
1153 /**
1154 * Value for {@link #WIFI_SLEEP_POLICY} to use the default Wi-Fi sleep
1155 * policy, which is to sleep shortly after the turning off
1156 * according to the {@link #STAY_ON_WHILE_PLUGGED_IN} setting.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001157 */
1158 public static final int WIFI_SLEEP_POLICY_DEFAULT = 0;
1159
1160 /**
1161 * Value for {@link #WIFI_SLEEP_POLICY} to use the default policy when
1162 * the device is on battery, and never go to sleep when the device is
1163 * plugged in.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001164 */
1165 public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED = 1;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001166
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001167 /**
1168 * Value for {@link #WIFI_SLEEP_POLICY} to never go to sleep.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001169 */
1170 public static final int WIFI_SLEEP_POLICY_NEVER = 2;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001171
Irfan Sheriff31b62322010-08-30 12:26:00 -07001172 //TODO: deprecate static IP constants
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001173 /**
1174 * Whether to use static IP and other static network attributes.
1175 * <p>
1176 * Set to 1 for true and 0 for false.
1177 */
1178 public static final String WIFI_USE_STATIC_IP = "wifi_use_static_ip";
1179
1180 /**
1181 * The static IP address.
1182 * <p>
1183 * Example: "192.168.1.51"
1184 */
1185 public static final String WIFI_STATIC_IP = "wifi_static_ip";
1186
1187 /**
1188 * If using static IP, the gateway's IP address.
1189 * <p>
1190 * Example: "192.168.1.1"
1191 */
1192 public static final String WIFI_STATIC_GATEWAY = "wifi_static_gateway";
1193
1194 /**
1195 * If using static IP, the net mask.
1196 * <p>
1197 * Example: "255.255.255.0"
1198 */
1199 public static final String WIFI_STATIC_NETMASK = "wifi_static_netmask";
1200
1201 /**
1202 * If using static IP, the primary DNS's IP address.
1203 * <p>
1204 * Example: "192.168.1.1"
1205 */
1206 public static final String WIFI_STATIC_DNS1 = "wifi_static_dns1";
1207
1208 /**
1209 * If using static IP, the secondary DNS's IP address.
1210 * <p>
1211 * Example: "192.168.1.2"
1212 */
1213 public static final String WIFI_STATIC_DNS2 = "wifi_static_dns2";
1214
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001215
1216 /**
1217 * Determines whether remote devices may discover and/or connect to
1218 * this device.
1219 * <P>Type: INT</P>
1220 * 2 -- discoverable and connectable
1221 * 1 -- connectable but not discoverable
1222 * 0 -- neither connectable nor discoverable
1223 */
1224 public static final String BLUETOOTH_DISCOVERABILITY =
1225 "bluetooth_discoverability";
1226
1227 /**
1228 * Bluetooth discoverability timeout. If this value is nonzero, then
1229 * Bluetooth becomes discoverable for a certain number of seconds,
1230 * after which is becomes simply connectable. The value is in seconds.
1231 */
1232 public static final String BLUETOOTH_DISCOVERABILITY_TIMEOUT =
1233 "bluetooth_discoverability_timeout";
1234
1235 /**
Amith Yamasani156c4352010-03-05 17:10:03 -08001236 * @deprecated Use {@link android.provider.Settings.Secure#LOCK_PATTERN_ENABLED}
1237 * instead
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001238 */
Amith Yamasani156c4352010-03-05 17:10:03 -08001239 @Deprecated
1240 public static final String LOCK_PATTERN_ENABLED = Secure.LOCK_PATTERN_ENABLED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001241
1242 /**
Amith Yamasani156c4352010-03-05 17:10:03 -08001243 * @deprecated Use {@link android.provider.Settings.Secure#LOCK_PATTERN_VISIBLE}
1244 * instead
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001245 */
Amith Yamasani156c4352010-03-05 17:10:03 -08001246 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001247 public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
1248
1249 /**
Jaikumar Ganesh545e6702010-06-04 10:23:03 -07001250 * @deprecated Use
Amith Yamasani156c4352010-03-05 17:10:03 -08001251 * {@link android.provider.Settings.Secure#LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED}
1252 * instead
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001253 */
Amith Yamasani156c4352010-03-05 17:10:03 -08001254 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001255 public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
1256 "lock_pattern_tactile_feedback_enabled";
1257
1258
1259 /**
1260 * A formatted string of the next alarm that is set, or the empty string
1261 * if there is no alarm set.
1262 */
1263 public static final String NEXT_ALARM_FORMATTED = "next_alarm_formatted";
1264
1265 /**
1266 * Scaling factor for fonts, float.
1267 */
1268 public static final String FONT_SCALE = "font_scale";
1269
1270 /**
1271 * Name of an application package to be debugged.
1272 */
1273 public static final String DEBUG_APP = "debug_app";
1274
1275 /**
1276 * If 1, when launching DEBUG_APP it will wait for the debugger before
1277 * starting user code. If 0, it will run normally.
1278 */
1279 public static final String WAIT_FOR_DEBUGGER = "wait_for_debugger";
1280
1281 /**
1282 * Whether or not to dim the screen. 0=no 1=yes
1283 */
1284 public static final String DIM_SCREEN = "dim_screen";
1285
1286 /**
1287 * The timeout before the screen turns off.
1288 */
1289 public static final String SCREEN_OFF_TIMEOUT = "screen_off_timeout";
1290
1291 /**
Mitsuru Oshimae5fb3282009-06-09 21:16:08 -07001292 * If 0, the compatibility mode is off for all applications.
1293 * If 1, older applications run under compatibility mode.
1294 * TODO: remove this settings before code freeze (bug/1907571)
1295 * @hide
1296 */
1297 public static final String COMPATIBILITY_MODE = "compatibility_mode";
1298
1299 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001300 * The screen backlight brightness between 0 and 255.
1301 */
1302 public static final String SCREEN_BRIGHTNESS = "screen_brightness";
1303
1304 /**
Dan Murphy951764b2009-08-27 14:59:03 -05001305 * Control whether to enable automatic brightness mode.
Dan Murphy951764b2009-08-27 14:59:03 -05001306 */
1307 public static final String SCREEN_BRIGHTNESS_MODE = "screen_brightness_mode";
1308
1309 /**
Mike Lockwooddc3494e2009-10-14 21:17:09 -07001310 * SCREEN_BRIGHTNESS_MODE value for manual mode.
Mike Lockwooddc3494e2009-10-14 21:17:09 -07001311 */
1312 public static final int SCREEN_BRIGHTNESS_MODE_MANUAL = 0;
1313
1314 /**
1315 * SCREEN_BRIGHTNESS_MODE value for manual mode.
Mike Lockwooddc3494e2009-10-14 21:17:09 -07001316 */
1317 public static final int SCREEN_BRIGHTNESS_MODE_AUTOMATIC = 1;
1318
1319 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001320 * Control whether the process CPU usage meter should be shown.
1321 */
1322 public static final String SHOW_PROCESSES = "show_processes";
1323
1324 /**
1325 * If 1, the activity manager will aggressively finish activities and
1326 * processes as soon as they are no longer needed. If 0, the normal
1327 * extended lifetime is used.
1328 */
1329 public static final String ALWAYS_FINISH_ACTIVITIES =
1330 "always_finish_activities";
1331
1332
1333 /**
1334 * Ringer mode. This is used internally, changing this value will not
1335 * change the ringer mode. See AudioManager.
1336 */
1337 public static final String MODE_RINGER = "mode_ringer";
1338
1339 /**
1340 * Determines which streams are affected by ringer mode changes. The
1341 * stream type's bit should be set to 1 if it should be muted when going
1342 * into an inaudible ringer mode.
1343 */
1344 public static final String MODE_RINGER_STREAMS_AFFECTED = "mode_ringer_streams_affected";
1345
1346 /**
1347 * Determines which streams are affected by mute. The
1348 * stream type's bit should be set to 1 if it should be muted when a mute request
1349 * is received.
1350 */
1351 public static final String MUTE_STREAMS_AFFECTED = "mute_streams_affected";
1352
1353 /**
1354 * Whether vibrate is on for different events. This is used internally,
1355 * changing this value will not change the vibrate. See AudioManager.
1356 */
1357 public static final String VIBRATE_ON = "vibrate_on";
1358
1359 /**
1360 * Ringer volume. This is used internally, changing this value will not
1361 * change the volume. See AudioManager.
1362 */
1363 public static final String VOLUME_RING = "volume_ring";
1364
1365 /**
1366 * System/notifications volume. This is used internally, changing this
1367 * value will not change the volume. See AudioManager.
1368 */
1369 public static final String VOLUME_SYSTEM = "volume_system";
1370
1371 /**
1372 * Voice call volume. This is used internally, changing this value will
1373 * not change the volume. See AudioManager.
1374 */
1375 public static final String VOLUME_VOICE = "volume_voice";
1376
1377 /**
1378 * Music/media/gaming volume. This is used internally, changing this
1379 * value will not change the volume. See AudioManager.
1380 */
1381 public static final String VOLUME_MUSIC = "volume_music";
1382
1383 /**
1384 * Alarm volume. This is used internally, changing this
1385 * value will not change the volume. See AudioManager.
1386 */
1387 public static final String VOLUME_ALARM = "volume_alarm";
1388
1389 /**
1390 * Notification volume. This is used internally, changing this
1391 * value will not change the volume. See AudioManager.
1392 */
1393 public static final String VOLUME_NOTIFICATION = "volume_notification";
1394
1395 /**
Eric Laurent484d2882009-12-08 09:05:45 -08001396 * Bluetooth Headset volume. This is used internally, changing this value will
1397 * not change the volume. See AudioManager.
1398 */
1399 public static final String VOLUME_BLUETOOTH_SCO = "volume_bluetooth_sco";
1400
1401 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001402 * Whether the notifications should use the ring volume (value of 1) or
1403 * a separate notification volume (value of 0). In most cases, users
1404 * will have this enabled so the notification and ringer volumes will be
1405 * the same. However, power users can disable this and use the separate
1406 * notification volume control.
1407 * <p>
1408 * Note: This is a one-off setting that will be removed in the future
1409 * when there is profile support. For this reason, it is kept hidden
1410 * from the public APIs.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001411 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001412 * @hide
1413 */
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001414 public static final String NOTIFICATIONS_USE_RING_VOLUME =
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001415 "notifications_use_ring_volume";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001416
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001417 /**
Daniel Sandler6329bf72010-02-26 15:17:44 -05001418 * Whether silent mode should allow vibration feedback. This is used
1419 * internally in AudioService and the Sound settings activity to
1420 * coordinate decoupling of vibrate and silent modes. This setting
1421 * will likely be removed in a future release with support for
1422 * audio/vibe feedback profiles.
1423 *
1424 * @hide
1425 */
1426 public static final String VIBRATE_IN_SILENT = "vibrate_in_silent";
1427
1428 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001429 * The mapping of stream type (integer) to its setting.
1430 */
1431 public static final String[] VOLUME_SETTINGS = {
1432 VOLUME_VOICE, VOLUME_SYSTEM, VOLUME_RING, VOLUME_MUSIC,
Eric Laurent484d2882009-12-08 09:05:45 -08001433 VOLUME_ALARM, VOLUME_NOTIFICATION, VOLUME_BLUETOOTH_SCO
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001434 };
1435
1436 /**
1437 * Appended to various volume related settings to record the previous
1438 * values before they the settings were affected by a silent/vibrate
1439 * ringer mode change.
1440 */
1441 public static final String APPEND_FOR_LAST_AUDIBLE = "_last_audible";
1442
1443 /**
1444 * Persistent store for the system-wide default ringtone URI.
1445 * <p>
1446 * If you need to play the default ringtone at any given time, it is recommended
1447 * you give {@link #DEFAULT_RINGTONE_URI} to the media player. It will resolve
1448 * to the set default ringtone at the time of playing.
1449 *
1450 * @see #DEFAULT_RINGTONE_URI
1451 */
1452 public static final String RINGTONE = "ringtone";
1453
1454 /**
1455 * A {@link Uri} that will point to the current default ringtone at any
1456 * given time.
1457 * <p>
1458 * If the current default ringtone is in the DRM provider and the caller
1459 * does not have permission, the exception will be a
1460 * FileNotFoundException.
1461 */
1462 public static final Uri DEFAULT_RINGTONE_URI = getUriFor(RINGTONE);
1463
1464 /**
1465 * Persistent store for the system-wide default notification sound.
1466 *
1467 * @see #RINGTONE
1468 * @see #DEFAULT_NOTIFICATION_URI
1469 */
1470 public static final String NOTIFICATION_SOUND = "notification_sound";
1471
1472 /**
1473 * A {@link Uri} that will point to the current default notification
1474 * sound at any given time.
1475 *
1476 * @see #DEFAULT_RINGTONE_URI
1477 */
1478 public static final Uri DEFAULT_NOTIFICATION_URI = getUriFor(NOTIFICATION_SOUND);
1479
1480 /**
Patrick Scott3156bb002009-04-13 09:57:38 -07001481 * Persistent store for the system-wide default alarm alert.
1482 *
1483 * @see #RINGTONE
1484 * @see #DEFAULT_ALARM_ALERT_URI
1485 */
1486 public static final String ALARM_ALERT = "alarm_alert";
1487
1488 /**
1489 * A {@link Uri} that will point to the current default alarm alert at
1490 * any given time.
1491 *
1492 * @see #DEFAULT_ALARM_ALERT_URI
1493 */
1494 public static final Uri DEFAULT_ALARM_ALERT_URI = getUriFor(ALARM_ALERT);
1495
1496 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001497 * Setting to enable Auto Replace (AutoText) in text editors. 1 = On, 0 = Off
1498 */
1499 public static final String TEXT_AUTO_REPLACE = "auto_replace";
1500
1501 /**
1502 * Setting to enable Auto Caps in text editors. 1 = On, 0 = Off
1503 */
1504 public static final String TEXT_AUTO_CAPS = "auto_caps";
1505
1506 /**
1507 * Setting to enable Auto Punctuate in text editors. 1 = On, 0 = Off. This
1508 * feature converts two spaces to a "." and space.
1509 */
1510 public static final String TEXT_AUTO_PUNCTUATE = "auto_punctuate";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001511
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001512 /**
1513 * Setting to showing password characters in text editors. 1 = On, 0 = Off
1514 */
1515 public static final String TEXT_SHOW_PASSWORD = "show_password";
1516
1517 public static final String SHOW_GTALK_SERVICE_STATUS =
1518 "SHOW_GTALK_SERVICE_STATUS";
1519
1520 /**
1521 * Name of activity to use for wallpaper on the home screen.
1522 */
1523 public static final String WALLPAPER_ACTIVITY = "wallpaper_activity";
1524
1525 /**
1526 * Value to specify if the user prefers the date, time and time zone
1527 * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1528 */
1529 public static final String AUTO_TIME = "auto_time";
1530
1531 /**
Amith Yamasaniad450be2010-09-16 16:47:00 -07001532 * Value to specify if the user prefers the time zone
1533 * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1534 */
1535 public static final String AUTO_TIME_ZONE = "auto_time_zone";
1536
1537 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001538 * Display times as 12 or 24 hours
1539 * 12
1540 * 24
1541 */
1542 public static final String TIME_12_24 = "time_12_24";
1543
1544 /**
1545 * Date format string
1546 * mm/dd/yyyy
1547 * dd/mm/yyyy
1548 * yyyy/mm/dd
1549 */
1550 public static final String DATE_FORMAT = "date_format";
1551
1552 /**
1553 * Whether the setup wizard has been run before (on first boot), or if
1554 * it still needs to be run.
1555 *
1556 * nonzero = it has been run in the past
1557 * 0 = it has not been run in the past
1558 */
1559 public static final String SETUP_WIZARD_HAS_RUN = "setup_wizard_has_run";
1560
1561 /**
1562 * Scaling factor for normal window animations. Setting to 0 will disable window
1563 * animations.
1564 */
1565 public static final String WINDOW_ANIMATION_SCALE = "window_animation_scale";
1566
1567 /**
1568 * Scaling factor for activity transition animations. Setting to 0 will disable window
1569 * animations.
1570 */
1571 public static final String TRANSITION_ANIMATION_SCALE = "transition_animation_scale";
1572
1573 /**
1574 * Scaling factor for normal window animations. Setting to 0 will disable window
1575 * animations.
1576 * @hide
1577 */
1578 public static final String FANCY_IME_ANIMATIONS = "fancy_ime_animations";
1579
1580 /**
1581 * Control whether the accelerometer will be used to change screen
1582 * orientation. If 0, it will not be used unless explicitly requested
1583 * by the application; if 1, it will be used by default unless explicitly
1584 * disabled by the application.
1585 */
1586 public static final String ACCELEROMETER_ROTATION = "accelerometer_rotation";
1587
1588 /**
Daniel Sandlerb73617d2010-08-17 00:41:00 -04001589 * Default screen rotation when no other policy applies.
1590 * When {@link #ACCELEROMETER_ROTATION} is zero and no on-screen Activity expresses a
1591 * preference, this rotation value will be used. Must be one of the
Brian Muramatsue1d46982010-12-06 17:34:20 -08001592 * {@link android.view.Surface#ROTATION_0 Surface rotation constants}.
Daniel Sandlerb73617d2010-08-17 00:41:00 -04001593 *
1594 * @see Display#getRotation
1595 */
1596 public static final String USER_ROTATION = "user_rotation";
1597
1598 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001599 * Whether the audible DTMF tones are played by the dialer when dialing. The value is
1600 * boolean (1 or 0).
1601 */
1602 public static final String DTMF_TONE_WHEN_DIALING = "dtmf_tone";
1603
1604 /**
David Kraused0f67152009-06-13 18:01:13 -05001605 * CDMA only settings
1606 * DTMF tone type played by the dialer when dialing.
1607 * 0 = Normal
1608 * 1 = Long
1609 * @hide
1610 */
1611 public static final String DTMF_TONE_TYPE_WHEN_DIALING = "dtmf_tone_type";
1612
1613 /**
1614 * CDMA only settings
1615 * Emergency Tone 0 = Off
1616 * 1 = Alert
1617 * 2 = Vibrate
1618 * @hide
1619 */
1620 public static final String EMERGENCY_TONE = "emergency_tone";
1621
1622 /**
1623 * CDMA only settings
1624 * Whether the auto retry is enabled. The value is
1625 * boolean (1 or 0).
1626 * @hide
1627 */
1628 public static final String CALL_AUTO_RETRY = "call_auto_retry";
1629
1630 /**
1631 * Whether the hearing aid is enabled. The value is
1632 * boolean (1 or 0).
1633 * @hide
1634 */
1635 public static final String HEARING_AID = "hearing_aid";
1636
1637 /**
1638 * CDMA only settings
1639 * TTY Mode
1640 * 0 = OFF
1641 * 1 = FULL
1642 * 2 = VCO
1643 * 3 = HCO
1644 * @hide
1645 */
1646 public static final String TTY_MODE = "tty_mode";
1647
1648 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001649 * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1650 * boolean (1 or 0).
1651 */
1652 public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001653
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001654 /**
1655 * Whether the haptic feedback (long presses, ...) are enabled. The value is
1656 * boolean (1 or 0).
1657 */
1658 public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
Sanjay Jeyakumar21bf2412009-07-09 13:31:48 -07001659
Mike LeBeau48603e72009-06-05 00:27:00 +01001660 /**
Bjorn Bringert24abb662010-09-21 12:21:18 +01001661 * @deprecated Each application that shows web suggestions should have its own
1662 * setting for this.
Mike LeBeau48603e72009-06-05 00:27:00 +01001663 */
Bjorn Bringert24abb662010-09-21 12:21:18 +01001664 @Deprecated
Mike LeBeau48603e72009-06-05 00:27:00 +01001665 public static final String SHOW_WEB_SUGGESTIONS = "show_web_suggestions";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001666
-b master501eec92009-07-06 13:53:11 -07001667 /**
Amith Yamasaniae3ed702009-12-01 19:02:05 -08001668 * Whether the notification LED should repeatedly flash when a notification is
1669 * pending. The value is boolean (1 or 0).
1670 * @hide
1671 */
1672 public static final String NOTIFICATION_LIGHT_PULSE = "notification_light_pulse";
1673
1674 /**
Dianne Hackborn90d2db32010-02-11 22:19:06 -08001675 * Show pointer location on screen?
1676 * 0 = no
1677 * 1 = yes
1678 * @hide
1679 */
1680 public static final String POINTER_LOCATION = "pointer_location";
1681
1682 /**
Jeff Brown4519f072011-01-23 13:16:01 -08001683 * Log raw orientation data from {@link WindowOrientationListener} for use with the
1684 * orientationplot.py tool.
1685 * 0 = no
1686 * 1 = yes
1687 * @hide
1688 */
1689 public static final String WINDOW_ORIENTATION_LISTENER_LOG =
1690 "window_orientation_listener_log";
1691
1692 /**
Daniel Sandler0e9d2af2010-01-25 11:33:03 -05001693 * Whether to play a sound for low-battery alerts.
1694 * @hide
1695 */
1696 public static final String POWER_SOUNDS_ENABLED = "power_sounds_enabled";
1697
1698 /**
1699 * Whether to play a sound for dock events.
1700 * @hide
1701 */
1702 public static final String DOCK_SOUNDS_ENABLED = "dock_sounds_enabled";
1703
1704 /**
1705 * Whether to play sounds when the keyguard is shown and dismissed.
1706 * @hide
1707 */
1708 public static final String LOCKSCREEN_SOUNDS_ENABLED = "lockscreen_sounds_enabled";
1709
1710 /**
1711 * URI for the low battery sound file.
1712 * @hide
1713 */
1714 public static final String LOW_BATTERY_SOUND = "low_battery_sound";
1715
1716 /**
1717 * URI for the desk dock "in" event sound.
1718 * @hide
1719 */
1720 public static final String DESK_DOCK_SOUND = "desk_dock_sound";
1721
1722 /**
1723 * URI for the desk dock "out" event sound.
1724 * @hide
1725 */
1726 public static final String DESK_UNDOCK_SOUND = "desk_undock_sound";
1727
1728 /**
1729 * URI for the car dock "in" event sound.
1730 * @hide
1731 */
1732 public static final String CAR_DOCK_SOUND = "car_dock_sound";
1733
1734 /**
1735 * URI for the car dock "out" event sound.
1736 * @hide
1737 */
1738 public static final String CAR_UNDOCK_SOUND = "car_undock_sound";
1739
1740 /**
1741 * URI for the "device locked" (keyguard shown) sound.
1742 * @hide
1743 */
1744 public static final String LOCK_SOUND = "lock_sound";
1745
1746 /**
1747 * URI for the "device unlocked" (keyguard dismissed) sound.
1748 * @hide
1749 */
1750 public static final String UNLOCK_SOUND = "unlock_sound";
1751
1752 /**
Mike Lockwoodeabe8bf2010-08-31 14:35:23 -04001753 * True if we should appear as a PTP device instead of MTP.
1754 * @hide
1755 */
1756 public static final String USE_PTP_INTERFACE = "use_ptp_interface";
1757
1758 /**
Chung-yih Wang042e9bd2010-08-31 17:43:39 +08001759 * Receive incoming SIP calls?
1760 * 0 = no
1761 * 1 = yes
1762 * @hide
1763 */
1764 public static final String SIP_RECEIVE_CALLS = "sip_receive_calls";
1765
1766 /**
1767 * Call Preference String.
1768 * "SIP_ALWAYS" : Always use SIP with network access
1769 * "SIP_ADDRESS_ONLY" : Only if destination is a SIP address
1770 * "SIP_ASK_ME_EACH_TIME" : Always ask me each time
1771 * @hide
1772 */
1773 public static final String SIP_CALL_OPTIONS = "sip_call_options";
1774
1775 /**
1776 * One of the sip call options: Always use SIP with network access.
1777 * @hide
1778 */
1779 public static final String SIP_ALWAYS = "SIP_ALWAYS";
1780
1781 /**
1782 * One of the sip call options: Only if destination is a SIP address.
1783 * @hide
1784 */
1785 public static final String SIP_ADDRESS_ONLY = "SIP_ADDRESS_ONLY";
1786
1787 /**
1788 * One of the sip call options: Always ask me each time.
1789 * @hide
1790 */
1791 public static final String SIP_ASK_ME_EACH_TIME = "SIP_ASK_ME_EACH_TIME";
1792
1793 /**
Jeff Brown1a84fd12011-06-02 01:26:32 -07001794 * Pointer speed setting.
1795 * This is an integer value in a range between -7 and +7, so there are 15 possible values.
1796 * -7 = slowest
1797 * 0 = default speed
1798 * +7 = fastest
1799 * @hide
1800 */
1801 public static final String POINTER_SPEED = "pointer_speed";
1802
1803 /**
-b master501eec92009-07-06 13:53:11 -07001804 * Settings to backup. This is here so that it's in the same place as the settings
1805 * keys and easy to update.
1806 * @hide
1807 */
1808 public static final String[] SETTINGS_TO_BACKUP = {
1809 STAY_ON_WHILE_PLUGGED_IN,
-b master501eec92009-07-06 13:53:11 -07001810 WIFI_USE_STATIC_IP,
1811 WIFI_STATIC_IP,
1812 WIFI_STATIC_GATEWAY,
1813 WIFI_STATIC_NETMASK,
1814 WIFI_STATIC_DNS1,
1815 WIFI_STATIC_DNS2,
1816 BLUETOOTH_DISCOVERABILITY,
1817 BLUETOOTH_DISCOVERABILITY_TIMEOUT,
1818 DIM_SCREEN,
1819 SCREEN_OFF_TIMEOUT,
1820 SCREEN_BRIGHTNESS,
Christopher Tate362aca62009-09-25 15:58:03 -07001821 SCREEN_BRIGHTNESS_MODE,
-b master501eec92009-07-06 13:53:11 -07001822 VIBRATE_ON,
Amith Yamasani8823c0a82009-07-07 14:30:17 -07001823 MODE_RINGER,
1824 MODE_RINGER_STREAMS_AFFECTED,
1825 MUTE_STREAMS_AFFECTED,
1826 VOLUME_VOICE,
1827 VOLUME_SYSTEM,
1828 VOLUME_RING,
1829 VOLUME_MUSIC,
1830 VOLUME_ALARM,
1831 VOLUME_NOTIFICATION,
Eric Laurent484d2882009-12-08 09:05:45 -08001832 VOLUME_BLUETOOTH_SCO,
Amith Yamasani8823c0a82009-07-07 14:30:17 -07001833 VOLUME_VOICE + APPEND_FOR_LAST_AUDIBLE,
1834 VOLUME_SYSTEM + APPEND_FOR_LAST_AUDIBLE,
1835 VOLUME_RING + APPEND_FOR_LAST_AUDIBLE,
1836 VOLUME_MUSIC + APPEND_FOR_LAST_AUDIBLE,
1837 VOLUME_ALARM + APPEND_FOR_LAST_AUDIBLE,
1838 VOLUME_NOTIFICATION + APPEND_FOR_LAST_AUDIBLE,
Eric Laurent484d2882009-12-08 09:05:45 -08001839 VOLUME_BLUETOOTH_SCO + APPEND_FOR_LAST_AUDIBLE,
Daniel Sandler1c7fa482010-03-10 09:45:01 -05001840 VIBRATE_IN_SILENT,
-b master501eec92009-07-06 13:53:11 -07001841 TEXT_AUTO_REPLACE,
1842 TEXT_AUTO_CAPS,
1843 TEXT_AUTO_PUNCTUATE,
1844 TEXT_SHOW_PASSWORD,
1845 AUTO_TIME,
Amith Yamasaniad450be2010-09-16 16:47:00 -07001846 AUTO_TIME_ZONE,
-b master501eec92009-07-06 13:53:11 -07001847 TIME_12_24,
1848 DATE_FORMAT,
1849 ACCELEROMETER_ROTATION,
Daniel Sandlerb73617d2010-08-17 00:41:00 -04001850 USER_ROTATION,
-b master501eec92009-07-06 13:53:11 -07001851 DTMF_TONE_WHEN_DIALING,
1852 DTMF_TONE_TYPE_WHEN_DIALING,
1853 EMERGENCY_TONE,
1854 CALL_AUTO_RETRY,
1855 HEARING_AID,
1856 TTY_MODE,
1857 SOUND_EFFECTS_ENABLED,
1858 HAPTIC_FEEDBACK_ENABLED,
Christopher Tate14c2d792010-02-25 16:49:44 -08001859 POWER_SOUNDS_ENABLED,
1860 DOCK_SOUNDS_ENABLED,
1861 LOCKSCREEN_SOUNDS_ENABLED,
Amith Yamasaniae3ed702009-12-01 19:02:05 -08001862 SHOW_WEB_SUGGESTIONS,
Mike Lockwoodeabe8bf2010-08-31 14:35:23 -04001863 NOTIFICATION_LIGHT_PULSE,
1864 USE_PTP_INTERFACE,
Chung-yih Wang042e9bd2010-08-31 17:43:39 +08001865 SIP_CALL_OPTIONS,
Nick Pelly038cabe2010-09-23 16:12:11 -07001866 SIP_RECEIVE_CALLS,
Jeff Brown1a84fd12011-06-02 01:26:32 -07001867 POINTER_SPEED,
-b master501eec92009-07-06 13:53:11 -07001868 };
1869
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001870 // Settings moved to Settings.Secure
1871
1872 /**
Mike Lockwood460ae0c2009-04-02 22:33:27 -07001873 * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001874 * instead
1875 */
1876 @Deprecated
1877 public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1878
1879 /**
1880 * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1881 */
1882 @Deprecated
1883 public static final String ANDROID_ID = Secure.ANDROID_ID;
1884
1885 /**
1886 * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1887 */
1888 @Deprecated
1889 public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1890
1891 /**
1892 * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1893 */
1894 @Deprecated
1895 public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1896
1897 /**
1898 * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1899 */
1900 @Deprecated
1901 public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1902
1903 /**
1904 * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1905 */
1906 @Deprecated
1907 public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1908
1909 /**
1910 * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1911 */
1912 @Deprecated
1913 public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001914
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001915 /**
1916 * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1917 * instead
1918 */
1919 @Deprecated
1920 public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1921
1922 /**
1923 * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1924 */
1925 @Deprecated
1926 public static final String LOGGING_ID = Secure.LOGGING_ID;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001927
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001928 /**
1929 * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1930 */
1931 @Deprecated
1932 public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1933
1934 /**
1935 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1936 * instead
1937 */
1938 @Deprecated
1939 public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1940
1941 /**
1942 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1943 * instead
1944 */
1945 @Deprecated
1946 public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1947
1948 /**
1949 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1950 * instead
1951 */
1952 @Deprecated
1953 public static final String PARENTAL_CONTROL_REDIRECT_URL =
1954 Secure.PARENTAL_CONTROL_REDIRECT_URL;
1955
1956 /**
1957 * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1958 */
1959 @Deprecated
1960 public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1961
1962 /**
1963 * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1964 */
1965 @Deprecated
1966 public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001967
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001968 /**
1969 * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1970 */
1971 @Deprecated
1972 public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1973
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001974 /**
1975 * @deprecated Use
1976 * {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT} instead
1977 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001978 @Deprecated
1979 public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1980
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001981 /**
1982 * @deprecated Use
1983 * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS} instead
1984 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001985 @Deprecated
1986 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1987 Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1988
1989 /**
1990 * @deprecated Use
1991 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1992 */
1993 @Deprecated
1994 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1995 Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
1996
1997 /**
1998 * @deprecated Use
1999 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
2000 */
2001 @Deprecated
2002 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
2003 Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002004
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002005 /**
2006 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
2007 * instead
2008 */
2009 @Deprecated
2010 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
2011
2012 /**
2013 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
2014 */
2015 @Deprecated
2016 public static final String WIFI_ON = Secure.WIFI_ON;
2017
2018 /**
2019 * @deprecated Use
2020 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
2021 * instead
2022 */
2023 @Deprecated
2024 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
2025 Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
2026
2027 /**
2028 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
2029 */
2030 @Deprecated
2031 public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
2032
2033 /**
2034 * @deprecated Use
2035 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
2036 */
2037 @Deprecated
2038 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
2039 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002040
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002041 /**
2042 * @deprecated Use
2043 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
2044 */
2045 @Deprecated
2046 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
2047 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
2048
2049 /**
2050 * @deprecated Use
2051 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
2052 * instead
2053 */
2054 @Deprecated
2055 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
2056 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
2057
2058 /**
2059 * @deprecated Use
2060 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
2061 */
2062 @Deprecated
2063 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2064 Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
2065
2066 /**
2067 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
2068 * instead
2069 */
2070 @Deprecated
2071 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
2072
2073 /**
2074 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
2075 */
2076 @Deprecated
2077 public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
2078
2079 /**
2080 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
2081 */
2082 @Deprecated
2083 public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
2084
2085 /**
2086 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
2087 * instead
2088 */
2089 @Deprecated
2090 public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
2091
2092 /**
2093 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
2094 * instead
2095 */
2096 @Deprecated
2097 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
2098 Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
2099 }
2100
2101 /**
2102 * Secure system settings, containing system preferences that applications
2103 * can read but are not allowed to write. These are for preferences that
2104 * the user must explicitly modify through the system UI or specialized
2105 * APIs for those values, not modified directly by applications.
2106 */
2107 public static final class Secure extends NameValueTable {
2108 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
2109
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08002110 // Populated lazily, guarded by class object:
2111 private static NameValueCache sNameValueCache = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002112
2113 /**
2114 * Look up a name in the database.
2115 * @param resolver to access the database with
2116 * @param name to look up in the table
2117 * @return the corresponding value, or null if not present
2118 */
2119 public synchronized static String getString(ContentResolver resolver, String name) {
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08002120 if (sNameValueCache == null) {
2121 sNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI,
2122 CALL_METHOD_GET_SECURE);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002123 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08002124 return sNameValueCache.getString(resolver, name);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002125 }
2126
2127 /**
2128 * Store a name/value pair into the database.
2129 * @param resolver to access the database with
2130 * @param name to store
2131 * @param value to associate with the name
2132 * @return true if the value was set, false on database errors
2133 */
2134 public static boolean putString(ContentResolver resolver,
2135 String name, String value) {
2136 return putString(resolver, CONTENT_URI, name, value);
2137 }
2138
2139 /**
2140 * Construct the content URI for a particular name/value pair,
2141 * useful for monitoring changes with a ContentObserver.
2142 * @param name to look up in the table
2143 * @return the corresponding content URI, or null if not present
2144 */
2145 public static Uri getUriFor(String name) {
2146 return getUriFor(CONTENT_URI, name);
2147 }
2148
2149 /**
2150 * Convenience function for retrieving a single secure settings value
2151 * as an integer. Note that internally setting values are always
2152 * stored as strings; this function converts the string to an integer
2153 * for you. The default value will be returned if the setting is
2154 * not defined or not an integer.
2155 *
2156 * @param cr The ContentResolver to access.
2157 * @param name The name of the setting to retrieve.
2158 * @param def Value to return if the setting is not defined.
2159 *
2160 * @return The setting's current value, or 'def' if it is not defined
2161 * or not a valid integer.
2162 */
2163 public static int getInt(ContentResolver cr, String name, int def) {
2164 String v = getString(cr, name);
2165 try {
2166 return v != null ? Integer.parseInt(v) : def;
2167 } catch (NumberFormatException e) {
2168 return def;
2169 }
2170 }
2171
2172 /**
2173 * Convenience function for retrieving a single secure settings value
2174 * as an integer. Note that internally setting values are always
2175 * stored as strings; this function converts the string to an integer
2176 * for you.
2177 * <p>
2178 * This version does not take a default value. If the setting has not
2179 * been set, or the string value is not a number,
2180 * it throws {@link SettingNotFoundException}.
2181 *
2182 * @param cr The ContentResolver to access.
2183 * @param name The name of the setting to retrieve.
2184 *
2185 * @throws SettingNotFoundException Thrown if a setting by the given
2186 * name can't be found or the setting value is not an integer.
2187 *
2188 * @return The setting's current value.
2189 */
2190 public static int getInt(ContentResolver cr, String name)
2191 throws SettingNotFoundException {
2192 String v = getString(cr, name);
2193 try {
2194 return Integer.parseInt(v);
2195 } catch (NumberFormatException e) {
2196 throw new SettingNotFoundException(name);
2197 }
2198 }
2199
2200 /**
2201 * Convenience function for updating a single settings value as an
2202 * integer. This will either create a new entry in the table if the
2203 * given name does not exist, or modify the value of the existing row
2204 * with that name. Note that internally setting values are always
2205 * stored as strings, so this function converts the given value to a
2206 * string before storing it.
2207 *
2208 * @param cr The ContentResolver to access.
2209 * @param name The name of the setting to modify.
2210 * @param value The new value for the setting.
2211 * @return true if the value was set, false on database errors
2212 */
2213 public static boolean putInt(ContentResolver cr, String name, int value) {
2214 return putString(cr, name, Integer.toString(value));
2215 }
2216
2217 /**
2218 * Convenience function for retrieving a single secure settings value
2219 * as a {@code long}. Note that internally setting values are always
2220 * stored as strings; this function converts the string to a {@code long}
2221 * for you. The default value will be returned if the setting is
2222 * not defined or not a {@code long}.
2223 *
2224 * @param cr The ContentResolver to access.
2225 * @param name The name of the setting to retrieve.
2226 * @param def Value to return if the setting is not defined.
2227 *
2228 * @return The setting's current value, or 'def' if it is not defined
2229 * or not a valid {@code long}.
2230 */
2231 public static long getLong(ContentResolver cr, String name, long def) {
2232 String valString = getString(cr, name);
2233 long value;
2234 try {
2235 value = valString != null ? Long.parseLong(valString) : def;
2236 } catch (NumberFormatException e) {
2237 value = def;
2238 }
2239 return value;
2240 }
2241
2242 /**
2243 * Convenience function for retrieving a single secure settings value
2244 * as a {@code long}. Note that internally setting values are always
2245 * stored as strings; this function converts the string to a {@code long}
2246 * for you.
2247 * <p>
2248 * This version does not take a default value. If the setting has not
2249 * been set, or the string value is not a number,
2250 * it throws {@link SettingNotFoundException}.
2251 *
2252 * @param cr The ContentResolver to access.
2253 * @param name The name of the setting to retrieve.
2254 *
2255 * @return The setting's current value.
2256 * @throws SettingNotFoundException Thrown if a setting by the given
2257 * name can't be found or the setting value is not an integer.
2258 */
2259 public static long getLong(ContentResolver cr, String name)
2260 throws SettingNotFoundException {
2261 String valString = getString(cr, name);
2262 try {
2263 return Long.parseLong(valString);
2264 } catch (NumberFormatException e) {
2265 throw new SettingNotFoundException(name);
2266 }
2267 }
2268
2269 /**
2270 * Convenience function for updating a secure settings value as a long
2271 * integer. This will either create a new entry in the table if the
2272 * given name does not exist, or modify the value of the existing row
2273 * with that name. Note that internally setting values are always
2274 * stored as strings, so this function converts the given value to a
2275 * string before storing it.
2276 *
2277 * @param cr The ContentResolver to access.
2278 * @param name The name of the setting to modify.
2279 * @param value The new value for the setting.
2280 * @return true if the value was set, false on database errors
2281 */
2282 public static boolean putLong(ContentResolver cr, String name, long value) {
2283 return putString(cr, name, Long.toString(value));
2284 }
2285
2286 /**
2287 * Convenience function for retrieving a single secure settings value
2288 * as a floating point number. Note that internally setting values are
2289 * always stored as strings; this function converts the string to an
2290 * float for you. The default value will be returned if the setting
2291 * is not defined or not a valid float.
2292 *
2293 * @param cr The ContentResolver to access.
2294 * @param name The name of the setting to retrieve.
2295 * @param def Value to return if the setting is not defined.
2296 *
2297 * @return The setting's current value, or 'def' if it is not defined
2298 * or not a valid float.
2299 */
2300 public static float getFloat(ContentResolver cr, String name, float def) {
2301 String v = getString(cr, name);
2302 try {
2303 return v != null ? Float.parseFloat(v) : def;
2304 } catch (NumberFormatException e) {
2305 return def;
2306 }
2307 }
2308
2309 /**
2310 * Convenience function for retrieving a single secure settings value
2311 * as a float. Note that internally setting values are always
2312 * stored as strings; this function converts the string to a float
2313 * for you.
2314 * <p>
2315 * This version does not take a default value. If the setting has not
2316 * been set, or the string value is not a number,
2317 * it throws {@link SettingNotFoundException}.
2318 *
2319 * @param cr The ContentResolver to access.
2320 * @param name The name of the setting to retrieve.
2321 *
2322 * @throws SettingNotFoundException Thrown if a setting by the given
2323 * name can't be found or the setting value is not a float.
2324 *
2325 * @return The setting's current value.
2326 */
2327 public static float getFloat(ContentResolver cr, String name)
2328 throws SettingNotFoundException {
2329 String v = getString(cr, name);
Brian Muramatsue1d46982010-12-06 17:34:20 -08002330 if (v == null) {
2331 throw new SettingNotFoundException(name);
2332 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002333 try {
2334 return Float.parseFloat(v);
2335 } catch (NumberFormatException e) {
2336 throw new SettingNotFoundException(name);
2337 }
2338 }
2339
2340 /**
2341 * Convenience function for updating a single settings value as a
2342 * floating point number. This will either create a new entry in the
2343 * table if the given name does not exist, or modify the value of the
2344 * existing row with that name. Note that internally setting values
2345 * are always stored as strings, so this function converts the given
2346 * value to a string before storing it.
2347 *
2348 * @param cr The ContentResolver to access.
2349 * @param name The name of the setting to modify.
2350 * @param value The new value for the setting.
2351 * @return true if the value was set, false on database errors
2352 */
2353 public static boolean putFloat(ContentResolver cr, String name, float value) {
2354 return putString(cr, name, Float.toString(value));
2355 }
2356
2357 /**
2358 * The content:// style URL for this table
2359 */
2360 public static final Uri CONTENT_URI =
2361 Uri.parse("content://" + AUTHORITY + "/secure");
2362
2363 /**
2364 * Whether ADB is enabled.
2365 */
2366 public static final String ADB_ENABLED = "adb_enabled";
2367
2368 /**
2369 * Setting to allow mock locations and location provider status to be injected into the
2370 * LocationManager service for testing purposes during application development. These
2371 * locations and status values override actual location and status information generated
2372 * by network, gps, or other location providers.
2373 */
2374 public static final String ALLOW_MOCK_LOCATION = "mock_location";
2375
2376 /**
Doug Zongkerd8893db2010-01-26 12:29:44 -08002377 * A 64-bit number (as a hex string) that is randomly
2378 * generated on the device's first boot and should remain
2379 * constant for the lifetime of the device. (The value may
2380 * change if a factory reset is performed on the device.)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002381 */
2382 public static final String ANDROID_ID = "android_id";
2383
2384 /**
2385 * Whether bluetooth is enabled/disabled
2386 * 0=disabled. 1=enabled.
2387 */
2388 public static final String BLUETOOTH_ON = "bluetooth_on";
2389
2390 /**
2391 * Get the key that retrieves a bluetooth headset's priority.
2392 * @hide
2393 */
2394 public static final String getBluetoothHeadsetPriorityKey(String address) {
2395 return ("bluetooth_headset_priority_" + address.toUpperCase());
2396 }
2397
2398 /**
2399 * Get the key that retrieves a bluetooth a2dp sink's priority.
2400 * @hide
2401 */
2402 public static final String getBluetoothA2dpSinkPriorityKey(String address) {
2403 return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
2404 }
2405
2406 /**
Jaikumar Ganesh545e6702010-06-04 10:23:03 -07002407 * Get the key that retrieves a bluetooth Input Device's priority.
2408 * @hide
2409 */
2410 public static final String getBluetoothInputDevicePriorityKey(String address) {
2411 return ("bluetooth_input_device_priority_" + address.toUpperCase());
2412 }
2413
2414 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002415 * Whether or not data roaming is enabled. (0 = false, 1 = true)
2416 */
2417 public static final String DATA_ROAMING = "data_roaming";
2418
2419 /**
2420 * Setting to record the input method used by default, holding the ID
2421 * of the desired method.
2422 */
2423 public static final String DEFAULT_INPUT_METHOD = "default_input_method";
2424
2425 /**
satokab751aa2010-09-14 19:17:36 +09002426 * Setting to record the input method subtype used by default, holding the ID
2427 * of the desired method.
2428 */
2429 public static final String SELECTED_INPUT_METHOD_SUBTYPE =
2430 "selected_input_method_subtype";
2431
2432 /**
satok723a27e2010-11-11 14:58:11 +09002433 * Setting to record the history of input method subtype, holding the pair of ID of IME
2434 * and its last used subtype.
2435 * @hide
2436 */
2437 public static final String INPUT_METHODS_SUBTYPE_HISTORY =
2438 "input_methods_subtype_history";
2439
2440 /**
satok5c58dfc2010-12-14 21:54:47 +09002441 * Setting to record the visibility of input method selector
2442 */
2443 public static final String INPUT_METHOD_SELECTOR_VISIBILITY =
2444 "input_method_selector_visibility";
2445
2446 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002447 * Whether the device has been provisioned (0 = false, 1 = true)
2448 */
2449 public static final String DEVICE_PROVISIONED = "device_provisioned";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002450
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002451 /**
2452 * List of input methods that are currently enabled. This is a string
2453 * containing the IDs of all enabled input methods, each ID separated
2454 * by ':'.
2455 */
2456 public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002457
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002458 /**
Amith Yamasanie861ec12010-03-24 21:39:27 -07002459 * List of system input methods that are currently disabled. This is a string
2460 * containing the IDs of all disabled input methods, each ID separated
2461 * by ':'.
2462 * @hide
2463 */
2464 public static final String DISABLED_SYSTEM_INPUT_METHODS = "disabled_system_input_methods";
2465
2466 /**
Robert Greenwalt434203a2010-10-11 16:00:27 -07002467 * Host name and port for global http proxy. Uses ':' seperator for between host and port
2468 * TODO - deprecate in favor of global_http_proxy_host, etc
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002469 */
2470 public static final String HTTP_PROXY = "http_proxy";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002471
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002472 /**
Robert Greenwalt434203a2010-10-11 16:00:27 -07002473 * Host name for global http proxy. Set via ConnectivityManager.
2474 * @hide
2475 */
2476 public static final String GLOBAL_HTTP_PROXY_HOST = "global_http_proxy_host";
2477
2478 /**
2479 * Integer host port for global http proxy. Set via ConnectivityManager.
2480 * @hide
2481 */
2482 public static final String GLOBAL_HTTP_PROXY_PORT = "global_http_proxy_port";
2483
2484 /**
Oscar Montemayor16fb7912010-08-02 09:38:48 -07002485 * Exclusion list for global proxy. This string contains a list of comma-separated
2486 * domains where the global proxy does not apply. Domains should be listed in a comma-
2487 * separated list. Example of acceptable formats: ".domain1.com,my.domain2.com"
Robert Greenwalt434203a2010-10-11 16:00:27 -07002488 * Use ConnectivityManager to set/get.
Oscar Montemayor16fb7912010-08-02 09:38:48 -07002489 * @hide
2490 */
Robert Greenwalt434203a2010-10-11 16:00:27 -07002491 public static final String GLOBAL_HTTP_PROXY_EXCLUSION_LIST =
2492 "global_http_proxy_exclusion_list";
Oscar Montemayor16fb7912010-08-02 09:38:48 -07002493
2494 /**
2495 * Enables the UI setting to allow the user to specify the global HTTP proxy
2496 * and associated exclusion list.
2497 * @hide
2498 */
2499 public static final String SET_GLOBAL_HTTP_PROXY = "set_global_http_proxy";
2500
2501 /**
Robert Greenwalte90aa5e2010-09-01 11:34:05 -07002502 * Setting for default DNS in case nobody suggests one
2503 * @hide
2504 */
2505 public static final String DEFAULT_DNS_SERVER = "default_dns_server";
2506
2507 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002508 * Whether the package installer should allow installation of apps downloaded from
2509 * sources other than the Android Market (vending machine).
2510 *
2511 * 1 = allow installing from other sources
2512 * 0 = only allow installing from the Android Market
2513 */
2514 public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002515
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002516 /**
2517 * Comma-separated list of location providers that activities may access.
2518 */
2519 public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002520
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002521 /**
Amith Yamasani156c4352010-03-05 17:10:03 -08002522 * Whether autolock is enabled (0 = false, 1 = true)
2523 */
2524 public static final String LOCK_PATTERN_ENABLED = "lock_pattern_autolock";
2525
2526 /**
2527 * Whether lock pattern is visible as user enters (0 = false, 1 = true)
2528 */
2529 public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
2530
2531 /**
2532 * Whether lock pattern will vibrate as user enters (0 = false, 1 = true)
2533 */
2534 public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
2535 "lock_pattern_tactile_feedback_enabled";
2536
2537 /**
Jim Millerbc4603b2010-08-30 21:21:34 -07002538 * This preference allows the device to be locked given time after screen goes off,
2539 * subject to current DeviceAdmin policy limits.
2540 * @hide
2541 */
2542 public static final String LOCK_SCREEN_LOCK_AFTER_TIMEOUT = "lock_screen_lock_after_timeout";
2543
2544
2545 /**
Jim Miller253a5ef2010-10-13 20:57:29 -07002546 * This preference contains the string that shows for owner info on LockScren.
2547 * @hide
2548 */
2549 public static final String LOCK_SCREEN_OWNER_INFO = "lock_screen_owner_info";
2550
2551 /**
2552 * This preference enables showing the owner info on LockScren.
2553 * @hide
2554 */
2555 public static final String LOCK_SCREEN_OWNER_INFO_ENABLED =
2556 "lock_screen_owner_info_enabled";
2557
2558 /**
Joe Onorato571ae902011-05-24 13:48:43 -07002559 * The saved value for WindowManagerService.setForcedDisplaySize().
2560 * Two integers separated by a comma. If unset, then use the real display size.
2561 * @hide
2562 */
2563 public static final String DISPLAY_SIZE_FORCED = "display_size_forced";
2564
2565 /**
Mike Lockwoodbcab8df2009-06-25 16:39:09 -04002566 * Whether assisted GPS should be enabled or not.
2567 * @hide
2568 */
2569 public static final String ASSISTED_GPS_ENABLED = "assisted_gps_enabled";
2570
2571 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002572 * The Logging ID (a unique 64-bit value) as a hex string.
2573 * Used as a pseudonymous identifier for logging.
2574 * @deprecated This identifier is poorly initialized and has
2575 * many collisions. It should not be used.
2576 */
2577 @Deprecated
2578 public static final String LOGGING_ID = "logging_id";
2579
2580 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002581 * User preference for which network(s) should be used. Only the
2582 * connectivity service should touch this.
2583 */
2584 public static final String NETWORK_PREFERENCE = "network_preference";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002585
2586 /**
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002587 * Used to disable Tethering on a device - defaults to true
2588 * @hide
2589 */
2590 public static final String TETHER_SUPPORTED = "tether_supported";
2591
2592 /**
Robert Greenwalt77b32dd2010-06-03 18:57:26 -07002593 * Used to require DUN APN on the device or not - defaults to a build config value
2594 * which defaults to false
2595 * @hide
2596 */
2597 public static final String TETHER_DUN_REQUIRED = "tether_dun_required";
2598
2599 /**
2600 * Used to hold a gservices-provisioned apn value for DUN. If set, or the
2601 * corresponding build config values are set it will override the APN DB
2602 * values.
2603 * Consists of a comma seperated list of strings:
2604 * "name,apn,proxy,port,username,password,server,mmsc,mmsproxy,mmsport,mcc,mnc,auth,type"
2605 * note that empty fields can be ommitted: "name,apn,,,,,,,,,310,260,,DUN"
2606 * @hide
2607 */
2608 public static final String TETHER_DUN_APN = "tether_dun_apn";
2609
2610 /**
Dan Egnor1c9131c2010-02-13 10:38:55 -08002611 * No longer supported.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002612 */
2613 public static final String PARENTAL_CONTROL_ENABLED = "parental_control_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002614
2615 /**
Dan Egnor1c9131c2010-02-13 10:38:55 -08002616 * No longer supported.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002617 */
2618 public static final String PARENTAL_CONTROL_LAST_UPDATE = "parental_control_last_update";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002619
2620 /**
Dan Egnor1c9131c2010-02-13 10:38:55 -08002621 * No longer supported.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002622 */
2623 public static final String PARENTAL_CONTROL_REDIRECT_URL = "parental_control_redirect_url";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002624
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002625 /**
Brad Fitzpatrickd7ad0d22010-12-02 15:30:23 -08002626 * A positive value indicates how often the SamplingProfiler
2627 * should take snapshots. Zero value means SamplingProfiler
2628 * is disabled.
Sen Hubde75702010-05-28 01:54:03 -07002629 *
2630 * @hide
2631 */
Brad Fitzpatrickd7ad0d22010-12-02 15:30:23 -08002632 public static final String SAMPLING_PROFILER_MS = "sampling_profiler_ms";
Sen Hubde75702010-05-28 01:54:03 -07002633
2634 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002635 * Settings classname to launch when Settings is clicked from All
2636 * Applications. Needed because of user testing between the old
2637 * and new Settings apps.
2638 */
2639 // TODO: 881807
2640 public static final String SETTINGS_CLASSNAME = "settings_classname";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002641
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002642 /**
2643 * USB Mass Storage Enabled
2644 */
2645 public static final String USB_MASS_STORAGE_ENABLED = "usb_mass_storage_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002646
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002647 /**
2648 * If this setting is set (to anything), then all references
2649 * to Gmail on the device must change to Google Mail.
2650 */
2651 public static final String USE_GOOGLE_MAIL = "use_google_mail";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002652
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002653 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002654 * If accessibility is enabled.
2655 */
2656 public static final String ACCESSIBILITY_ENABLED = "accessibility_enabled";
2657
2658 /**
2659 * List of the enabled accessibility providers.
2660 */
2661 public static final String ENABLED_ACCESSIBILITY_SERVICES =
2662 "enabled_accessibility_services";
2663
2664 /**
Svetoslav Ganov585f13f8d2010-08-10 07:59:15 -07002665 * If injection of accessibility enhancing JavaScript scripts
2666 * is enabled.
2667 * <p>
2668 * Note: Accessibility injecting scripts are served by the
2669 * Google infrastructure and enable users with disabilities to
2670 * efficiantly navigate in and explore web content.
2671 * </p>
2672 * <p>
2673 * This property represents a boolean value.
2674 * </p>
2675 * @hide
2676 */
2677 public static final String ACCESSIBILITY_SCRIPT_INJECTION =
2678 "accessibility_script_injection";
2679
2680 /**
2681 * Key bindings for navigation in built-in accessibility support for web content.
2682 * <p>
2683 * Note: These key bindings are for the built-in accessibility navigation for
2684 * web content which is used as a fall back solution if JavaScript in a WebView
2685 * is not enabled or the user has not opted-in script injection from Google.
2686 * </p>
2687 * <p>
2688 * The bindings are separated by semi-colon. A binding is a mapping from
2689 * a key to a sequence of actions (for more details look at
2690 * android.webkit.AccessibilityInjector). A key is represented as the hexademical
2691 * string representation of an integer obtained from a meta state (optional) shifted
2692 * sixteen times left and bitwise ored with a key code. An action is represented
2693 * as a hexademical string representation of an integer where the first two digits
2694 * are navigation action index, the second, the third, and the fourth digit pairs
2695 * represent the action arguments. The separate actions in a binding are colon
2696 * separated. The key and the action sequence it maps to are separated by equals.
2697 * </p>
2698 * <p>
2699 * For example, the binding below maps the DPAD right button to traverse the
2700 * current navigation axis once without firing an accessibility event and to
2701 * perform the same traversal again but to fire an event:
2702 * <code>
2703 * 0x16=0x01000100:0x01000101;
2704 * </code>
2705 * </p>
2706 * <p>
2707 * The goal of this binding is to enable dynamic rebinding of keys to
2708 * navigation actions for web content without requiring a framework change.
2709 * </p>
2710 * <p>
2711 * This property represents a string value.
2712 * </p>
2713 * @hide
2714 */
2715 public static final String ACCESSIBILITY_WEB_CONTENT_KEY_BINDINGS =
2716 "accessibility_web_content_key_bindings";
2717
2718 /**
Svetoslav Ganov54d068e2011-03-02 12:58:40 -08002719 * The timout for considering a press to be a long press in milliseconds.
2720 * @hide
2721 */
2722 public static final String LONG_PRESS_TIMEOUT = "long_press_timeout";
2723
2724 /**
Jean-Michel Trivif62ba452009-06-04 14:55:24 -07002725 * Setting to always use the default text-to-speech settings regardless
2726 * of the application settings.
2727 * 1 = override application settings,
2728 * 0 = use application settings (if specified).
2729 */
2730 public static final String TTS_USE_DEFAULTS = "tts_use_defaults";
2731
2732 /**
2733 * Default text-to-speech engine speech rate. 100 = 1x
2734 */
2735 public static final String TTS_DEFAULT_RATE = "tts_default_rate";
2736
2737 /**
2738 * Default text-to-speech engine pitch. 100 = 1x
2739 */
2740 public static final String TTS_DEFAULT_PITCH = "tts_default_pitch";
2741
2742 /**
2743 * Default text-to-speech engine.
2744 */
2745 public static final String TTS_DEFAULT_SYNTH = "tts_default_synth";
2746
2747 /**
Jean-Michel Trivif4782672009-06-09 16:22:48 -07002748 * Default text-to-speech language.
2749 */
2750 public static final String TTS_DEFAULT_LANG = "tts_default_lang";
2751
2752 /**
Jean-Michel Trivia6fcc952009-06-19 14:06:01 -07002753 * Default text-to-speech country.
2754 */
2755 public static final String TTS_DEFAULT_COUNTRY = "tts_default_country";
2756
2757 /**
2758 * Default text-to-speech locale variant.
2759 */
2760 public static final String TTS_DEFAULT_VARIANT = "tts_default_variant";
2761
2762 /**
Charles Chenceffa152010-03-16 21:18:10 -07002763 * Space delimited list of plugin packages that are enabled.
2764 */
2765 public static final String TTS_ENABLED_PLUGINS = "tts_enabled_plugins";
2766
2767 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002768 * Whether to notify the user of open networks.
2769 * <p>
2770 * If not connected and the scan results have an open network, we will
2771 * put this notification up. If we attempt to connect to a network or
2772 * the open network(s) disappear, we remove the notification. When we
2773 * show the notification, we will not show it again for
2774 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} time.
2775 */
2776 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
2777 "wifi_networks_available_notification_on";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002778
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002779 /**
2780 * Delay (in seconds) before repeating the Wi-Fi networks available notification.
2781 * Connecting to a network will reset the timer.
2782 */
2783 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
2784 "wifi_networks_available_repeat_delay";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002785
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002786 /**
Irfan Sheriffed4f28b2010-10-29 15:32:10 -07002787 * 802.11 country code in ISO 3166 format
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002788 * @hide
2789 */
Irfan Sheriffed4f28b2010-10-29 15:32:10 -07002790 public static final String WIFI_COUNTRY_CODE = "wifi_country_code";
2791
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002792
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002793 /**
2794 * When the number of open networks exceeds this number, the
2795 * least-recently-used excess networks will be removed.
2796 */
2797 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = "wifi_num_open_networks_kept";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002798
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002799 /**
2800 * Whether the Wi-Fi should be on. Only the Wi-Fi service should touch this.
2801 */
2802 public static final String WIFI_ON = "wifi_on";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002803
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002804 /**
Irfan Sheriffa3bd4092010-03-24 17:58:59 -07002805 * Used to save the Wifi_ON state prior to tethering.
2806 * This state will be checked to restore Wifi after
2807 * the user turns off tethering.
Irfan Sheriff5321aef2010-02-12 12:35:59 -08002808 *
2809 * @hide
2810 */
Irfan Sheriffa3bd4092010-03-24 17:58:59 -07002811 public static final String WIFI_SAVED_STATE = "wifi_saved_state";
Irfan Sheriff5321aef2010-02-12 12:35:59 -08002812
2813 /**
Irfan Sheriff9ab518ad2010-03-12 15:48:17 -08002814 * AP SSID
2815 *
2816 * @hide
2817 */
2818 public static final String WIFI_AP_SSID = "wifi_ap_ssid";
2819
2820 /**
2821 * AP security
2822 *
2823 * @hide
2824 */
2825 public static final String WIFI_AP_SECURITY = "wifi_ap_security";
2826
2827 /**
2828 * AP passphrase
2829 *
2830 * @hide
2831 */
2832 public static final String WIFI_AP_PASSWD = "wifi_ap_passwd";
2833
2834 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002835 * The acceptable packet loss percentage (range 0 - 100) before trying
2836 * another AP on the same network.
2837 */
2838 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
2839 "wifi_watchdog_acceptable_packet_loss_percentage";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002840
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002841 /**
2842 * The number of access points required for a network in order for the
2843 * watchdog to monitor it.
2844 */
2845 public static final String WIFI_WATCHDOG_AP_COUNT = "wifi_watchdog_ap_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002846
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002847 /**
2848 * The delay between background checks.
2849 */
2850 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
2851 "wifi_watchdog_background_check_delay_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002852
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002853 /**
2854 * Whether the Wi-Fi watchdog is enabled for background checking even
2855 * after it thinks the user has connected to a good access point.
2856 */
2857 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
2858 "wifi_watchdog_background_check_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002859
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002860 /**
2861 * The timeout for a background ping
2862 */
2863 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
2864 "wifi_watchdog_background_check_timeout_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002865
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002866 /**
2867 * The number of initial pings to perform that *may* be ignored if they
2868 * fail. Again, if these fail, they will *not* be used in packet loss
2869 * calculation. For example, one network always seemed to time out for
2870 * the first couple pings, so this is set to 3 by default.
2871 */
2872 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2873 "wifi_watchdog_initial_ignored_ping_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002874
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002875 /**
2876 * The maximum number of access points (per network) to attempt to test.
2877 * If this number is reached, the watchdog will no longer monitor the
2878 * initial connection state for the network. This is a safeguard for
2879 * networks containing multiple APs whose DNS does not respond to pings.
2880 */
2881 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = "wifi_watchdog_max_ap_checks";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002882
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002883 /**
2884 * Whether the Wi-Fi watchdog is enabled.
2885 */
2886 public static final String WIFI_WATCHDOG_ON = "wifi_watchdog_on";
2887
2888 /**
2889 * A comma-separated list of SSIDs for which the Wi-Fi watchdog should be enabled.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002890 */
2891 public static final String WIFI_WATCHDOG_WATCH_LIST = "wifi_watchdog_watch_list";
2892
2893 /**
2894 * The number of pings to test if an access point is a good connection.
2895 */
2896 public static final String WIFI_WATCHDOG_PING_COUNT = "wifi_watchdog_ping_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002897
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002898 /**
2899 * The delay between pings.
2900 */
2901 public static final String WIFI_WATCHDOG_PING_DELAY_MS = "wifi_watchdog_ping_delay_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002902
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002903 /**
2904 * The timeout per ping.
2905 */
2906 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS = "wifi_watchdog_ping_timeout_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002907
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002908 /**
2909 * The maximum number of times we will retry a connection to an access
2910 * point for which we have failed in acquiring an IP address from DHCP.
2911 * A value of N means that we will make N+1 connection attempts in all.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002912 */
2913 public static final String WIFI_MAX_DHCP_RETRY_COUNT = "wifi_max_dhcp_retry_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002914
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002915 /**
Irfan Sheriff36f74132010-11-04 16:57:37 -07002916 * The operational wifi frequency band
2917 * Set to one of {@link WifiManager#WIFI_FREQUENCY_BAND_AUTO},
2918 * {@link WifiManager#WIFI_FREQUENCY_BAND_5GHZ} or
2919 * {@link WifiManager#WIFI_FREQUENCY_BAND_2GHZ}
2920 *
2921 * @hide
2922 */
2923 public static final String WIFI_FREQUENCY_BAND = "wifi_frequency_band";
2924
2925 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002926 * Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile
2927 * data connectivity to be established after a disconnect from Wi-Fi.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002928 */
2929 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
2930 "wifi_mobile_data_transition_wakelock_timeout_ms";
2931
2932 /**
2933 * Whether background data usage is allowed by the user. See
2934 * ConnectivityManager for more info.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002935 */
2936 public static final String BACKGROUND_DATA = "background_data";
Wink Saville04e71b32009-04-02 11:00:54 -07002937
2938 /**
Bjorn Bringert98bfa392010-03-24 10:59:48 +00002939 * Origins for which browsers should allow geolocation by default.
2940 * The value is a space-separated list of origins.
2941 */
2942 public static final String ALLOWED_GEOLOCATION_ORIGINS
2943 = "allowed_geolocation_origins";
2944
2945 /**
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002946 * Whether mobile data connections are allowed by the user. See
2947 * ConnectivityManager for more info.
2948 * @hide
2949 */
2950 public static final String MOBILE_DATA = "mobile_data";
2951
2952 /**
Wink Saville04e71b32009-04-02 11:00:54 -07002953 * The CDMA roaming mode 0 = Home Networks, CDMA default
2954 * 1 = Roaming on Affiliated networks
2955 * 2 = Roaming on any networks
2956 * @hide
2957 */
2958 public static final String CDMA_ROAMING_MODE = "roaming_settings";
2959
2960 /**
2961 * The CDMA subscription mode 0 = RUIM/SIM (default)
2962 * 1 = NV
2963 * @hide
2964 */
2965 public static final String CDMA_SUBSCRIPTION_MODE = "subscription_mode";
2966
2967 /**
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002968 * The preferred network mode 7 = Global
2969 * 6 = EvDo only
2970 * 5 = CDMA w/o EvDo
2971 * 4 = CDMA / EvDo auto
2972 * 3 = GSM / WCDMA auto
2973 * 2 = WCDMA only
2974 * 1 = GSM only
2975 * 0 = GSM / WCDMA preferred
Wink Saville04e71b32009-04-02 11:00:54 -07002976 * @hide
2977 */
2978 public static final String PREFERRED_NETWORK_MODE =
2979 "preferred_network_mode";
2980
2981 /**
Wink Savillee9b06d72009-05-18 21:47:50 -07002982 * The preferred TTY mode 0 = TTy Off, CDMA default
2983 * 1 = TTY Full
2984 * 2 = TTY HCO
2985 * 3 = TTY VCO
2986 * @hide
2987 */
2988 public static final String PREFERRED_TTY_MODE =
2989 "preferred_tty_mode";
2990
2991
2992 /**
Wink Saville04e71b32009-04-02 11:00:54 -07002993 * CDMA Cell Broadcast SMS
2994 * 0 = CDMA Cell Broadcast SMS disabled
2995 * 1 = CDMA Cell Broadcast SMS enabled
2996 * @hide
2997 */
2998 public static final String CDMA_CELL_BROADCAST_SMS =
2999 "cdma_cell_broadcast_sms";
3000
3001 /**
3002 * The cdma subscription 0 = Subscription from RUIM, when available
3003 * 1 = Subscription from NV
3004 * @hide
3005 */
3006 public static final String PREFERRED_CDMA_SUBSCRIPTION =
3007 "preferred_cdma_subscription";
3008
3009 /**
3010 * Whether the enhanced voice privacy mode is enabled.
3011 * 0 = normal voice privacy
3012 * 1 = enhanced voice privacy
3013 * @hide
3014 */
3015 public static final String ENHANCED_VOICE_PRIVACY_ENABLED = "enhanced_voice_privacy_enabled";
3016
3017 /**
3018 * Whether the TTY mode mode is enabled.
3019 * 0 = disabled
3020 * 1 = enabled
3021 * @hide
3022 */
3023 public static final String TTY_MODE_ENABLED = "tty_mode_enabled";
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003024
3025 /**
Wink Saville628b0852011-08-04 15:01:58 -07003026 * The number of milliseconds to delay before sending out Connectivyt Change broadcasts
3027 * @hide
3028 */
3029 public static final String CONNECTIVITY_CHANGE_DELAY = "connectivity_change_delay";
3030
3031 /**
3032 * Default value for CONNECTIVITY_CHANGE_DELAY in milliseconds.
3033 * @hide
3034 */
3035 public static final int CONNECTIVITY_CHANGE_DELAY_DEFAULT = 3000;
3036
3037 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07003038 * Controls whether settings backup is enabled.
Dianne Hackborncf098292009-07-01 19:55:20 -07003039 * Type: int ( 0 = disabled, 1 = enabled )
3040 * @hide
3041 */
3042 public static final String BACKUP_ENABLED = "backup_enabled";
3043
3044 /**
Christopher Tatecce9da52010-02-03 15:11:15 -08003045 * Controls whether application data is automatically restored from backup
3046 * at install time.
3047 * Type: int ( 0 = disabled, 1 = enabled )
3048 * @hide
3049 */
3050 public static final String BACKUP_AUTO_RESTORE = "backup_auto_restore";
3051
3052 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07003053 * Indicates whether settings backup has been fully provisioned.
3054 * Type: int ( 0 = unprovisioned, 1 = fully provisioned )
3055 * @hide
3056 */
3057 public static final String BACKUP_PROVISIONED = "backup_provisioned";
3058
3059 /**
Dianne Hackborncf098292009-07-01 19:55:20 -07003060 * Component of the transport to use for backup/restore.
3061 * @hide
3062 */
3063 public static final String BACKUP_TRANSPORT = "backup_transport";
Sanjay Jeyakumar21bf2412009-07-09 13:31:48 -07003064
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07003065 /**
3066 * Version for which the setup wizard was last shown. Bumped for
3067 * each release when there is new setup information to show.
3068 * @hide
3069 */
3070 public static final String LAST_SETUP_SHOWN = "last_setup_shown";
Dianne Hackborncf098292009-07-01 19:55:20 -07003071
3072 /**
Doug Zongkerf6888892010-01-06 16:38:14 -08003073 * How frequently (in seconds) to check the memory status of the
3074 * device.
3075 * @hide
3076 */
3077 public static final String MEMCHECK_INTERVAL = "memcheck_interval";
3078
3079 /**
3080 * Max frequency (in seconds) to log memory check stats, in realtime
3081 * seconds. This allows for throttling of logs when the device is
3082 * running for large amounts of time.
3083 * @hide
3084 */
3085 public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
3086 "memcheck_log_realtime_interval";
3087
3088 /**
3089 * Boolean indicating whether rebooting due to system memory checks
3090 * is enabled.
3091 * @hide
3092 */
3093 public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
3094
3095 /**
3096 * How many bytes the system process must be below to avoid scheduling
3097 * a soft reboot. This reboot will happen when it is next determined
3098 * to be a good time.
3099 * @hide
3100 */
3101 public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
3102
3103 /**
3104 * How many bytes the system process must be below to avoid scheduling
3105 * a hard reboot. This reboot will happen immediately.
3106 * @hide
3107 */
3108 public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
3109
3110 /**
3111 * How many bytes the phone process must be below to avoid scheduling
3112 * a soft restart. This restart will happen when it is next determined
3113 * to be a good time.
3114 * @hide
3115 */
3116 public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
3117
3118 /**
3119 * How many bytes the phone process must be below to avoid scheduling
3120 * a hard restart. This restart will happen immediately.
3121 * @hide
3122 */
3123 public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
3124
3125 /**
3126 * Boolean indicating whether restarting the phone process due to
3127 * memory checks is enabled.
3128 * @hide
3129 */
3130 public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
3131
3132 /**
3133 * First time during the day it is okay to kill processes
3134 * or reboot the device due to low memory situations. This number is
3135 * in seconds since midnight.
3136 * @hide
3137 */
3138 public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
3139
3140 /**
3141 * Last time during the day it is okay to kill processes
3142 * or reboot the device due to low memory situations. This number is
3143 * in seconds since midnight.
3144 * @hide
3145 */
3146 public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
3147
3148 /**
3149 * How long the screen must have been off in order to kill processes
3150 * or reboot. This number is in seconds. A value of -1 means to
3151 * entirely disregard whether the screen is on.
3152 * @hide
3153 */
3154 public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
3155
3156 /**
3157 * How much time there must be until the next alarm in order to kill processes
3158 * or reboot. This number is in seconds. Note: this value must be
3159 * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
3160 * always see an alarm scheduled within its time.
3161 * @hide
3162 */
3163 public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
3164
3165 /**
3166 * How frequently to check whether it is a good time to restart things,
3167 * if the device is in a bad state. This number is in seconds. Note:
3168 * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
3169 * the alarm to schedule the recheck will always appear within the
3170 * minimum "do not execute now" time.
3171 * @hide
3172 */
3173 public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
3174
3175 /**
3176 * How frequently (in DAYS) to reboot the device. If 0, no reboots
3177 * will occur.
3178 * @hide
3179 */
3180 public static final String REBOOT_INTERVAL = "reboot_interval";
3181
3182 /**
3183 * First time during the day it is okay to force a reboot of the
3184 * device (if REBOOT_INTERVAL is set). This number is
3185 * in seconds since midnight.
3186 * @hide
3187 */
3188 public static final String REBOOT_START_TIME = "reboot_start_time";
3189
3190 /**
3191 * The window of time (in seconds) after each REBOOT_INTERVAL in which
3192 * a reboot can be executed. If 0, a reboot will always be executed at
3193 * exactly the given time. Otherwise, it will only be executed if
3194 * the device is idle within the window.
3195 * @hide
3196 */
3197 public static final String REBOOT_WINDOW = "reboot_window";
3198
3199 /**
Doug Zongker43866e02010-01-07 12:09:54 -08003200 * Threshold values for the duration and level of a discharge cycle, under
3201 * which we log discharge cycle info.
3202 * @hide
3203 */
3204 public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
3205 "battery_discharge_duration_threshold";
3206 /** @hide */
3207 public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
3208
3209 /**
3210 * Flag for allowing ActivityManagerService to send ACTION_APP_ERROR intents
3211 * on application crashes and ANRs. If this is disabled, the crash/ANR dialog
3212 * will never display the "Report" button.
3213 * Type: int ( 0 = disallow, 1 = allow )
3214 * @hide
3215 */
3216 public static final String SEND_ACTION_APP_ERROR = "send_action_app_error";
3217
3218 /**
3219 * Nonzero causes Log.wtf() to crash.
3220 * @hide
3221 */
3222 public static final String WTF_IS_FATAL = "wtf_is_fatal";
3223
3224 /**
Jake Hambybb371632010-08-23 18:16:48 -07003225 * Maximum age of entries kept by {@link com.android.internal.os.IDropBoxManagerService}.
Doug Zongker43866e02010-01-07 12:09:54 -08003226 * @hide
3227 */
3228 public static final String DROPBOX_AGE_SECONDS =
3229 "dropbox_age_seconds";
3230 /**
Jake Hambybb371632010-08-23 18:16:48 -07003231 * Maximum number of entry files which {@link com.android.internal.os.IDropBoxManagerService} will keep around.
Dan Egnor3a8b0c12010-03-24 17:48:20 -07003232 * @hide
3233 */
3234 public static final String DROPBOX_MAX_FILES =
3235 "dropbox_max_files";
3236 /**
Jake Hambybb371632010-08-23 18:16:48 -07003237 * Maximum amount of disk space used by {@link com.android.internal.os.IDropBoxManagerService} no matter what.
Doug Zongker43866e02010-01-07 12:09:54 -08003238 * @hide
3239 */
3240 public static final String DROPBOX_QUOTA_KB =
3241 "dropbox_quota_kb";
3242 /**
Jake Hambybb371632010-08-23 18:16:48 -07003243 * Percent of free disk (excluding reserve) which {@link com.android.internal.os.IDropBoxManagerService} will use.
Doug Zongker43866e02010-01-07 12:09:54 -08003244 * @hide
3245 */
3246 public static final String DROPBOX_QUOTA_PERCENT =
3247 "dropbox_quota_percent";
3248 /**
Jake Hambybb371632010-08-23 18:16:48 -07003249 * Percent of total disk which {@link com.android.internal.os.IDropBoxManagerService} will never dip into.
Doug Zongker43866e02010-01-07 12:09:54 -08003250 * @hide
3251 */
3252 public static final String DROPBOX_RESERVE_PERCENT =
3253 "dropbox_reserve_percent";
3254 /**
3255 * Prefix for per-tag dropbox disable/enable settings.
3256 * @hide
3257 */
3258 public static final String DROPBOX_TAG_PREFIX =
3259 "dropbox:";
Dan Egnora455d192010-03-12 08:52:28 -08003260 /**
3261 * Lines of logcat to include with system crash/ANR/etc. reports,
3262 * as a prefix of the dropbox tag of the report type.
3263 * For example, "logcat_for_system_server_anr" controls the lines
3264 * of logcat captured with system server ANR reports. 0 to disable.
3265 * @hide
3266 */
3267 public static final String ERROR_LOGCAT_PREFIX =
3268 "logcat_for_";
Doug Zongker43866e02010-01-07 12:09:54 -08003269
3270
3271 /**
3272 * Screen timeout in milliseconds corresponding to the
3273 * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
3274 * possible screen timeout behavior.)
3275 * @hide
3276 */
3277 public static final String SHORT_KEYLIGHT_DELAY_MS =
3278 "short_keylight_delay_ms";
3279
3280 /**
3281 * The interval in minutes after which the amount of free storage left on the
3282 * device is logged to the event log
3283 * @hide
3284 */
3285 public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
3286 "sys_free_storage_log_interval";
3287
3288 /**
3289 * Threshold for the amount of change in disk free space required to report the amount of
3290 * free space. Used to prevent spamming the logs when the disk free space isn't changing
3291 * frequently.
3292 * @hide
3293 */
3294 public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
3295 "disk_free_change_reporting_threshold";
3296
3297
3298 /**
3299 * Minimum percentage of free storage on the device that is used to determine if
Dianne Hackborn247fe742011-01-08 17:25:57 -08003300 * the device is running low on storage. The default is 10.
3301 * <p>Say this value is set to 10, the device is considered running low on storage
Doug Zongker43866e02010-01-07 12:09:54 -08003302 * if 90% or more of the device storage is filled up.
3303 * @hide
3304 */
3305 public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
3306 "sys_storage_threshold_percentage";
3307
3308 /**
Dianne Hackborn247fe742011-01-08 17:25:57 -08003309 * Maximum byte size of the low storage threshold. This is to ensure
3310 * that {@link #SYS_STORAGE_THRESHOLD_PERCENTAGE} does not result in
3311 * an overly large threshold for large storage devices. Currently this
3312 * must be less than 2GB. This default is 500MB.
3313 * @hide
3314 */
3315 public static final String SYS_STORAGE_THRESHOLD_MAX_BYTES =
3316 "sys_storage_threshold_max_bytes";
3317
3318 /**
Jake Hambybb371632010-08-23 18:16:48 -07003319 * Minimum bytes of free storage on the device before the data
3320 * partition is considered full. By default, 1 MB is reserved
3321 * to avoid system-wide SQLite disk full exceptions.
3322 * @hide
3323 */
3324 public static final String SYS_STORAGE_FULL_THRESHOLD_BYTES =
3325 "sys_storage_full_threshold_bytes";
3326
3327 /**
Doug Zongker43866e02010-01-07 12:09:54 -08003328 * The interval in milliseconds after which Wi-Fi is considered idle.
3329 * When idle, it is possible for the device to be switched from Wi-Fi to
3330 * the mobile data network.
3331 * @hide
3332 */
3333 public static final String WIFI_IDLE_MS = "wifi_idle_ms";
3334
3335 /**
Irfan Sheriff4f5f7c92010-10-14 17:01:27 -07003336 * The interval in milliseconds to issue scans when the driver is
3337 * started. This is necessary to allow wifi to connect to an
3338 * access point when the driver is suspended.
3339 * @hide
3340 */
3341 public static final String WIFI_SCAN_INTERVAL_MS = "wifi_scan_interval_ms";
3342
3343 /**
Doug Zongkeredc51892010-01-07 13:51:16 -08003344 * The interval in milliseconds at which to check packet counts on the
3345 * mobile data interface when screen is on, to detect possible data
3346 * connection problems.
3347 * @hide
3348 */
3349 public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
3350 "pdp_watchdog_poll_interval_ms";
3351
3352 /**
3353 * The interval in milliseconds at which to check packet counts on the
3354 * mobile data interface when screen is off, to detect possible data
3355 * connection problems.
3356 * @hide
3357 */
3358 public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
3359 "pdp_watchdog_long_poll_interval_ms";
3360
3361 /**
3362 * The interval in milliseconds at which to check packet counts on the
3363 * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
3364 * outgoing packets has been reached without incoming packets.
3365 * @hide
3366 */
3367 public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
3368 "pdp_watchdog_error_poll_interval_ms";
3369
3370 /**
3371 * The number of outgoing packets sent without seeing an incoming packet
3372 * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
3373 * device is logged to the event log
3374 * @hide
3375 */
3376 public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
3377 "pdp_watchdog_trigger_packet_count";
3378
3379 /**
3380 * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
3381 * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
3382 * attempting data connection recovery.
3383 * @hide
3384 */
3385 public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
3386 "pdp_watchdog_error_poll_count";
3387
3388 /**
3389 * The number of failed PDP reset attempts before moving to something more
3390 * drastic: re-registering to the network.
3391 * @hide
3392 */
3393 public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
3394 "pdp_watchdog_max_pdp_reset_fail_count";
3395
3396 /**
Doug Zongkeredc51892010-01-07 13:51:16 -08003397 * The interval in milliseconds at which to check gprs registration
3398 * after the first registration mismatch of gprs and voice service,
3399 * to detect possible data network registration problems.
3400 *
3401 * @hide
3402 */
3403 public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
3404 "gprs_register_check_period_ms";
3405
3406 /**
3407 * The length of time in milli-seconds that automatic small adjustments to
3408 * SystemClock are ignored if NITZ_UPDATE_DIFF is not exceeded.
3409 * @hide
3410 */
3411 public static final String NITZ_UPDATE_SPACING = "nitz_update_spacing";
3412
3413 /**
3414 * If the NITZ_UPDATE_DIFF time is exceeded then an automatic adjustment
3415 * to SystemClock will be allowed even if NITZ_UPDATE_SPACING has not been
3416 * exceeded.
3417 * @hide
3418 */
3419 public static final String NITZ_UPDATE_DIFF = "nitz_update_diff";
3420
3421 /**
3422 * The maximum reconnect delay for short network outages or when the network is suspended
3423 * due to phone use.
3424 * @hide
3425 */
3426 public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
3427 "sync_max_retry_delay_in_seconds";
3428
3429 /**
3430 * The interval in milliseconds at which to check the number of SMS sent
3431 * out without asking for use permit, to limit the un-authorized SMS
3432 * usage.
3433 * @hide
3434 */
3435 public static final String SMS_OUTGOING_CHECK_INTERVAL_MS =
3436 "sms_outgoing_check_interval_ms";
3437
3438 /**
3439 * The number of outgoing SMS sent without asking for user permit
3440 * (of {@link #SMS_OUTGOING_CHECK_INTERVAL_MS}
3441 * @hide
3442 */
3443 public static final String SMS_OUTGOING_CHECK_MAX_COUNT =
3444 "sms_outgoing_check_max_count";
3445
3446 /**
Doug Zongkeraed8f8e2010-01-07 18:07:50 -08003447 * The number of promoted sources in GlobalSearch.
3448 * @hide
3449 */
3450 public static final String SEARCH_NUM_PROMOTED_SOURCES = "search_num_promoted_sources";
3451 /**
3452 * The maximum number of suggestions returned by GlobalSearch.
3453 * @hide
3454 */
3455 public static final String SEARCH_MAX_RESULTS_TO_DISPLAY = "search_max_results_to_display";
3456 /**
3457 * The number of suggestions GlobalSearch will ask each non-web search source for.
3458 * @hide
3459 */
3460 public static final String SEARCH_MAX_RESULTS_PER_SOURCE = "search_max_results_per_source";
3461 /**
3462 * The number of suggestions the GlobalSearch will ask the web search source for.
3463 * @hide
3464 */
3465 public static final String SEARCH_WEB_RESULTS_OVERRIDE_LIMIT =
3466 "search_web_results_override_limit";
3467 /**
3468 * The number of milliseconds that GlobalSearch will wait for suggestions from
3469 * promoted sources before continuing with all other sources.
3470 * @hide
3471 */
3472 public static final String SEARCH_PROMOTED_SOURCE_DEADLINE_MILLIS =
3473 "search_promoted_source_deadline_millis";
3474 /**
3475 * The number of milliseconds before GlobalSearch aborts search suggesiton queries.
3476 * @hide
3477 */
3478 public static final String SEARCH_SOURCE_TIMEOUT_MILLIS = "search_source_timeout_millis";
3479 /**
3480 * The maximum number of milliseconds that GlobalSearch shows the previous results
3481 * after receiving a new query.
3482 * @hide
3483 */
3484 public static final String SEARCH_PREFILL_MILLIS = "search_prefill_millis";
3485 /**
3486 * The maximum age of log data used for shortcuts in GlobalSearch.
3487 * @hide
3488 */
3489 public static final String SEARCH_MAX_STAT_AGE_MILLIS = "search_max_stat_age_millis";
3490 /**
3491 * The maximum age of log data used for source ranking in GlobalSearch.
3492 * @hide
3493 */
3494 public static final String SEARCH_MAX_SOURCE_EVENT_AGE_MILLIS =
3495 "search_max_source_event_age_millis";
3496 /**
3497 * The minimum number of impressions needed to rank a source in GlobalSearch.
3498 * @hide
3499 */
3500 public static final String SEARCH_MIN_IMPRESSIONS_FOR_SOURCE_RANKING =
3501 "search_min_impressions_for_source_ranking";
3502 /**
3503 * The minimum number of clicks needed to rank a source in GlobalSearch.
3504 * @hide
3505 */
3506 public static final String SEARCH_MIN_CLICKS_FOR_SOURCE_RANKING =
3507 "search_min_clicks_for_source_ranking";
3508 /**
3509 * The maximum number of shortcuts shown by GlobalSearch.
3510 * @hide
3511 */
3512 public static final String SEARCH_MAX_SHORTCUTS_RETURNED = "search_max_shortcuts_returned";
3513 /**
3514 * The size of the core thread pool for suggestion queries in GlobalSearch.
3515 * @hide
3516 */
3517 public static final String SEARCH_QUERY_THREAD_CORE_POOL_SIZE =
3518 "search_query_thread_core_pool_size";
3519 /**
3520 * The maximum size of the thread pool for suggestion queries in GlobalSearch.
3521 * @hide
3522 */
3523 public static final String SEARCH_QUERY_THREAD_MAX_POOL_SIZE =
3524 "search_query_thread_max_pool_size";
3525 /**
3526 * The size of the core thread pool for shortcut refreshing in GlobalSearch.
3527 * @hide
3528 */
3529 public static final String SEARCH_SHORTCUT_REFRESH_CORE_POOL_SIZE =
3530 "search_shortcut_refresh_core_pool_size";
3531 /**
3532 * The maximum size of the thread pool for shortcut refreshing in GlobalSearch.
3533 * @hide
3534 */
3535 public static final String SEARCH_SHORTCUT_REFRESH_MAX_POOL_SIZE =
3536 "search_shortcut_refresh_max_pool_size";
3537 /**
3538 * The maximun time that excess threads in the GlobalSeach thread pools will
3539 * wait before terminating.
3540 * @hide
3541 */
3542 public static final String SEARCH_THREAD_KEEPALIVE_SECONDS =
3543 "search_thread_keepalive_seconds";
3544 /**
3545 * The maximum number of concurrent suggestion queries to each source.
3546 * @hide
3547 */
3548 public static final String SEARCH_PER_SOURCE_CONCURRENT_QUERY_LIMIT =
3549 "search_per_source_concurrent_query_limit";
3550
San Mehat87734d32010-01-08 12:53:06 -08003551 /**
3552 * Whether or not alert sounds are played on MountService events. (0 = false, 1 = true)
3553 * @hide
3554 */
3555 public static final String MOUNT_PLAY_NOTIFICATION_SND = "mount_play_not_snd";
3556
3557 /**
3558 * Whether or not UMS auto-starts on UMS host detection. (0 = false, 1 = true)
3559 * @hide
3560 */
3561 public static final String MOUNT_UMS_AUTOSTART = "mount_ums_autostart";
3562
3563 /**
3564 * Whether or not a notification is displayed on UMS host detection. (0 = false, 1 = true)
3565 * @hide
3566 */
3567 public static final String MOUNT_UMS_PROMPT = "mount_ums_prompt";
3568
3569 /**
3570 * Whether or not a notification is displayed while UMS is enabled. (0 = false, 1 = true)
3571 * @hide
3572 */
3573 public static final String MOUNT_UMS_NOTIFY_ENABLED = "mount_ums_notify_enabled";
Doug Zongkeraed8f8e2010-01-07 18:07:50 -08003574
Dan Egnor42471dd2010-01-07 17:25:22 -08003575 /**
3576 * If nonzero, ANRs in invisible background processes bring up a dialog.
3577 * Otherwise, the process will be silently killed.
3578 * @hide
3579 */
3580 public static final String ANR_SHOW_BACKGROUND = "anr_show_background";
Erikeebc8e22010-02-18 13:27:19 -08003581
Mike LeBeau5d34e9b2010-02-10 19:34:56 -08003582 /**
3583 * The {@link ComponentName} string of the service to be used as the voice recognition
3584 * service.
Erikeebc8e22010-02-18 13:27:19 -08003585 *
Mike LeBeau5d34e9b2010-02-10 19:34:56 -08003586 * @hide
3587 */
3588 public static final String VOICE_RECOGNITION_SERVICE = "voice_recognition_service";
Dan Egnor42471dd2010-01-07 17:25:22 -08003589
Doug Zongkeraed8f8e2010-01-07 18:07:50 -08003590 /**
David Brown458e8062010-03-08 21:52:11 -08003591 * What happens when the user presses the Power button while in-call
3592 * and the screen is on.<br/>
3593 * <b>Values:</b><br/>
3594 * 1 - The Power button turns off the screen and locks the device. (Default behavior)<br/>
3595 * 2 - The Power button hangs up the current call.<br/>
3596 *
3597 * @hide
3598 */
3599 public static final String INCALL_POWER_BUTTON_BEHAVIOR = "incall_power_button_behavior";
3600
3601 /**
3602 * INCALL_POWER_BUTTON_BEHAVIOR value for "turn off screen".
3603 * @hide
3604 */
3605 public static final int INCALL_POWER_BUTTON_BEHAVIOR_SCREEN_OFF = 0x1;
3606
3607 /**
3608 * INCALL_POWER_BUTTON_BEHAVIOR value for "hang up".
3609 * @hide
3610 */
3611 public static final int INCALL_POWER_BUTTON_BEHAVIOR_HANGUP = 0x2;
3612
3613 /**
3614 * INCALL_POWER_BUTTON_BEHAVIOR default value.
3615 * @hide
3616 */
3617 public static final int INCALL_POWER_BUTTON_BEHAVIOR_DEFAULT =
3618 INCALL_POWER_BUTTON_BEHAVIOR_SCREEN_OFF;
3619
3620 /**
Dianne Hackborn2ccda4d2010-03-22 21:49:15 -07003621 * The current night mode that has been selected by the user. Owned
3622 * and controlled by UiModeManagerService. Constants are as per
3623 * UiModeManager.
3624 * @hide
3625 */
3626 public static final String UI_NIGHT_MODE = "ui_night_mode";
Suchi Amalapurapu40e47252010-04-07 16:15:50 -07003627
3628 /**
3629 * Let user pick default install location.
3630 * @hide
3631 */
3632 public static final String SET_INSTALL_LOCATION = "set_install_location";
3633
3634 /**
3635 * Default install location value.
3636 * 0 = auto, let system decide
3637 * 1 = internal
3638 * 2 = sdcard
3639 * @hide
3640 */
3641 public static final String DEFAULT_INSTALL_LOCATION = "default_install_location";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003642
3643 /**
3644 * The bandwidth throttle polling freqency in seconds
3645 * @hide
3646 */
3647 public static final String THROTTLE_POLLING_SEC = "throttle_polling_sec";
3648
3649 /**
3650 * The bandwidth throttle threshold (long)
3651 * @hide
3652 */
Robert Greenwaltd3bb93f2010-04-12 19:20:55 -07003653 public static final String THROTTLE_THRESHOLD_BYTES = "throttle_threshold_bytes";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003654
3655 /**
3656 * The bandwidth throttle value (kbps)
3657 * @hide
3658 */
Robert Greenwaltd3bb93f2010-04-12 19:20:55 -07003659 public static final String THROTTLE_VALUE_KBITSPS = "throttle_value_kbitsps";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003660
3661 /**
3662 * The bandwidth throttle reset calendar day (1-28)
3663 * @hide
3664 */
3665 public static final String THROTTLE_RESET_DAY = "throttle_reset_day";
3666
3667 /**
3668 * The throttling notifications we should send
3669 * @hide
3670 */
3671 public static final String THROTTLE_NOTIFICATION_TYPE = "throttle_notification_type";
3672
3673 /**
Irfan Sheriffc9b68512010-04-08 14:12:33 -07003674 * Help URI for data throttling policy
3675 * @hide
3676 */
3677 public static final String THROTTLE_HELP_URI = "throttle_help_uri";
3678
Robert Greenwaltd1055a22010-05-25 15:54:52 -07003679 /**
3680 * The length of time in Sec that we allow our notion of NTP time
3681 * to be cached before we refresh it
3682 * @hide
3683 */
3684 public static final String THROTTLE_MAX_NTP_CACHE_AGE_SEC =
3685 "throttle_max_ntp_cache_age_sec";
3686
Steve Howard9c4e33e2010-07-28 15:59:29 -07003687 /**
3688 * The maximum size, in bytes, of a download that the download manager will transfer over
3689 * a non-wifi connection.
3690 * @hide
3691 */
3692 public static final String DOWNLOAD_MAX_BYTES_OVER_MOBILE =
3693 "download_manager_max_bytes_over_mobile";
3694
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07003695 /**
Steve Howardf1766812010-09-17 16:46:19 -07003696 * The recommended maximum size, in bytes, of a download that the download manager should
3697 * transfer over a non-wifi connection. Over this size, the use will be warned, but will
3698 * have the option to start the download over the mobile connection anyway.
3699 * @hide
3700 */
3701 public static final String DOWNLOAD_RECOMMENDED_MAX_BYTES_OVER_MOBILE =
3702 "download_manager_recommended_max_bytes_over_mobile";
3703
3704 /**
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07003705 * ms during which to consume extra events related to Inet connection condition
3706 * after a transtion to fully-connected
3707 * @hide
3708 */
3709 public static final String INET_CONDITION_DEBOUNCE_UP_DELAY =
3710 "inet_condition_debounce_up_delay";
3711
3712 /**
3713 * ms during which to consume extra events related to Inet connection condtion
3714 * after a transtion to partly-connected
3715 * @hide
3716 */
3717 public static final String INET_CONDITION_DEBOUNCE_DOWN_DELAY =
3718 "inet_condition_debounce_down_delay";
Irfan Sheriffc9b68512010-04-08 14:12:33 -07003719
3720 /**
Freeman Ng96be4e02011-04-07 18:21:40 -07003721 * URL to open browser on to allow user to manage a prepay account
3722 * @hide
3723 */
3724 public static final String SETUP_PREPAID_DATA_SERVICE_URL =
3725 "setup_prepaid_data_service_url";
3726
3727 /**
Freeman Ng3b9089c2011-04-22 16:42:57 -07003728 * URL to attempt a GET on to see if this is a prepay device
3729 * @hide
3730 */
3731 public static final String SETUP_PREPAID_DETECTION_TARGET_URL =
3732 "setup_prepaid_detection_target_url";
3733
3734 /**
3735 * Host to check for a redirect to after an attempt to GET
3736 * SETUP_PREPAID_DETECTION_TARGET_URL. (If we redirected there,
3737 * this is a prepaid device with zero balance.)
3738 * @hide
3739 */
3740 public static final String SETUP_PREPAID_DETECTION_REDIR_HOST =
3741 "setup_prepaid_detection_redir_host";
3742
3743 /**
-b master501eec92009-07-06 13:53:11 -07003744 * @hide
3745 */
3746 public static final String[] SETTINGS_TO_BACKUP = {
Amith Yamasani8823c0a82009-07-07 14:30:17 -07003747 ADB_ENABLED,
3748 ALLOW_MOCK_LOCATION,
-b master501eec92009-07-06 13:53:11 -07003749 PARENTAL_CONTROL_ENABLED,
3750 PARENTAL_CONTROL_REDIRECT_URL,
3751 USB_MASS_STORAGE_ENABLED,
3752 ACCESSIBILITY_ENABLED,
Svetoslav Ganov585f13f8d2010-08-10 07:59:15 -07003753 ACCESSIBILITY_SCRIPT_INJECTION,
Christopher Tate14c2d792010-02-25 16:49:44 -08003754 BACKUP_AUTO_RESTORE,
-b master501eec92009-07-06 13:53:11 -07003755 ENABLED_ACCESSIBILITY_SERVICES,
3756 TTS_USE_DEFAULTS,
3757 TTS_DEFAULT_RATE,
3758 TTS_DEFAULT_PITCH,
3759 TTS_DEFAULT_SYNTH,
3760 TTS_DEFAULT_LANG,
3761 TTS_DEFAULT_COUNTRY,
Charles Chenceffa152010-03-16 21:18:10 -07003762 TTS_ENABLED_PLUGINS,
-b master501eec92009-07-06 13:53:11 -07003763 WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON,
3764 WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY,
-b master501eec92009-07-06 13:53:11 -07003765 WIFI_NUM_OPEN_NETWORKS_KEPT,
San Mehat87734d32010-01-08 12:53:06 -08003766 MOUNT_PLAY_NOTIFICATION_SND,
3767 MOUNT_UMS_AUTOSTART,
3768 MOUNT_UMS_PROMPT,
Dianne Hackborn2ccda4d2010-03-22 21:49:15 -07003769 MOUNT_UMS_NOTIFY_ENABLED,
3770 UI_NIGHT_MODE
-b master501eec92009-07-06 13:53:11 -07003771 };
3772
3773 /**
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003774 * Helper method for determining if a location provider is enabled.
3775 * @param cr the content resolver to use
3776 * @param provider the location provider to query
3777 * @return true if the provider is enabled
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003778 */
3779 public static final boolean isLocationProviderEnabled(ContentResolver cr, String provider) {
3780 String allowedProviders = Settings.Secure.getString(cr, LOCATION_PROVIDERS_ALLOWED);
Brad Fitzpatrick11fe1812010-09-10 16:07:52 -07003781 return TextUtils.delimitedStringContains(allowedProviders, ',', provider);
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003782 }
3783
3784 /**
3785 * Thread-safe method for enabling or disabling a single location provider.
3786 * @param cr the content resolver to use
3787 * @param provider the location provider to enable or disable
3788 * @param enabled true if the provider should be enabled
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003789 */
3790 public static final void setLocationProviderEnabled(ContentResolver cr,
3791 String provider, boolean enabled) {
3792 // to ensure thread safety, we write the provider name with a '+' or '-'
3793 // and let the SettingsProvider handle it rather than reading and modifying
3794 // the list of enabled providers.
3795 if (enabled) {
3796 provider = "+" + provider;
3797 } else {
3798 provider = "-" + provider;
3799 }
3800 putString(cr, Settings.Secure.LOCATION_PROVIDERS_ALLOWED, provider);
3801 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003802 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003803
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003804 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003805 * User-defined bookmarks and shortcuts. The target of each bookmark is an
3806 * Intent URL, allowing it to be either a web page or a particular
3807 * application activity.
3808 *
3809 * @hide
3810 */
3811 public static final class Bookmarks implements BaseColumns
3812 {
3813 private static final String TAG = "Bookmarks";
3814
3815 /**
3816 * The content:// style URL for this table
3817 */
3818 public static final Uri CONTENT_URI =
3819 Uri.parse("content://" + AUTHORITY + "/bookmarks");
3820
3821 /**
3822 * The row ID.
3823 * <p>Type: INTEGER</p>
3824 */
3825 public static final String ID = "_id";
3826
3827 /**
3828 * Descriptive name of the bookmark that can be displayed to the user.
3829 * If this is empty, the title should be resolved at display time (use
3830 * {@link #getTitle(Context, Cursor)} any time you want to display the
3831 * title of a bookmark.)
3832 * <P>
3833 * Type: TEXT
3834 * </P>
3835 */
3836 public static final String TITLE = "title";
3837
3838 /**
3839 * Arbitrary string (displayed to the user) that allows bookmarks to be
3840 * organized into categories. There are some special names for
3841 * standard folders, which all start with '@'. The label displayed for
3842 * the folder changes with the locale (via {@link #getLabelForFolder}) but
3843 * the folder name does not change so you can consistently query for
3844 * the folder regardless of the current locale.
3845 *
3846 * <P>Type: TEXT</P>
3847 *
3848 */
3849 public static final String FOLDER = "folder";
3850
3851 /**
3852 * The Intent URL of the bookmark, describing what it points to. This
3853 * value is given to {@link android.content.Intent#getIntent} to create
3854 * an Intent that can be launched.
3855 * <P>Type: TEXT</P>
3856 */
3857 public static final String INTENT = "intent";
3858
3859 /**
3860 * Optional shortcut character associated with this bookmark.
3861 * <P>Type: INTEGER</P>
3862 */
3863 public static final String SHORTCUT = "shortcut";
3864
3865 /**
3866 * The order in which the bookmark should be displayed
3867 * <P>Type: INTEGER</P>
3868 */
3869 public static final String ORDERING = "ordering";
3870
3871 private static final String[] sIntentProjection = { INTENT };
3872 private static final String[] sShortcutProjection = { ID, SHORTCUT };
3873 private static final String sShortcutSelection = SHORTCUT + "=?";
3874
3875 /**
3876 * Convenience function to retrieve the bookmarked Intent for a
3877 * particular shortcut key.
3878 *
3879 * @param cr The ContentResolver to query.
3880 * @param shortcut The shortcut key.
3881 *
3882 * @return Intent The bookmarked URL, or null if there is no bookmark
3883 * matching the given shortcut.
3884 */
3885 public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3886 {
3887 Intent intent = null;
3888
3889 Cursor c = cr.query(CONTENT_URI,
3890 sIntentProjection, sShortcutSelection,
3891 new String[] { String.valueOf((int) shortcut) }, ORDERING);
3892 // Keep trying until we find a valid shortcut
3893 try {
3894 while (intent == null && c.moveToNext()) {
3895 try {
3896 String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
Christian Mehlmauera34d2c92010-05-25 19:04:20 +02003897 intent = Intent.parseUri(intentURI, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003898 } catch (java.net.URISyntaxException e) {
3899 // The stored URL is bad... ignore it.
3900 } catch (IllegalArgumentException e) {
3901 // Column not found
Dianne Hackborna33e3f72009-09-29 17:28:24 -07003902 Log.w(TAG, "Intent column not found", e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003903 }
3904 }
3905 } finally {
3906 if (c != null) c.close();
3907 }
3908
3909 return intent;
3910 }
3911
3912 /**
3913 * Add a new bookmark to the system.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003914 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003915 * @param cr The ContentResolver to query.
3916 * @param intent The desired target of the bookmark.
3917 * @param title Bookmark title that is shown to the user; null if none
3918 * or it should be resolved to the intent's title.
3919 * @param folder Folder in which to place the bookmark; null if none.
3920 * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3921 * this is non-zero and there is an existing bookmark entry
3922 * with this same shortcut, then that existing shortcut is
3923 * cleared (the bookmark is not removed).
3924 * @return The unique content URL for the new bookmark entry.
3925 */
3926 public static Uri add(ContentResolver cr,
3927 Intent intent,
3928 String title,
3929 String folder,
3930 char shortcut,
3931 int ordering)
3932 {
3933 // If a shortcut is supplied, and it is already defined for
3934 // another bookmark, then remove the old definition.
3935 if (shortcut != 0) {
Jeff Hamilton7cd51ef2010-05-12 17:30:27 -05003936 cr.delete(CONTENT_URI, sShortcutSelection,
3937 new String[] { String.valueOf((int) shortcut) });
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003938 }
3939
3940 ContentValues values = new ContentValues();
3941 if (title != null) values.put(TITLE, title);
3942 if (folder != null) values.put(FOLDER, folder);
Jean-Baptiste Queru3b9f0a32010-06-21 13:46:59 -07003943 values.put(INTENT, intent.toUri(0));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003944 if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3945 values.put(ORDERING, ordering);
3946 return cr.insert(CONTENT_URI, values);
3947 }
3948
3949 /**
3950 * Return the folder name as it should be displayed to the user. This
3951 * takes care of localizing special folders.
3952 *
3953 * @param r Resources object for current locale; only need access to
3954 * system resources.
3955 * @param folder The value found in the {@link #FOLDER} column.
3956 *
3957 * @return CharSequence The label for this folder that should be shown
3958 * to the user.
3959 */
3960 public static CharSequence getLabelForFolder(Resources r, String folder) {
3961 return folder;
3962 }
3963
3964 /**
3965 * Return the title as it should be displayed to the user. This takes
3966 * care of localizing bookmarks that point to activities.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003967 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003968 * @param context A context.
3969 * @param cursor A cursor pointing to the row whose title should be
3970 * returned. The cursor must contain at least the {@link #TITLE}
3971 * and {@link #INTENT} columns.
3972 * @return A title that is localized and can be displayed to the user,
3973 * or the empty string if one could not be found.
3974 */
3975 public static CharSequence getTitle(Context context, Cursor cursor) {
3976 int titleColumn = cursor.getColumnIndex(TITLE);
3977 int intentColumn = cursor.getColumnIndex(INTENT);
3978 if (titleColumn == -1 || intentColumn == -1) {
3979 throw new IllegalArgumentException(
3980 "The cursor must contain the TITLE and INTENT columns.");
3981 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003982
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003983 String title = cursor.getString(titleColumn);
3984 if (!TextUtils.isEmpty(title)) {
3985 return title;
3986 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003987
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003988 String intentUri = cursor.getString(intentColumn);
3989 if (TextUtils.isEmpty(intentUri)) {
3990 return "";
3991 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003992
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003993 Intent intent;
3994 try {
Christian Mehlmauera34d2c92010-05-25 19:04:20 +02003995 intent = Intent.parseUri(intentUri, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003996 } catch (URISyntaxException e) {
3997 return "";
3998 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003999
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004000 PackageManager packageManager = context.getPackageManager();
4001 ResolveInfo info = packageManager.resolveActivity(intent, 0);
4002 return info != null ? info.loadLabel(packageManager) : "";
4003 }
4004 }
4005
4006 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004007 * Returns the device ID that we should use when connecting to the mobile gtalk server.
4008 * This is a string like "android-0x1242", where the hex string is the Android ID obtained
4009 * from the GoogleLoginService.
4010 *
4011 * @param androidId The Android ID for this device.
4012 * @return The device ID that should be used when connecting to the mobile gtalk server.
4013 * @hide
4014 */
4015 public static String getGTalkDeviceId(long androidId) {
4016 return "android-" + Long.toHexString(androidId);
4017 }
4018}