blob: f1d7e29a21ad19df56c4f270f3b4d6d037a375c6 [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;
44import android.util.Log;
45
46import java.net.URISyntaxException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080047import java.util.HashMap;
48import java.util.HashSet;
49
50
51/**
52 * The Settings provider contains global system-level device preferences.
53 */
54public final class Settings {
55
56 // Intent actions for Settings
57
58 /**
59 * Activity Action: Show system settings.
60 * <p>
61 * Input: Nothing.
62 * <p>
63 * Output: nothing.
64 */
65 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
66 public static final String ACTION_SETTINGS = "android.settings.SETTINGS";
67
68 /**
69 * Activity Action: Show settings to allow configuration of APNs.
70 * <p>
71 * Input: Nothing.
72 * <p>
73 * Output: nothing.
74 */
75 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
76 public static final String ACTION_APN_SETTINGS = "android.settings.APN_SETTINGS";
77
78 /**
79 * Activity Action: Show settings to allow configuration of current location
80 * sources.
81 * <p>
82 * In some cases, a matching Activity may not exist, so ensure you
83 * safeguard against this.
84 * <p>
85 * Input: Nothing.
86 * <p>
87 * Output: Nothing.
88 */
89 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
90 public static final String ACTION_LOCATION_SOURCE_SETTINGS =
91 "android.settings.LOCATION_SOURCE_SETTINGS";
92
93 /**
94 * Activity Action: Show settings to allow configuration of wireless controls
95 * such as Wi-Fi, Bluetooth and Mobile networks.
96 * <p>
97 * In some cases, a matching Activity may not exist, so ensure you
98 * safeguard against this.
99 * <p>
100 * Input: Nothing.
101 * <p>
102 * Output: Nothing.
103 */
104 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
105 public static final String ACTION_WIRELESS_SETTINGS =
106 "android.settings.WIRELESS_SETTINGS";
107
108 /**
109 * Activity Action: Show settings to allow entering/exiting airplane mode.
110 * <p>
111 * In some cases, a matching Activity may not exist, so ensure you
112 * safeguard against this.
113 * <p>
114 * Input: Nothing.
115 * <p>
116 * Output: Nothing.
117 */
118 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
119 public static final String ACTION_AIRPLANE_MODE_SETTINGS =
120 "android.settings.AIRPLANE_MODE_SETTINGS";
121
122 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -0700123 * Activity Action: Show settings for accessibility modules.
124 * <p>
125 * In some cases, a matching Activity may not exist, so ensure you
126 * safeguard against this.
127 * <p>
128 * Input: Nothing.
129 * <p>
130 * Output: Nothing.
131 */
132 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
133 public static final String ACTION_ACCESSIBILITY_SETTINGS =
134 "android.settings.ACCESSIBILITY_SETTINGS";
135
136 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800137 * Activity Action: Show settings to allow configuration of security and
138 * location privacy.
139 * <p>
140 * In some cases, a matching Activity may not exist, so ensure you
141 * safeguard against this.
142 * <p>
143 * Input: Nothing.
144 * <p>
145 * Output: Nothing.
146 */
147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
148 public static final String ACTION_SECURITY_SETTINGS =
149 "android.settings.SECURITY_SETTINGS";
150
151 /**
Amith Yamasanic15255a2009-09-23 15:33:19 -0700152 * Activity Action: Show settings to allow configuration of privacy options.
153 * <p>
154 * In some cases, a matching Activity may not exist, so ensure you
155 * safeguard against this.
156 * <p>
157 * Input: Nothing.
158 * <p>
159 * Output: Nothing.
160 */
161 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
162 public static final String ACTION_PRIVACY_SETTINGS =
163 "android.settings.PRIVACY_SETTINGS";
164
165 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800166 * Activity Action: Show settings to allow configuration of Wi-Fi.
167
168 * <p>
169 * In some cases, a matching Activity may not exist, so ensure you
170 * safeguard against this.
171 * <p>
172 * Input: Nothing.
173 * <p>
174 * Output: Nothing.
175
176 */
177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
178 public static final String ACTION_WIFI_SETTINGS =
179 "android.settings.WIFI_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700180
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800181 /**
182 * Activity Action: Show settings to allow configuration of a static IP
183 * address for Wi-Fi.
184 * <p>
185 * In some cases, a matching Activity may not exist, so ensure you safeguard
186 * against this.
187 * <p>
188 * Input: Nothing.
189 * <p>
190 * Output: Nothing.
191 */
192 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
193 public static final String ACTION_WIFI_IP_SETTINGS =
194 "android.settings.WIFI_IP_SETTINGS";
195
196 /**
197 * Activity Action: Show settings to allow configuration of Bluetooth.
198 * <p>
199 * In some cases, a matching Activity may not exist, so ensure you
200 * safeguard against this.
201 * <p>
202 * Input: Nothing.
203 * <p>
204 * Output: Nothing.
205 */
206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
207 public static final String ACTION_BLUETOOTH_SETTINGS =
208 "android.settings.BLUETOOTH_SETTINGS";
209
210 /**
211 * Activity Action: Show settings to allow configuration of date and time.
212 * <p>
213 * In some cases, a matching Activity may not exist, so ensure you
214 * safeguard against this.
215 * <p>
216 * Input: Nothing.
217 * <p>
218 * Output: Nothing.
219 */
220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
221 public static final String ACTION_DATE_SETTINGS =
222 "android.settings.DATE_SETTINGS";
223
224 /**
225 * Activity Action: Show settings to allow configuration of sound and volume.
226 * <p>
227 * In some cases, a matching Activity may not exist, so ensure you
228 * safeguard against this.
229 * <p>
230 * Input: Nothing.
231 * <p>
232 * Output: Nothing.
233 */
234 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
235 public static final String ACTION_SOUND_SETTINGS =
236 "android.settings.SOUND_SETTINGS";
237
238 /**
239 * Activity Action: Show settings to allow configuration of display.
240 * <p>
241 * In some cases, a matching Activity may not exist, so ensure you
242 * safeguard against this.
243 * <p>
244 * Input: Nothing.
245 * <p>
246 * Output: Nothing.
247 */
248 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
249 public static final String ACTION_DISPLAY_SETTINGS =
250 "android.settings.DISPLAY_SETTINGS";
251
252 /**
253 * Activity Action: Show settings to allow configuration of locale.
254 * <p>
255 * In some cases, a matching Activity may not exist, so ensure you
256 * safeguard against this.
257 * <p>
258 * Input: Nothing.
259 * <p>
260 * Output: Nothing.
261 */
262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
263 public static final String ACTION_LOCALE_SETTINGS =
264 "android.settings.LOCALE_SETTINGS";
265
266 /**
267 * Activity Action: Show settings to configure input methods, in particular
268 * allowing the user to enable input methods.
269 * <p>
270 * In some cases, a matching Activity may not exist, so ensure you
271 * safeguard against this.
272 * <p>
273 * Input: Nothing.
274 * <p>
275 * Output: Nothing.
276 */
277 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
278 public static final String ACTION_INPUT_METHOD_SETTINGS =
279 "android.settings.INPUT_METHOD_SETTINGS";
280
281 /**
Tadashi G. Takaokaf49688f2011-01-20 17:56:13 +0900282 * Activity Action: Show settings to enable/disable input method subtypes.
satok86417ea2010-10-27 14:11:03 +0900283 * <p>
284 * In some cases, a matching Activity may not exist, so ensure you
285 * safeguard against this.
286 * <p>
Tadashi G. Takaoka25480202011-01-20 23:13:02 +0900287 * To tell which input method's subtypes are displayed in the settings, add
288 * {@link #EXTRA_INPUT_METHOD_ID} extra to this Intent with the input method id.
289 * If there is no extra in this Intent, subtypes from all installed input methods
290 * will be displayed in the settings.
291 *
292 * @see android.view.inputmethod.InputMethodInfo#getId
293 * <p>
satok86417ea2010-10-27 14:11:03 +0900294 * Input: Nothing.
295 * <p>
296 * Output: Nothing.
297 */
298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Tadashi G. Takaokaf49688f2011-01-20 17:56:13 +0900299 public static final String ACTION_INPUT_METHOD_SUBTYPE_SETTINGS =
300 "android.settings.INPUT_METHOD_SUBTYPE_SETTINGS";
satok86417ea2010-10-27 14:11:03 +0900301
302 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800303 * Activity Action: Show settings to manage the user input dictionary.
304 * <p>
305 * In some cases, a matching Activity may not exist, so ensure you
306 * safeguard against this.
307 * <p>
308 * Input: Nothing.
309 * <p>
310 * Output: Nothing.
311 */
312 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
313 public static final String ACTION_USER_DICTIONARY_SETTINGS =
314 "android.settings.USER_DICTIONARY_SETTINGS";
315
316 /**
317 * Activity Action: Show settings to allow configuration of application-related settings.
318 * <p>
319 * In some cases, a matching Activity may not exist, so ensure you
320 * safeguard against this.
321 * <p>
322 * Input: Nothing.
323 * <p>
324 * Output: Nothing.
325 */
326 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
327 public static final String ACTION_APPLICATION_SETTINGS =
328 "android.settings.APPLICATION_SETTINGS";
329
330 /**
331 * Activity Action: Show settings to allow configuration of application
332 * development-related settings.
333 * <p>
334 * In some cases, a matching Activity may not exist, so ensure you safeguard
335 * against this.
336 * <p>
337 * Input: Nothing.
338 * <p>
339 * Output: Nothing.
340 */
341 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
342 public static final String ACTION_APPLICATION_DEVELOPMENT_SETTINGS =
343 "android.settings.APPLICATION_DEVELOPMENT_SETTINGS";
344
345 /**
346 * Activity Action: Show settings to allow configuration of quick launch shortcuts.
347 * <p>
348 * In some cases, a matching Activity may not exist, so ensure you
349 * safeguard against this.
350 * <p>
351 * Input: Nothing.
352 * <p>
353 * Output: Nothing.
354 */
355 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
356 public static final String ACTION_QUICK_LAUNCH_SETTINGS =
357 "android.settings.QUICK_LAUNCH_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700358
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800359 /**
360 * Activity Action: Show settings to manage installed applications.
361 * <p>
362 * In some cases, a matching Activity may not exist, so ensure you
363 * safeguard against this.
364 * <p>
365 * Input: Nothing.
366 * <p>
367 * Output: Nothing.
368 */
369 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
370 public static final String ACTION_MANAGE_APPLICATIONS_SETTINGS =
371 "android.settings.MANAGE_APPLICATIONS_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700372
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800373 /**
Winson Chung44e8ff92010-09-27 14:36:52 -0700374 * Activity Action: Show settings to manage all applications.
375 * <p>
376 * In some cases, a matching Activity may not exist, so ensure you
377 * safeguard against this.
378 * <p>
379 * Input: Nothing.
380 * <p>
381 * Output: Nothing.
382 */
383 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
384 public static final String ACTION_MANAGE_ALL_APPLICATIONS_SETTINGS =
385 "android.settings.MANAGE_ALL_APPLICATIONS_SETTINGS";
386
387 /**
Dianne Hackbornb7bb3b32010-06-06 22:47:50 -0700388 * Activity Action: Show screen of details about a particular application.
389 * <p>
390 * In some cases, a matching Activity may not exist, so ensure you
391 * safeguard against this.
392 * <p>
393 * Input: The Intent's data URI specifies the application package name
394 * to be shown, with the "package" scheme. That is "package:com.my.app".
395 * <p>
396 * Output: Nothing.
397 */
398 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
399 public static final String ACTION_APPLICATION_DETAILS_SETTINGS =
400 "android.settings.APPLICATION_DETAILS_SETTINGS";
401
402 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800403 * Activity Action: Show settings for system update functionality.
404 * <p>
405 * In some cases, a matching Activity may not exist, so ensure you
406 * safeguard against this.
407 * <p>
408 * Input: Nothing.
409 * <p>
410 * Output: Nothing.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700411 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800412 * @hide
413 */
414 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
415 public static final String ACTION_SYSTEM_UPDATE_SETTINGS =
416 "android.settings.SYSTEM_UPDATE_SETTINGS";
417
418 /**
419 * Activity Action: Show settings to allow configuration of sync settings.
420 * <p>
421 * In some cases, a matching Activity may not exist, so ensure you
422 * safeguard against this.
423 * <p>
Erikeebc8e22010-02-18 13:27:19 -0800424 * The account types available to add via the add account button may be restricted by adding an
425 * {@link #EXTRA_AUTHORITIES} extra to this Intent with one or more syncable content provider's
426 * authorities. Only account types which can sync with that content provider will be offered to
427 * the user.
428 * <p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800429 * Input: Nothing.
430 * <p>
431 * Output: Nothing.
432 */
433 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
434 public static final String ACTION_SYNC_SETTINGS =
435 "android.settings.SYNC_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700436
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800437 /**
Erikeebc8e22010-02-18 13:27:19 -0800438 * Activity Action: Show add account screen for creating a new account.
439 * <p>
440 * In some cases, a matching Activity may not exist, so ensure you
441 * safeguard against this.
442 * <p>
443 * The account types available to add may be restricted by adding an {@link #EXTRA_AUTHORITIES}
444 * extra to the Intent with one or more syncable content provider's authorities. Only account
445 * types which can sync with that content provider will be offered to the user.
446 * <p>
447 * Input: Nothing.
448 * <p>
449 * Output: Nothing.
450 */
451 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
452 public static final String ACTION_ADD_ACCOUNT =
453 "android.settings.ADD_ACCOUNT_SETTINGS";
454
455 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800456 * Activity Action: Show settings for selecting the network operator.
457 * <p>
458 * In some cases, a matching Activity may not exist, so ensure you
459 * safeguard against this.
460 * <p>
461 * Input: Nothing.
462 * <p>
463 * Output: Nothing.
464 */
465 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
466 public static final String ACTION_NETWORK_OPERATOR_SETTINGS =
467 "android.settings.NETWORK_OPERATOR_SETTINGS";
468
469 /**
470 * Activity Action: Show settings for selection of 2G/3G.
471 * <p>
472 * In some cases, a matching Activity may not exist, so ensure you
473 * safeguard against this.
474 * <p>
475 * Input: Nothing.
476 * <p>
477 * Output: Nothing.
478 */
479 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
480 public static final String ACTION_DATA_ROAMING_SETTINGS =
481 "android.settings.DATA_ROAMING_SETTINGS";
482
483 /**
484 * Activity Action: Show settings for internal storage.
485 * <p>
486 * In some cases, a matching Activity may not exist, so ensure you
487 * safeguard against this.
488 * <p>
489 * Input: Nothing.
490 * <p>
491 * Output: Nothing.
492 */
493 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
494 public static final String ACTION_INTERNAL_STORAGE_SETTINGS =
495 "android.settings.INTERNAL_STORAGE_SETTINGS";
496 /**
497 * Activity Action: Show settings for memory card storage.
498 * <p>
499 * In some cases, a matching Activity may not exist, so ensure you
500 * safeguard against this.
501 * <p>
502 * Input: Nothing.
503 * <p>
504 * Output: Nothing.
505 */
506 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
507 public static final String ACTION_MEMORY_CARD_SETTINGS =
508 "android.settings.MEMORY_CARD_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700509
Justin Mattsonef340352010-01-13 21:05:46 -0800510 /**
511 * Activity Action: Show settings for global search.
512 * <p>
513 * In some cases, a matching Activity may not exist, so ensure you
514 * safeguard against this.
515 * <p>
516 * Input: Nothing.
517 * <p>
518 * Output: Nothing
519 */
520 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
521 public static final String ACTION_SEARCH_SETTINGS =
522 "android.search.action.SEARCH_SETTINGS";
523
Daniel Sandler9d8b8762010-01-22 20:50:15 -0500524 /**
525 * Activity Action: Show general device information settings (serial
526 * number, software version, phone number, etc.).
527 * <p>
528 * In some cases, a matching Activity may not exist, so ensure you
529 * safeguard against this.
530 * <p>
531 * Input: Nothing.
532 * <p>
533 * Output: Nothing
534 */
535 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
536 public static final String ACTION_DEVICE_INFO_SETTINGS =
537 "android.settings.DEVICE_INFO_SETTINGS";
538
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 // End of Intent actions for Settings
540
Erikeebc8e22010-02-18 13:27:19 -0800541 /**
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800542 * @hide - Private call() method on SettingsProvider to read from 'system' table.
543 */
544 public static final String CALL_METHOD_GET_SYSTEM = "GET_system";
545
546 /**
547 * @hide - Private call() method on SettingsProvider to read from 'secure' table.
548 */
549 public static final String CALL_METHOD_GET_SECURE = "GET_secure";
550
551 /**
Erikeebc8e22010-02-18 13:27:19 -0800552 * Activity Extra: Limit available options in launched activity based on the given authority.
553 * <p>
554 * This can be passed as an extra field in an Activity Intent with one or more syncable content
555 * provider's authorities as a String[]. This field is used by some intents to alter the
556 * behavior of the called activity.
557 * <p>
558 * Example: The {@link #ACTION_ADD_ACCOUNT} intent restricts the account types available based
559 * on the authority given.
560 */
561 public static final String EXTRA_AUTHORITIES =
562 "authorities";
563
Tadashi G. Takaoka25480202011-01-20 23:13:02 +0900564 public static final String EXTRA_INPUT_METHOD_ID = "input_method_id";
565
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800566 private static final String JID_RESOURCE_PREFIX = "android";
567
568 public static final String AUTHORITY = "settings";
569
570 private static final String TAG = "Settings";
Joe Onorato43a17652011-04-06 19:22:23 -0700571 private static final boolean LOCAL_LOGV = false || false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800572
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800573 public static class SettingNotFoundException extends AndroidException {
574 public SettingNotFoundException(String msg) {
575 super(msg);
576 }
577 }
578
579 /**
580 * Common base for tables of name/value settings.
581 */
582 public static class NameValueTable implements BaseColumns {
583 public static final String NAME = "name";
584 public static final String VALUE = "value";
585
586 protected static boolean putString(ContentResolver resolver, Uri uri,
587 String name, String value) {
588 // The database will take care of replacing duplicates.
589 try {
590 ContentValues values = new ContentValues();
591 values.put(NAME, name);
592 values.put(VALUE, value);
593 resolver.insert(uri, values);
594 return true;
595 } catch (SQLException e) {
Dianne Hackborna33e3f72009-09-29 17:28:24 -0700596 Log.w(TAG, "Can't set key " + name + " in " + uri, e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800597 return false;
598 }
599 }
600
601 public static Uri getUriFor(Uri uri, String name) {
602 return Uri.withAppendedPath(uri, name);
603 }
604 }
605
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800606 // Thread-safe.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800607 private static class NameValueCache {
608 private final String mVersionSystemProperty;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800609 private final Uri mUri;
610
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800611 private static final String[] SELECT_VALUE =
612 new String[] { Settings.NameValueTable.VALUE };
613 private static final String NAME_EQ_PLACEHOLDER = "name=?";
614
615 // Must synchronize on 'this' to access mValues and mValuesVersion.
Dan Egnor799f7212009-11-24 16:24:44 -0800616 private final HashMap<String, String> mValues = new HashMap<String, String>();
617 private long mValuesVersion = 0;
618
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800619 // Initially null; set lazily and held forever. Synchronized on 'this'.
620 private IContentProvider mContentProvider = null;
621
622 // The method we'll call (or null, to not use) on the provider
623 // for the fast path of retrieving settings.
624 private final String mCallCommand;
625
626 public NameValueCache(String versionSystemProperty, Uri uri, String callCommand) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800627 mVersionSystemProperty = versionSystemProperty;
628 mUri = uri;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800629 mCallCommand = callCommand;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800630 }
631
Dan Egnor799f7212009-11-24 16:24:44 -0800632 public String getString(ContentResolver cr, String name) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800633 long newValuesVersion = SystemProperties.getLong(mVersionSystemProperty, 0);
Dan Egnor799f7212009-11-24 16:24:44 -0800634
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800635 synchronized (this) {
Dan Egnor799f7212009-11-24 16:24:44 -0800636 if (mValuesVersion != newValuesVersion) {
637 if (LOCAL_LOGV) {
638 Log.v(TAG, "invalidate [" + mUri.getLastPathSegment() + "]: current " +
639 newValuesVersion + " != cached " + mValuesVersion);
640 }
641
642 mValues.clear();
643 mValuesVersion = newValuesVersion;
644 }
645
646 if (mValues.containsKey(name)) {
647 return mValues.get(name); // Could be null, that's OK -- negative caching
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800648 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800649 }
Dan Egnor799f7212009-11-24 16:24:44 -0800650
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800651 IContentProvider cp = null;
652 synchronized (this) {
653 cp = mContentProvider;
654 if (cp == null) {
655 cp = mContentProvider = cr.acquireProvider(mUri.getAuthority());
656 }
657 }
658
659 // Try the fast path first, not using query(). If this
660 // fails (alternate Settings provider that doesn't support
661 // this interface?) then we fall back to the query/table
662 // interface.
663 if (mCallCommand != null) {
664 try {
665 Bundle b = cp.call(mCallCommand, name, null);
666 if (b != null) {
667 String value = b.getPairValue();
668 synchronized (this) {
669 mValues.put(name, value);
670 }
671 return value;
672 }
673 // If the response Bundle is null, we fall through
674 // to the query interface below.
675 } catch (RemoteException e) {
676 // Not supported by the remote side? Fall through
677 // to query().
678 }
679 }
680
Dan Egnor799f7212009-11-24 16:24:44 -0800681 Cursor c = null;
682 try {
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800683 c = cp.query(mUri, SELECT_VALUE, NAME_EQ_PLACEHOLDER,
684 new String[]{name}, null);
Dan Egnor799f7212009-11-24 16:24:44 -0800685 if (c == null) {
686 Log.w(TAG, "Can't get key " + name + " from " + mUri);
687 return null;
688 }
689
690 String value = c.moveToNext() ? c.getString(0) : null;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800691 synchronized (this) {
Dan Egnor799f7212009-11-24 16:24:44 -0800692 mValues.put(name, value);
693 }
694 if (LOCAL_LOGV) {
695 Log.v(TAG, "cache miss [" + mUri.getLastPathSegment() + "]: " +
696 name + " = " + (value == null ? "(null)" : value));
697 }
698 return value;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800699 } catch (RemoteException e) {
Dan Egnor799f7212009-11-24 16:24:44 -0800700 Log.w(TAG, "Can't get key " + name + " from " + mUri, e);
701 return null; // Return null, but don't cache it.
702 } finally {
703 if (c != null) c.close();
704 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800705 }
706 }
707
708 /**
709 * System settings, containing miscellaneous system preferences. This
710 * table holds simple name/value pairs. There are convenience
711 * functions for accessing individual settings entries.
712 */
713 public static final class System extends NameValueTable {
714 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_system_version";
715
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800716 // Populated lazily, guarded by class object:
717 private static NameValueCache sNameValueCache = null;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700718
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800719 private static final HashSet<String> MOVED_TO_SECURE;
720 static {
721 MOVED_TO_SECURE = new HashSet<String>(30);
722 MOVED_TO_SECURE.add(Secure.ADB_ENABLED);
723 MOVED_TO_SECURE.add(Secure.ANDROID_ID);
724 MOVED_TO_SECURE.add(Secure.BLUETOOTH_ON);
725 MOVED_TO_SECURE.add(Secure.DATA_ROAMING);
726 MOVED_TO_SECURE.add(Secure.DEVICE_PROVISIONED);
727 MOVED_TO_SECURE.add(Secure.HTTP_PROXY);
728 MOVED_TO_SECURE.add(Secure.INSTALL_NON_MARKET_APPS);
729 MOVED_TO_SECURE.add(Secure.LOCATION_PROVIDERS_ALLOWED);
Amith Yamasani156c4352010-03-05 17:10:03 -0800730 MOVED_TO_SECURE.add(Secure.LOCK_PATTERN_ENABLED);
731 MOVED_TO_SECURE.add(Secure.LOCK_PATTERN_VISIBLE);
732 MOVED_TO_SECURE.add(Secure.LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800733 MOVED_TO_SECURE.add(Secure.LOGGING_ID);
734 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_ENABLED);
735 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_LAST_UPDATE);
736 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_REDIRECT_URL);
737 MOVED_TO_SECURE.add(Secure.SETTINGS_CLASSNAME);
738 MOVED_TO_SECURE.add(Secure.USB_MASS_STORAGE_ENABLED);
739 MOVED_TO_SECURE.add(Secure.USE_GOOGLE_MAIL);
740 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON);
741 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY);
742 MOVED_TO_SECURE.add(Secure.WIFI_NUM_OPEN_NETWORKS_KEPT);
743 MOVED_TO_SECURE.add(Secure.WIFI_ON);
744 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE);
745 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_AP_COUNT);
746 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS);
747 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED);
748 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS);
749 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT);
750 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_MAX_AP_CHECKS);
751 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ON);
752 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_COUNT);
753 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_DELAY_MS);
754 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS);
755 }
756
757 /**
758 * Look up a name in the database.
759 * @param resolver to access the database with
760 * @param name to look up in the table
761 * @return the corresponding value, or null if not present
762 */
763 public synchronized static String getString(ContentResolver resolver, String name) {
764 if (MOVED_TO_SECURE.contains(name)) {
765 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
766 + " to android.provider.Settings.Secure, returning read-only value.");
767 return Secure.getString(resolver, name);
768 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800769 if (sNameValueCache == null) {
770 sNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI,
771 CALL_METHOD_GET_SYSTEM);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800772 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800773 return sNameValueCache.getString(resolver, name);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800774 }
775
776 /**
777 * Store a name/value pair into the database.
778 * @param resolver to access the database with
779 * @param name to store
780 * @param value to associate with the name
781 * @return true if the value was set, false on database errors
782 */
783 public static boolean putString(ContentResolver resolver, String name, String value) {
784 if (MOVED_TO_SECURE.contains(name)) {
785 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
786 + " to android.provider.Settings.Secure, value is unchanged.");
787 return false;
788 }
789 return putString(resolver, CONTENT_URI, name, value);
790 }
791
792 /**
793 * Construct the content URI for a particular name/value pair,
794 * useful for monitoring changes with a ContentObserver.
795 * @param name to look up in the table
796 * @return the corresponding content URI, or null if not present
797 */
798 public static Uri getUriFor(String name) {
799 if (MOVED_TO_SECURE.contains(name)) {
800 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
801 + " to android.provider.Settings.Secure, returning Secure URI.");
802 return Secure.getUriFor(Secure.CONTENT_URI, name);
803 }
804 return getUriFor(CONTENT_URI, name);
805 }
806
807 /**
808 * Convenience function for retrieving a single system settings value
809 * as an integer. Note that internally setting values are always
810 * stored as strings; this function converts the string to an integer
811 * for you. The default value will be returned if the setting is
812 * not defined or not an integer.
813 *
814 * @param cr The ContentResolver to access.
815 * @param name The name of the setting to retrieve.
816 * @param def Value to return if the setting is not defined.
817 *
818 * @return The setting's current value, or 'def' if it is not defined
819 * or not a valid integer.
820 */
821 public static int getInt(ContentResolver cr, String name, int def) {
822 String v = getString(cr, name);
823 try {
824 return v != null ? Integer.parseInt(v) : def;
825 } catch (NumberFormatException e) {
826 return def;
827 }
828 }
829
830 /**
831 * Convenience function for retrieving a single system settings value
832 * as an integer. Note that internally setting values are always
833 * stored as strings; this function converts the string to an integer
834 * for you.
835 * <p>
836 * This version does not take a default value. If the setting has not
837 * been set, or the string value is not a number,
838 * it throws {@link SettingNotFoundException}.
839 *
840 * @param cr The ContentResolver to access.
841 * @param name The name of the setting to retrieve.
842 *
843 * @throws SettingNotFoundException Thrown if a setting by the given
844 * name can't be found or the setting value is not an integer.
845 *
846 * @return The setting's current value.
847 */
848 public static int getInt(ContentResolver cr, String name)
849 throws SettingNotFoundException {
850 String v = getString(cr, name);
851 try {
852 return Integer.parseInt(v);
853 } catch (NumberFormatException e) {
854 throw new SettingNotFoundException(name);
855 }
856 }
857
858 /**
859 * Convenience function for updating a single settings value as an
860 * integer. This will either create a new entry in the table if the
861 * given name does not exist, or modify the value of the existing row
862 * with that name. Note that internally setting values are always
863 * stored as strings, so this function converts the given value to a
864 * string before storing it.
865 *
866 * @param cr The ContentResolver to access.
867 * @param name The name of the setting to modify.
868 * @param value The new value for the setting.
869 * @return true if the value was set, false on database errors
870 */
871 public static boolean putInt(ContentResolver cr, String name, int value) {
872 return putString(cr, name, Integer.toString(value));
873 }
874
875 /**
876 * Convenience function for retrieving a single system settings value
877 * as a {@code long}. Note that internally setting values are always
878 * stored as strings; this function converts the string to a {@code long}
879 * for you. The default value will be returned if the setting is
880 * not defined or not a {@code long}.
881 *
882 * @param cr The ContentResolver to access.
883 * @param name The name of the setting to retrieve.
884 * @param def Value to return if the setting is not defined.
885 *
886 * @return The setting's current value, or 'def' if it is not defined
887 * or not a valid {@code long}.
888 */
889 public static long getLong(ContentResolver cr, String name, long def) {
890 String valString = getString(cr, name);
891 long value;
892 try {
893 value = valString != null ? Long.parseLong(valString) : def;
894 } catch (NumberFormatException e) {
895 value = def;
896 }
897 return value;
898 }
899
900 /**
901 * Convenience function for retrieving a single system settings value
902 * as a {@code long}. Note that internally setting values are always
903 * stored as strings; this function converts the string to a {@code long}
904 * for you.
905 * <p>
906 * This version does not take a default value. If the setting has not
907 * been set, or the string value is not a number,
908 * it throws {@link SettingNotFoundException}.
909 *
910 * @param cr The ContentResolver to access.
911 * @param name The name of the setting to retrieve.
912 *
913 * @return The setting's current value.
914 * @throws SettingNotFoundException Thrown if a setting by the given
915 * name can't be found or the setting value is not an integer.
916 */
917 public static long getLong(ContentResolver cr, String name)
918 throws SettingNotFoundException {
919 String valString = getString(cr, name);
920 try {
921 return Long.parseLong(valString);
922 } catch (NumberFormatException e) {
923 throw new SettingNotFoundException(name);
924 }
925 }
926
927 /**
928 * Convenience function for updating a single settings value as a long
929 * integer. This will either create a new entry in the table if the
930 * given name does not exist, or modify the value of the existing row
931 * with that name. Note that internally setting values are always
932 * stored as strings, so this function converts the given value to a
933 * string before storing it.
934 *
935 * @param cr The ContentResolver to access.
936 * @param name The name of the setting to modify.
937 * @param value The new value for the setting.
938 * @return true if the value was set, false on database errors
939 */
940 public static boolean putLong(ContentResolver cr, String name, long value) {
941 return putString(cr, name, Long.toString(value));
942 }
943
944 /**
945 * Convenience function for retrieving a single system settings value
946 * as a floating point number. Note that internally setting values are
947 * always stored as strings; this function converts the string to an
948 * float for you. The default value will be returned if the setting
949 * is not defined or not a valid float.
950 *
951 * @param cr The ContentResolver to access.
952 * @param name The name of the setting to retrieve.
953 * @param def Value to return if the setting is not defined.
954 *
955 * @return The setting's current value, or 'def' if it is not defined
956 * or not a valid float.
957 */
958 public static float getFloat(ContentResolver cr, String name, float def) {
959 String v = getString(cr, name);
960 try {
961 return v != null ? Float.parseFloat(v) : def;
962 } catch (NumberFormatException e) {
963 return def;
964 }
965 }
966
967 /**
968 * Convenience function for retrieving a single system settings value
969 * as a float. Note that internally setting values are always
970 * stored as strings; this function converts the string to a float
971 * for you.
972 * <p>
973 * This version does not take a default value. If the setting has not
974 * been set, or the string value is not a number,
975 * it throws {@link SettingNotFoundException}.
976 *
977 * @param cr The ContentResolver to access.
978 * @param name The name of the setting to retrieve.
979 *
980 * @throws SettingNotFoundException Thrown if a setting by the given
981 * name can't be found or the setting value is not a float.
982 *
983 * @return The setting's current value.
984 */
985 public static float getFloat(ContentResolver cr, String name)
986 throws SettingNotFoundException {
987 String v = getString(cr, name);
Brian Muramatsue1d46982010-12-06 17:34:20 -0800988 if (v == null) {
989 throw new SettingNotFoundException(name);
990 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800991 try {
992 return Float.parseFloat(v);
993 } catch (NumberFormatException e) {
994 throw new SettingNotFoundException(name);
995 }
996 }
997
998 /**
999 * Convenience function for updating a single settings value as a
1000 * floating point number. This will either create a new entry in the
1001 * table if the given name does not exist, or modify the value of the
1002 * existing row with that name. Note that internally setting values
1003 * are always stored as strings, so this function converts the given
1004 * value to a string before storing it.
1005 *
1006 * @param cr The ContentResolver to access.
1007 * @param name The name of the setting to modify.
1008 * @param value The new value for the setting.
1009 * @return true if the value was set, false on database errors
1010 */
1011 public static boolean putFloat(ContentResolver cr, String name, float value) {
1012 return putString(cr, name, Float.toString(value));
1013 }
1014
1015 /**
1016 * Convenience function to read all of the current
1017 * configuration-related settings into a
1018 * {@link Configuration} object.
1019 *
1020 * @param cr The ContentResolver to access.
1021 * @param outConfig Where to place the configuration settings.
1022 */
1023 public static void getConfiguration(ContentResolver cr, Configuration outConfig) {
1024 outConfig.fontScale = Settings.System.getFloat(
1025 cr, FONT_SCALE, outConfig.fontScale);
1026 if (outConfig.fontScale < 0) {
1027 outConfig.fontScale = 1;
1028 }
1029 }
1030
1031 /**
1032 * Convenience function to write a batch of configuration-related
1033 * settings from a {@link Configuration} object.
1034 *
1035 * @param cr The ContentResolver to access.
1036 * @param config The settings to write.
1037 * @return true if the values were set, false on database errors
1038 */
1039 public static boolean putConfiguration(ContentResolver cr, Configuration config) {
1040 return Settings.System.putFloat(cr, FONT_SCALE, config.fontScale);
1041 }
1042
Dianne Hackbornb8b11a02010-03-10 15:53:11 -08001043 /** @hide */
1044 public static boolean hasInterestingConfigurationChanges(int changes) {
1045 return (changes&ActivityInfo.CONFIG_FONT_SCALE) != 0;
1046 }
Jaikumar Ganesh545e6702010-06-04 10:23:03 -07001047
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001048 public static boolean getShowGTalkServiceStatus(ContentResolver cr) {
1049 return getInt(cr, SHOW_GTALK_SERVICE_STATUS, 0) != 0;
1050 }
1051
1052 public static void setShowGTalkServiceStatus(ContentResolver cr, boolean flag) {
1053 putInt(cr, SHOW_GTALK_SERVICE_STATUS, flag ? 1 : 0);
1054 }
1055
1056 /**
1057 * The content:// style URL for this table
1058 */
1059 public static final Uri CONTENT_URI =
1060 Uri.parse("content://" + AUTHORITY + "/system");
1061
1062 /**
1063 * Whether we keep the device on while the device is plugged in.
1064 * Supported values are:
1065 * <ul>
1066 * <li>{@code 0} to never stay on while plugged in</li>
1067 * <li>{@link BatteryManager#BATTERY_PLUGGED_AC} to stay on for AC charger</li>
1068 * <li>{@link BatteryManager#BATTERY_PLUGGED_USB} to stay on for USB charger</li>
1069 * </ul>
1070 * These values can be OR-ed together.
1071 */
1072 public static final String STAY_ON_WHILE_PLUGGED_IN = "stay_on_while_plugged_in";
1073
1074 /**
1075 * What happens when the user presses the end call button if they're not
1076 * on a call.<br/>
1077 * <b>Values:</b><br/>
1078 * 0 - The end button does nothing.<br/>
1079 * 1 - The end button goes to the home screen.<br/>
1080 * 2 - The end button puts the device to sleep and locks the keyguard.<br/>
1081 * 3 - The end button goes to the home screen. If the user is already on the
1082 * home screen, it puts the device to sleep.
1083 */
1084 public static final String END_BUTTON_BEHAVIOR = "end_button_behavior";
1085
1086 /**
David Brown458e8062010-03-08 21:52:11 -08001087 * END_BUTTON_BEHAVIOR value for "go home".
1088 * @hide
1089 */
1090 public static final int END_BUTTON_BEHAVIOR_HOME = 0x1;
1091
1092 /**
1093 * END_BUTTON_BEHAVIOR value for "go to sleep".
1094 * @hide
1095 */
1096 public static final int END_BUTTON_BEHAVIOR_SLEEP = 0x2;
1097
1098 /**
1099 * END_BUTTON_BEHAVIOR default value.
1100 * @hide
1101 */
1102 public static final int END_BUTTON_BEHAVIOR_DEFAULT = END_BUTTON_BEHAVIOR_SLEEP;
1103
1104 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07001105 * Is advanced settings mode turned on. 0 == no, 1 == yes
1106 * @hide
1107 */
1108 public static final String ADVANCED_SETTINGS = "advanced_settings";
1109
1110 /**
1111 * ADVANCED_SETTINGS default value.
1112 * @hide
1113 */
1114 public static final int ADVANCED_SETTINGS_DEFAULT = 0;
1115
1116 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001117 * Whether Airplane Mode is on.
1118 */
1119 public static final String AIRPLANE_MODE_ON = "airplane_mode_on";
1120
1121 /**
1122 * Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.
1123 */
1124 public static final String RADIO_BLUETOOTH = "bluetooth";
1125
1126 /**
1127 * Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.
1128 */
1129 public static final String RADIO_WIFI = "wifi";
1130
1131 /**
1132 * Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.
1133 */
1134 public static final String RADIO_CELL = "cell";
1135
1136 /**
1137 * A comma separated list of radios that need to be disabled when airplane mode
1138 * is on. This overrides WIFI_ON and BLUETOOTH_ON, if Wi-Fi and bluetooth are
1139 * included in the comma separated list.
1140 */
1141 public static final String AIRPLANE_MODE_RADIOS = "airplane_mode_radios";
1142
1143 /**
Mike Lockwoodbd5ddf02009-07-29 21:37:14 -07001144 * A comma separated list of radios that should to be disabled when airplane mode
1145 * is on, but can be manually reenabled by the user. For example, if RADIO_WIFI is
1146 * added to both AIRPLANE_MODE_RADIOS and AIRPLANE_MODE_TOGGLEABLE_RADIOS, then Wifi
1147 * will be turned off when entering airplane mode, but the user will be able to reenable
1148 * Wifi in the Settings app.
1149 *
1150 * {@hide}
1151 */
1152 public static final String AIRPLANE_MODE_TOGGLEABLE_RADIOS = "airplane_mode_toggleable_radios";
1153
1154 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001155 * The policy for deciding when Wi-Fi should go to sleep (which will in
1156 * turn switch to using the mobile data as an Internet connection).
1157 * <p>
1158 * Set to one of {@link #WIFI_SLEEP_POLICY_DEFAULT},
1159 * {@link #WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED}, or
1160 * {@link #WIFI_SLEEP_POLICY_NEVER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001161 */
1162 public static final String WIFI_SLEEP_POLICY = "wifi_sleep_policy";
1163
1164 /**
1165 * Value for {@link #WIFI_SLEEP_POLICY} to use the default Wi-Fi sleep
1166 * policy, which is to sleep shortly after the turning off
1167 * according to the {@link #STAY_ON_WHILE_PLUGGED_IN} setting.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001168 */
1169 public static final int WIFI_SLEEP_POLICY_DEFAULT = 0;
1170
1171 /**
1172 * Value for {@link #WIFI_SLEEP_POLICY} to use the default policy when
1173 * the device is on battery, and never go to sleep when the device is
1174 * plugged in.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001175 */
1176 public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED = 1;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001177
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001178 /**
1179 * Value for {@link #WIFI_SLEEP_POLICY} to never go to sleep.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001180 */
1181 public static final int WIFI_SLEEP_POLICY_NEVER = 2;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001182
Irfan Sheriff31b62322010-08-30 12:26:00 -07001183 //TODO: deprecate static IP constants
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001184 /**
1185 * Whether to use static IP and other static network attributes.
1186 * <p>
1187 * Set to 1 for true and 0 for false.
1188 */
1189 public static final String WIFI_USE_STATIC_IP = "wifi_use_static_ip";
1190
1191 /**
1192 * The static IP address.
1193 * <p>
1194 * Example: "192.168.1.51"
1195 */
1196 public static final String WIFI_STATIC_IP = "wifi_static_ip";
1197
1198 /**
1199 * If using static IP, the gateway's IP address.
1200 * <p>
1201 * Example: "192.168.1.1"
1202 */
1203 public static final String WIFI_STATIC_GATEWAY = "wifi_static_gateway";
1204
1205 /**
1206 * If using static IP, the net mask.
1207 * <p>
1208 * Example: "255.255.255.0"
1209 */
1210 public static final String WIFI_STATIC_NETMASK = "wifi_static_netmask";
1211
1212 /**
1213 * If using static IP, the primary DNS's IP address.
1214 * <p>
1215 * Example: "192.168.1.1"
1216 */
1217 public static final String WIFI_STATIC_DNS1 = "wifi_static_dns1";
1218
1219 /**
1220 * If using static IP, the secondary DNS's IP address.
1221 * <p>
1222 * Example: "192.168.1.2"
1223 */
1224 public static final String WIFI_STATIC_DNS2 = "wifi_static_dns2";
1225
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001226
1227 /**
1228 * Determines whether remote devices may discover and/or connect to
1229 * this device.
1230 * <P>Type: INT</P>
1231 * 2 -- discoverable and connectable
1232 * 1 -- connectable but not discoverable
1233 * 0 -- neither connectable nor discoverable
1234 */
1235 public static final String BLUETOOTH_DISCOVERABILITY =
1236 "bluetooth_discoverability";
1237
1238 /**
1239 * Bluetooth discoverability timeout. If this value is nonzero, then
1240 * Bluetooth becomes discoverable for a certain number of seconds,
1241 * after which is becomes simply connectable. The value is in seconds.
1242 */
1243 public static final String BLUETOOTH_DISCOVERABILITY_TIMEOUT =
1244 "bluetooth_discoverability_timeout";
1245
1246 /**
Amith Yamasani156c4352010-03-05 17:10:03 -08001247 * @deprecated Use {@link android.provider.Settings.Secure#LOCK_PATTERN_ENABLED}
1248 * instead
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001249 */
Amith Yamasani156c4352010-03-05 17:10:03 -08001250 @Deprecated
1251 public static final String LOCK_PATTERN_ENABLED = Secure.LOCK_PATTERN_ENABLED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001252
1253 /**
Amith Yamasani156c4352010-03-05 17:10:03 -08001254 * @deprecated Use {@link android.provider.Settings.Secure#LOCK_PATTERN_VISIBLE}
1255 * instead
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001256 */
Amith Yamasani156c4352010-03-05 17:10:03 -08001257 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001258 public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
1259
1260 /**
Jaikumar Ganesh545e6702010-06-04 10:23:03 -07001261 * @deprecated Use
Amith Yamasani156c4352010-03-05 17:10:03 -08001262 * {@link android.provider.Settings.Secure#LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED}
1263 * instead
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001264 */
Amith Yamasani156c4352010-03-05 17:10:03 -08001265 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001266 public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
1267 "lock_pattern_tactile_feedback_enabled";
1268
1269
1270 /**
1271 * A formatted string of the next alarm that is set, or the empty string
1272 * if there is no alarm set.
1273 */
1274 public static final String NEXT_ALARM_FORMATTED = "next_alarm_formatted";
1275
1276 /**
1277 * Scaling factor for fonts, float.
1278 */
1279 public static final String FONT_SCALE = "font_scale";
1280
1281 /**
1282 * Name of an application package to be debugged.
1283 */
1284 public static final String DEBUG_APP = "debug_app";
1285
1286 /**
1287 * If 1, when launching DEBUG_APP it will wait for the debugger before
1288 * starting user code. If 0, it will run normally.
1289 */
1290 public static final String WAIT_FOR_DEBUGGER = "wait_for_debugger";
1291
1292 /**
1293 * Whether or not to dim the screen. 0=no 1=yes
1294 */
1295 public static final String DIM_SCREEN = "dim_screen";
1296
1297 /**
1298 * The timeout before the screen turns off.
1299 */
1300 public static final String SCREEN_OFF_TIMEOUT = "screen_off_timeout";
1301
1302 /**
Mitsuru Oshimae5fb3282009-06-09 21:16:08 -07001303 * If 0, the compatibility mode is off for all applications.
1304 * If 1, older applications run under compatibility mode.
1305 * TODO: remove this settings before code freeze (bug/1907571)
1306 * @hide
1307 */
1308 public static final String COMPATIBILITY_MODE = "compatibility_mode";
1309
1310 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001311 * The screen backlight brightness between 0 and 255.
1312 */
1313 public static final String SCREEN_BRIGHTNESS = "screen_brightness";
1314
1315 /**
Dan Murphy951764b2009-08-27 14:59:03 -05001316 * Control whether to enable automatic brightness mode.
Dan Murphy951764b2009-08-27 14:59:03 -05001317 */
1318 public static final String SCREEN_BRIGHTNESS_MODE = "screen_brightness_mode";
1319
1320 /**
Mike Lockwooddc3494e2009-10-14 21:17:09 -07001321 * SCREEN_BRIGHTNESS_MODE value for manual mode.
Mike Lockwooddc3494e2009-10-14 21:17:09 -07001322 */
1323 public static final int SCREEN_BRIGHTNESS_MODE_MANUAL = 0;
1324
1325 /**
1326 * SCREEN_BRIGHTNESS_MODE value for manual mode.
Mike Lockwooddc3494e2009-10-14 21:17:09 -07001327 */
1328 public static final int SCREEN_BRIGHTNESS_MODE_AUTOMATIC = 1;
1329
1330 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001331 * Control whether the process CPU usage meter should be shown.
1332 */
1333 public static final String SHOW_PROCESSES = "show_processes";
1334
1335 /**
1336 * If 1, the activity manager will aggressively finish activities and
1337 * processes as soon as they are no longer needed. If 0, the normal
1338 * extended lifetime is used.
1339 */
1340 public static final String ALWAYS_FINISH_ACTIVITIES =
1341 "always_finish_activities";
1342
1343
1344 /**
1345 * Ringer mode. This is used internally, changing this value will not
1346 * change the ringer mode. See AudioManager.
1347 */
1348 public static final String MODE_RINGER = "mode_ringer";
1349
1350 /**
1351 * Determines which streams are affected by ringer mode changes. The
1352 * stream type's bit should be set to 1 if it should be muted when going
1353 * into an inaudible ringer mode.
1354 */
1355 public static final String MODE_RINGER_STREAMS_AFFECTED = "mode_ringer_streams_affected";
1356
1357 /**
1358 * Determines which streams are affected by mute. The
1359 * stream type's bit should be set to 1 if it should be muted when a mute request
1360 * is received.
1361 */
1362 public static final String MUTE_STREAMS_AFFECTED = "mute_streams_affected";
1363
1364 /**
1365 * Whether vibrate is on for different events. This is used internally,
1366 * changing this value will not change the vibrate. See AudioManager.
1367 */
1368 public static final String VIBRATE_ON = "vibrate_on";
1369
1370 /**
1371 * Ringer volume. This is used internally, changing this value will not
1372 * change the volume. See AudioManager.
1373 */
1374 public static final String VOLUME_RING = "volume_ring";
1375
1376 /**
1377 * System/notifications volume. This is used internally, changing this
1378 * value will not change the volume. See AudioManager.
1379 */
1380 public static final String VOLUME_SYSTEM = "volume_system";
1381
1382 /**
1383 * Voice call volume. This is used internally, changing this value will
1384 * not change the volume. See AudioManager.
1385 */
1386 public static final String VOLUME_VOICE = "volume_voice";
1387
1388 /**
1389 * Music/media/gaming volume. This is used internally, changing this
1390 * value will not change the volume. See AudioManager.
1391 */
1392 public static final String VOLUME_MUSIC = "volume_music";
1393
1394 /**
1395 * Alarm volume. This is used internally, changing this
1396 * value will not change the volume. See AudioManager.
1397 */
1398 public static final String VOLUME_ALARM = "volume_alarm";
1399
1400 /**
1401 * Notification volume. This is used internally, changing this
1402 * value will not change the volume. See AudioManager.
1403 */
1404 public static final String VOLUME_NOTIFICATION = "volume_notification";
1405
1406 /**
Eric Laurent484d2882009-12-08 09:05:45 -08001407 * Bluetooth Headset volume. This is used internally, changing this value will
1408 * not change the volume. See AudioManager.
1409 */
1410 public static final String VOLUME_BLUETOOTH_SCO = "volume_bluetooth_sco";
1411
1412 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001413 * Whether the notifications should use the ring volume (value of 1) or
1414 * a separate notification volume (value of 0). In most cases, users
1415 * will have this enabled so the notification and ringer volumes will be
1416 * the same. However, power users can disable this and use the separate
1417 * notification volume control.
1418 * <p>
1419 * Note: This is a one-off setting that will be removed in the future
1420 * when there is profile support. For this reason, it is kept hidden
1421 * from the public APIs.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001422 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001423 * @hide
1424 */
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001425 public static final String NOTIFICATIONS_USE_RING_VOLUME =
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001426 "notifications_use_ring_volume";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001427
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001428 /**
Daniel Sandler6329bf72010-02-26 15:17:44 -05001429 * Whether silent mode should allow vibration feedback. This is used
1430 * internally in AudioService and the Sound settings activity to
1431 * coordinate decoupling of vibrate and silent modes. This setting
1432 * will likely be removed in a future release with support for
1433 * audio/vibe feedback profiles.
1434 *
1435 * @hide
1436 */
1437 public static final String VIBRATE_IN_SILENT = "vibrate_in_silent";
1438
1439 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001440 * The mapping of stream type (integer) to its setting.
1441 */
1442 public static final String[] VOLUME_SETTINGS = {
1443 VOLUME_VOICE, VOLUME_SYSTEM, VOLUME_RING, VOLUME_MUSIC,
Eric Laurent484d2882009-12-08 09:05:45 -08001444 VOLUME_ALARM, VOLUME_NOTIFICATION, VOLUME_BLUETOOTH_SCO
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001445 };
1446
1447 /**
1448 * Appended to various volume related settings to record the previous
1449 * values before they the settings were affected by a silent/vibrate
1450 * ringer mode change.
1451 */
1452 public static final String APPEND_FOR_LAST_AUDIBLE = "_last_audible";
1453
1454 /**
1455 * Persistent store for the system-wide default ringtone URI.
1456 * <p>
1457 * If you need to play the default ringtone at any given time, it is recommended
1458 * you give {@link #DEFAULT_RINGTONE_URI} to the media player. It will resolve
1459 * to the set default ringtone at the time of playing.
1460 *
1461 * @see #DEFAULT_RINGTONE_URI
1462 */
1463 public static final String RINGTONE = "ringtone";
1464
1465 /**
1466 * A {@link Uri} that will point to the current default ringtone at any
1467 * given time.
1468 * <p>
1469 * If the current default ringtone is in the DRM provider and the caller
1470 * does not have permission, the exception will be a
1471 * FileNotFoundException.
1472 */
1473 public static final Uri DEFAULT_RINGTONE_URI = getUriFor(RINGTONE);
1474
1475 /**
1476 * Persistent store for the system-wide default notification sound.
1477 *
1478 * @see #RINGTONE
1479 * @see #DEFAULT_NOTIFICATION_URI
1480 */
1481 public static final String NOTIFICATION_SOUND = "notification_sound";
1482
1483 /**
1484 * A {@link Uri} that will point to the current default notification
1485 * sound at any given time.
1486 *
1487 * @see #DEFAULT_RINGTONE_URI
1488 */
1489 public static final Uri DEFAULT_NOTIFICATION_URI = getUriFor(NOTIFICATION_SOUND);
1490
1491 /**
Patrick Scott3156bb002009-04-13 09:57:38 -07001492 * Persistent store for the system-wide default alarm alert.
1493 *
1494 * @see #RINGTONE
1495 * @see #DEFAULT_ALARM_ALERT_URI
1496 */
1497 public static final String ALARM_ALERT = "alarm_alert";
1498
1499 /**
1500 * A {@link Uri} that will point to the current default alarm alert at
1501 * any given time.
1502 *
1503 * @see #DEFAULT_ALARM_ALERT_URI
1504 */
1505 public static final Uri DEFAULT_ALARM_ALERT_URI = getUriFor(ALARM_ALERT);
1506
1507 /**
Jean-Michel Trivid589fea2011-04-15 11:28:10 -07001508 * Persistent store for the system default media button event receiver.
1509 *
1510 * @hide
1511 */
1512 public static final String MEDIA_BUTTON_RECEIVER = "media_button_receiver";
1513
1514 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001515 * Setting to enable Auto Replace (AutoText) in text editors. 1 = On, 0 = Off
1516 */
1517 public static final String TEXT_AUTO_REPLACE = "auto_replace";
1518
1519 /**
1520 * Setting to enable Auto Caps in text editors. 1 = On, 0 = Off
1521 */
1522 public static final String TEXT_AUTO_CAPS = "auto_caps";
1523
1524 /**
1525 * Setting to enable Auto Punctuate in text editors. 1 = On, 0 = Off. This
1526 * feature converts two spaces to a "." and space.
1527 */
1528 public static final String TEXT_AUTO_PUNCTUATE = "auto_punctuate";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001529
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001530 /**
1531 * Setting to showing password characters in text editors. 1 = On, 0 = Off
1532 */
1533 public static final String TEXT_SHOW_PASSWORD = "show_password";
1534
1535 public static final String SHOW_GTALK_SERVICE_STATUS =
1536 "SHOW_GTALK_SERVICE_STATUS";
1537
1538 /**
1539 * Name of activity to use for wallpaper on the home screen.
1540 */
1541 public static final String WALLPAPER_ACTIVITY = "wallpaper_activity";
1542
1543 /**
1544 * Value to specify if the user prefers the date, time and time zone
1545 * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1546 */
1547 public static final String AUTO_TIME = "auto_time";
1548
1549 /**
Amith Yamasaniad450be2010-09-16 16:47:00 -07001550 * Value to specify if the user prefers the time zone
1551 * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1552 */
1553 public static final String AUTO_TIME_ZONE = "auto_time_zone";
1554
1555 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001556 * Display times as 12 or 24 hours
1557 * 12
1558 * 24
1559 */
1560 public static final String TIME_12_24 = "time_12_24";
1561
1562 /**
1563 * Date format string
1564 * mm/dd/yyyy
1565 * dd/mm/yyyy
1566 * yyyy/mm/dd
1567 */
1568 public static final String DATE_FORMAT = "date_format";
1569
1570 /**
1571 * Whether the setup wizard has been run before (on first boot), or if
1572 * it still needs to be run.
1573 *
1574 * nonzero = it has been run in the past
1575 * 0 = it has not been run in the past
1576 */
1577 public static final String SETUP_WIZARD_HAS_RUN = "setup_wizard_has_run";
1578
1579 /**
1580 * Scaling factor for normal window animations. Setting to 0 will disable window
1581 * animations.
1582 */
1583 public static final String WINDOW_ANIMATION_SCALE = "window_animation_scale";
1584
1585 /**
1586 * Scaling factor for activity transition animations. Setting to 0 will disable window
1587 * animations.
1588 */
1589 public static final String TRANSITION_ANIMATION_SCALE = "transition_animation_scale";
1590
1591 /**
1592 * Scaling factor for normal window animations. Setting to 0 will disable window
1593 * animations.
1594 * @hide
1595 */
1596 public static final String FANCY_IME_ANIMATIONS = "fancy_ime_animations";
1597
1598 /**
1599 * Control whether the accelerometer will be used to change screen
1600 * orientation. If 0, it will not be used unless explicitly requested
1601 * by the application; if 1, it will be used by default unless explicitly
1602 * disabled by the application.
1603 */
1604 public static final String ACCELEROMETER_ROTATION = "accelerometer_rotation";
1605
1606 /**
Daniel Sandlerb73617d2010-08-17 00:41:00 -04001607 * Default screen rotation when no other policy applies.
1608 * When {@link #ACCELEROMETER_ROTATION} is zero and no on-screen Activity expresses a
1609 * preference, this rotation value will be used. Must be one of the
Brian Muramatsue1d46982010-12-06 17:34:20 -08001610 * {@link android.view.Surface#ROTATION_0 Surface rotation constants}.
Daniel Sandlerb73617d2010-08-17 00:41:00 -04001611 *
1612 * @see Display#getRotation
1613 */
1614 public static final String USER_ROTATION = "user_rotation";
1615
1616 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617 * Whether the audible DTMF tones are played by the dialer when dialing. The value is
1618 * boolean (1 or 0).
1619 */
1620 public static final String DTMF_TONE_WHEN_DIALING = "dtmf_tone";
1621
1622 /**
David Kraused0f67152009-06-13 18:01:13 -05001623 * CDMA only settings
1624 * DTMF tone type played by the dialer when dialing.
1625 * 0 = Normal
1626 * 1 = Long
1627 * @hide
1628 */
1629 public static final String DTMF_TONE_TYPE_WHEN_DIALING = "dtmf_tone_type";
1630
1631 /**
1632 * CDMA only settings
1633 * Emergency Tone 0 = Off
1634 * 1 = Alert
1635 * 2 = Vibrate
1636 * @hide
1637 */
1638 public static final String EMERGENCY_TONE = "emergency_tone";
1639
1640 /**
1641 * CDMA only settings
1642 * Whether the auto retry is enabled. The value is
1643 * boolean (1 or 0).
1644 * @hide
1645 */
1646 public static final String CALL_AUTO_RETRY = "call_auto_retry";
1647
1648 /**
1649 * Whether the hearing aid is enabled. The value is
1650 * boolean (1 or 0).
1651 * @hide
1652 */
1653 public static final String HEARING_AID = "hearing_aid";
1654
1655 /**
1656 * CDMA only settings
1657 * TTY Mode
1658 * 0 = OFF
1659 * 1 = FULL
1660 * 2 = VCO
1661 * 3 = HCO
1662 * @hide
1663 */
1664 public static final String TTY_MODE = "tty_mode";
1665
1666 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001667 * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1668 * boolean (1 or 0).
1669 */
1670 public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001671
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001672 /**
1673 * Whether the haptic feedback (long presses, ...) are enabled. The value is
1674 * boolean (1 or 0).
1675 */
1676 public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
Sanjay Jeyakumar21bf2412009-07-09 13:31:48 -07001677
Mike LeBeau48603e72009-06-05 00:27:00 +01001678 /**
Bjorn Bringert24abb662010-09-21 12:21:18 +01001679 * @deprecated Each application that shows web suggestions should have its own
1680 * setting for this.
Mike LeBeau48603e72009-06-05 00:27:00 +01001681 */
Bjorn Bringert24abb662010-09-21 12:21:18 +01001682 @Deprecated
Mike LeBeau48603e72009-06-05 00:27:00 +01001683 public static final String SHOW_WEB_SUGGESTIONS = "show_web_suggestions";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001684
-b master501eec92009-07-06 13:53:11 -07001685 /**
Amith Yamasaniae3ed702009-12-01 19:02:05 -08001686 * Whether the notification LED should repeatedly flash when a notification is
1687 * pending. The value is boolean (1 or 0).
1688 * @hide
1689 */
1690 public static final String NOTIFICATION_LIGHT_PULSE = "notification_light_pulse";
1691
1692 /**
Dianne Hackborn90d2db32010-02-11 22:19:06 -08001693 * Show pointer location on screen?
1694 * 0 = no
1695 * 1 = yes
1696 * @hide
1697 */
1698 public static final String POINTER_LOCATION = "pointer_location";
1699
1700 /**
Jeff Brown4519f072011-01-23 13:16:01 -08001701 * Log raw orientation data from {@link WindowOrientationListener} for use with the
1702 * orientationplot.py tool.
1703 * 0 = no
1704 * 1 = yes
1705 * @hide
1706 */
1707 public static final String WINDOW_ORIENTATION_LISTENER_LOG =
1708 "window_orientation_listener_log";
1709
1710 /**
Daniel Sandler0e9d2af2010-01-25 11:33:03 -05001711 * Whether to play a sound for low-battery alerts.
1712 * @hide
1713 */
1714 public static final String POWER_SOUNDS_ENABLED = "power_sounds_enabled";
1715
1716 /**
1717 * Whether to play a sound for dock events.
1718 * @hide
1719 */
1720 public static final String DOCK_SOUNDS_ENABLED = "dock_sounds_enabled";
1721
1722 /**
1723 * Whether to play sounds when the keyguard is shown and dismissed.
1724 * @hide
1725 */
1726 public static final String LOCKSCREEN_SOUNDS_ENABLED = "lockscreen_sounds_enabled";
1727
1728 /**
1729 * URI for the low battery sound file.
1730 * @hide
1731 */
1732 public static final String LOW_BATTERY_SOUND = "low_battery_sound";
1733
1734 /**
1735 * URI for the desk dock "in" event sound.
1736 * @hide
1737 */
1738 public static final String DESK_DOCK_SOUND = "desk_dock_sound";
1739
1740 /**
1741 * URI for the desk dock "out" event sound.
1742 * @hide
1743 */
1744 public static final String DESK_UNDOCK_SOUND = "desk_undock_sound";
1745
1746 /**
1747 * URI for the car dock "in" event sound.
1748 * @hide
1749 */
1750 public static final String CAR_DOCK_SOUND = "car_dock_sound";
1751
1752 /**
1753 * URI for the car dock "out" event sound.
1754 * @hide
1755 */
1756 public static final String CAR_UNDOCK_SOUND = "car_undock_sound";
1757
1758 /**
1759 * URI for the "device locked" (keyguard shown) sound.
1760 * @hide
1761 */
1762 public static final String LOCK_SOUND = "lock_sound";
1763
1764 /**
1765 * URI for the "device unlocked" (keyguard dismissed) sound.
1766 * @hide
1767 */
1768 public static final String UNLOCK_SOUND = "unlock_sound";
1769
1770 /**
Mike Lockwoodeabe8bf2010-08-31 14:35:23 -04001771 * True if we should appear as a PTP device instead of MTP.
1772 * @hide
1773 */
1774 public static final String USE_PTP_INTERFACE = "use_ptp_interface";
1775
1776 /**
Chung-yih Wang042e9bd2010-08-31 17:43:39 +08001777 * Receive incoming SIP calls?
1778 * 0 = no
1779 * 1 = yes
1780 * @hide
1781 */
1782 public static final String SIP_RECEIVE_CALLS = "sip_receive_calls";
1783
1784 /**
1785 * Call Preference String.
1786 * "SIP_ALWAYS" : Always use SIP with network access
1787 * "SIP_ADDRESS_ONLY" : Only if destination is a SIP address
1788 * "SIP_ASK_ME_EACH_TIME" : Always ask me each time
1789 * @hide
1790 */
1791 public static final String SIP_CALL_OPTIONS = "sip_call_options";
1792
1793 /**
1794 * One of the sip call options: Always use SIP with network access.
1795 * @hide
1796 */
1797 public static final String SIP_ALWAYS = "SIP_ALWAYS";
1798
1799 /**
1800 * One of the sip call options: Only if destination is a SIP address.
1801 * @hide
1802 */
1803 public static final String SIP_ADDRESS_ONLY = "SIP_ADDRESS_ONLY";
1804
1805 /**
1806 * One of the sip call options: Always ask me each time.
1807 * @hide
1808 */
1809 public static final String SIP_ASK_ME_EACH_TIME = "SIP_ASK_ME_EACH_TIME";
1810
1811 /**
-b master501eec92009-07-06 13:53:11 -07001812 * Settings to backup. This is here so that it's in the same place as the settings
1813 * keys and easy to update.
1814 * @hide
1815 */
1816 public static final String[] SETTINGS_TO_BACKUP = {
1817 STAY_ON_WHILE_PLUGGED_IN,
-b master501eec92009-07-06 13:53:11 -07001818 WIFI_USE_STATIC_IP,
1819 WIFI_STATIC_IP,
1820 WIFI_STATIC_GATEWAY,
1821 WIFI_STATIC_NETMASK,
1822 WIFI_STATIC_DNS1,
1823 WIFI_STATIC_DNS2,
1824 BLUETOOTH_DISCOVERABILITY,
1825 BLUETOOTH_DISCOVERABILITY_TIMEOUT,
1826 DIM_SCREEN,
1827 SCREEN_OFF_TIMEOUT,
1828 SCREEN_BRIGHTNESS,
Christopher Tate362aca62009-09-25 15:58:03 -07001829 SCREEN_BRIGHTNESS_MODE,
-b master501eec92009-07-06 13:53:11 -07001830 VIBRATE_ON,
Amith Yamasani8823c0a82009-07-07 14:30:17 -07001831 MODE_RINGER,
1832 MODE_RINGER_STREAMS_AFFECTED,
1833 MUTE_STREAMS_AFFECTED,
1834 VOLUME_VOICE,
1835 VOLUME_SYSTEM,
1836 VOLUME_RING,
1837 VOLUME_MUSIC,
1838 VOLUME_ALARM,
1839 VOLUME_NOTIFICATION,
Eric Laurent484d2882009-12-08 09:05:45 -08001840 VOLUME_BLUETOOTH_SCO,
Amith Yamasani8823c0a82009-07-07 14:30:17 -07001841 VOLUME_VOICE + APPEND_FOR_LAST_AUDIBLE,
1842 VOLUME_SYSTEM + APPEND_FOR_LAST_AUDIBLE,
1843 VOLUME_RING + APPEND_FOR_LAST_AUDIBLE,
1844 VOLUME_MUSIC + APPEND_FOR_LAST_AUDIBLE,
1845 VOLUME_ALARM + APPEND_FOR_LAST_AUDIBLE,
1846 VOLUME_NOTIFICATION + APPEND_FOR_LAST_AUDIBLE,
Eric Laurent484d2882009-12-08 09:05:45 -08001847 VOLUME_BLUETOOTH_SCO + APPEND_FOR_LAST_AUDIBLE,
Daniel Sandler1c7fa482010-03-10 09:45:01 -05001848 VIBRATE_IN_SILENT,
-b master501eec92009-07-06 13:53:11 -07001849 TEXT_AUTO_REPLACE,
1850 TEXT_AUTO_CAPS,
1851 TEXT_AUTO_PUNCTUATE,
1852 TEXT_SHOW_PASSWORD,
1853 AUTO_TIME,
Amith Yamasaniad450be2010-09-16 16:47:00 -07001854 AUTO_TIME_ZONE,
-b master501eec92009-07-06 13:53:11 -07001855 TIME_12_24,
1856 DATE_FORMAT,
1857 ACCELEROMETER_ROTATION,
Daniel Sandlerb73617d2010-08-17 00:41:00 -04001858 USER_ROTATION,
-b master501eec92009-07-06 13:53:11 -07001859 DTMF_TONE_WHEN_DIALING,
1860 DTMF_TONE_TYPE_WHEN_DIALING,
1861 EMERGENCY_TONE,
1862 CALL_AUTO_RETRY,
1863 HEARING_AID,
1864 TTY_MODE,
1865 SOUND_EFFECTS_ENABLED,
1866 HAPTIC_FEEDBACK_ENABLED,
Christopher Tate14c2d792010-02-25 16:49:44 -08001867 POWER_SOUNDS_ENABLED,
1868 DOCK_SOUNDS_ENABLED,
1869 LOCKSCREEN_SOUNDS_ENABLED,
Amith Yamasaniae3ed702009-12-01 19:02:05 -08001870 SHOW_WEB_SUGGESTIONS,
Mike Lockwoodeabe8bf2010-08-31 14:35:23 -04001871 NOTIFICATION_LIGHT_PULSE,
1872 USE_PTP_INTERFACE,
Chung-yih Wang042e9bd2010-08-31 17:43:39 +08001873 SIP_CALL_OPTIONS,
Nick Pelly038cabe2010-09-23 16:12:11 -07001874 SIP_RECEIVE_CALLS,
-b master501eec92009-07-06 13:53:11 -07001875 };
1876
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001877 // Settings moved to Settings.Secure
1878
1879 /**
Mike Lockwood460ae0c2009-04-02 22:33:27 -07001880 * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001881 * instead
1882 */
1883 @Deprecated
1884 public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1885
1886 /**
1887 * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1888 */
1889 @Deprecated
1890 public static final String ANDROID_ID = Secure.ANDROID_ID;
1891
1892 /**
1893 * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1894 */
1895 @Deprecated
1896 public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1897
1898 /**
1899 * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1900 */
1901 @Deprecated
1902 public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1903
1904 /**
1905 * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1906 */
1907 @Deprecated
1908 public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1909
1910 /**
1911 * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1912 */
1913 @Deprecated
1914 public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1915
1916 /**
1917 * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1918 */
1919 @Deprecated
1920 public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001921
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001922 /**
1923 * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1924 * instead
1925 */
1926 @Deprecated
1927 public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1928
1929 /**
1930 * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1931 */
1932 @Deprecated
1933 public static final String LOGGING_ID = Secure.LOGGING_ID;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001934
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001935 /**
1936 * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1937 */
1938 @Deprecated
1939 public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1940
1941 /**
1942 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1943 * instead
1944 */
1945 @Deprecated
1946 public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1947
1948 /**
1949 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1950 * instead
1951 */
1952 @Deprecated
1953 public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1954
1955 /**
1956 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1957 * instead
1958 */
1959 @Deprecated
1960 public static final String PARENTAL_CONTROL_REDIRECT_URL =
1961 Secure.PARENTAL_CONTROL_REDIRECT_URL;
1962
1963 /**
1964 * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1965 */
1966 @Deprecated
1967 public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1968
1969 /**
1970 * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1971 */
1972 @Deprecated
1973 public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001974
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001975 /**
1976 * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1977 */
1978 @Deprecated
1979 public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1980
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001981 /**
1982 * @deprecated Use
1983 * {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT} instead
1984 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001985 @Deprecated
1986 public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1987
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001988 /**
1989 * @deprecated Use
1990 * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS} instead
1991 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001992 @Deprecated
1993 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1994 Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1995
1996 /**
1997 * @deprecated Use
1998 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1999 */
2000 @Deprecated
2001 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
2002 Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
2003
2004 /**
2005 * @deprecated Use
2006 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
2007 */
2008 @Deprecated
2009 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
2010 Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002011
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002012 /**
2013 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
2014 * instead
2015 */
2016 @Deprecated
2017 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
2018
2019 /**
2020 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
2021 */
2022 @Deprecated
2023 public static final String WIFI_ON = Secure.WIFI_ON;
2024
2025 /**
2026 * @deprecated Use
2027 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
2028 * instead
2029 */
2030 @Deprecated
2031 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
2032 Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
2033
2034 /**
2035 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
2036 */
2037 @Deprecated
2038 public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
2039
2040 /**
2041 * @deprecated Use
2042 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
2043 */
2044 @Deprecated
2045 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
2046 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002047
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002048 /**
2049 * @deprecated Use
2050 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
2051 */
2052 @Deprecated
2053 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
2054 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
2055
2056 /**
2057 * @deprecated Use
2058 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
2059 * instead
2060 */
2061 @Deprecated
2062 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
2063 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
2064
2065 /**
2066 * @deprecated Use
2067 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
2068 */
2069 @Deprecated
2070 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2071 Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
2072
2073 /**
2074 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
2075 * instead
2076 */
2077 @Deprecated
2078 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
2079
2080 /**
2081 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
2082 */
2083 @Deprecated
2084 public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
2085
2086 /**
2087 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
2088 */
2089 @Deprecated
2090 public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
2091
2092 /**
2093 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
2094 * instead
2095 */
2096 @Deprecated
2097 public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
2098
2099 /**
2100 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
2101 * instead
2102 */
2103 @Deprecated
2104 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
2105 Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
2106 }
2107
2108 /**
2109 * Secure system settings, containing system preferences that applications
2110 * can read but are not allowed to write. These are for preferences that
2111 * the user must explicitly modify through the system UI or specialized
2112 * APIs for those values, not modified directly by applications.
2113 */
2114 public static final class Secure extends NameValueTable {
2115 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
2116
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08002117 // Populated lazily, guarded by class object:
2118 private static NameValueCache sNameValueCache = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002119
2120 /**
2121 * Look up a name in the database.
2122 * @param resolver to access the database with
2123 * @param name to look up in the table
2124 * @return the corresponding value, or null if not present
2125 */
2126 public synchronized static String getString(ContentResolver resolver, String name) {
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08002127 if (sNameValueCache == null) {
2128 sNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI,
2129 CALL_METHOD_GET_SECURE);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002130 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08002131 return sNameValueCache.getString(resolver, name);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002132 }
2133
2134 /**
2135 * Store a name/value pair into the database.
2136 * @param resolver to access the database with
2137 * @param name to store
2138 * @param value to associate with the name
2139 * @return true if the value was set, false on database errors
2140 */
2141 public static boolean putString(ContentResolver resolver,
2142 String name, String value) {
2143 return putString(resolver, CONTENT_URI, name, value);
2144 }
2145
2146 /**
2147 * Construct the content URI for a particular name/value pair,
2148 * useful for monitoring changes with a ContentObserver.
2149 * @param name to look up in the table
2150 * @return the corresponding content URI, or null if not present
2151 */
2152 public static Uri getUriFor(String name) {
2153 return getUriFor(CONTENT_URI, name);
2154 }
2155
2156 /**
2157 * Convenience function for retrieving a single secure settings value
2158 * as an integer. Note that internally setting values are always
2159 * stored as strings; this function converts the string to an integer
2160 * for you. The default value will be returned if the setting is
2161 * not defined or not an integer.
2162 *
2163 * @param cr The ContentResolver to access.
2164 * @param name The name of the setting to retrieve.
2165 * @param def Value to return if the setting is not defined.
2166 *
2167 * @return The setting's current value, or 'def' if it is not defined
2168 * or not a valid integer.
2169 */
2170 public static int getInt(ContentResolver cr, String name, int def) {
2171 String v = getString(cr, name);
2172 try {
2173 return v != null ? Integer.parseInt(v) : def;
2174 } catch (NumberFormatException e) {
2175 return def;
2176 }
2177 }
2178
2179 /**
2180 * Convenience function for retrieving a single secure settings value
2181 * as an integer. Note that internally setting values are always
2182 * stored as strings; this function converts the string to an integer
2183 * for you.
2184 * <p>
2185 * This version does not take a default value. If the setting has not
2186 * been set, or the string value is not a number,
2187 * it throws {@link SettingNotFoundException}.
2188 *
2189 * @param cr The ContentResolver to access.
2190 * @param name The name of the setting to retrieve.
2191 *
2192 * @throws SettingNotFoundException Thrown if a setting by the given
2193 * name can't be found or the setting value is not an integer.
2194 *
2195 * @return The setting's current value.
2196 */
2197 public static int getInt(ContentResolver cr, String name)
2198 throws SettingNotFoundException {
2199 String v = getString(cr, name);
2200 try {
2201 return Integer.parseInt(v);
2202 } catch (NumberFormatException e) {
2203 throw new SettingNotFoundException(name);
2204 }
2205 }
2206
2207 /**
2208 * Convenience function for updating a single settings value as an
2209 * integer. This will either create a new entry in the table if the
2210 * given name does not exist, or modify the value of the existing row
2211 * with that name. Note that internally setting values are always
2212 * stored as strings, so this function converts the given value to a
2213 * string before storing it.
2214 *
2215 * @param cr The ContentResolver to access.
2216 * @param name The name of the setting to modify.
2217 * @param value The new value for the setting.
2218 * @return true if the value was set, false on database errors
2219 */
2220 public static boolean putInt(ContentResolver cr, String name, int value) {
2221 return putString(cr, name, Integer.toString(value));
2222 }
2223
2224 /**
2225 * Convenience function for retrieving a single secure settings value
2226 * as a {@code long}. Note that internally setting values are always
2227 * stored as strings; this function converts the string to a {@code long}
2228 * for you. The default value will be returned if the setting is
2229 * not defined or not a {@code long}.
2230 *
2231 * @param cr The ContentResolver to access.
2232 * @param name The name of the setting to retrieve.
2233 * @param def Value to return if the setting is not defined.
2234 *
2235 * @return The setting's current value, or 'def' if it is not defined
2236 * or not a valid {@code long}.
2237 */
2238 public static long getLong(ContentResolver cr, String name, long def) {
2239 String valString = getString(cr, name);
2240 long value;
2241 try {
2242 value = valString != null ? Long.parseLong(valString) : def;
2243 } catch (NumberFormatException e) {
2244 value = def;
2245 }
2246 return value;
2247 }
2248
2249 /**
2250 * Convenience function for retrieving a single secure settings value
2251 * as a {@code long}. Note that internally setting values are always
2252 * stored as strings; this function converts the string to a {@code long}
2253 * for you.
2254 * <p>
2255 * This version does not take a default value. If the setting has not
2256 * been set, or the string value is not a number,
2257 * it throws {@link SettingNotFoundException}.
2258 *
2259 * @param cr The ContentResolver to access.
2260 * @param name The name of the setting to retrieve.
2261 *
2262 * @return The setting's current value.
2263 * @throws SettingNotFoundException Thrown if a setting by the given
2264 * name can't be found or the setting value is not an integer.
2265 */
2266 public static long getLong(ContentResolver cr, String name)
2267 throws SettingNotFoundException {
2268 String valString = getString(cr, name);
2269 try {
2270 return Long.parseLong(valString);
2271 } catch (NumberFormatException e) {
2272 throw new SettingNotFoundException(name);
2273 }
2274 }
2275
2276 /**
2277 * Convenience function for updating a secure settings value as a long
2278 * integer. This will either create a new entry in the table if the
2279 * given name does not exist, or modify the value of the existing row
2280 * with that name. Note that internally setting values are always
2281 * stored as strings, so this function converts the given value to a
2282 * string before storing it.
2283 *
2284 * @param cr The ContentResolver to access.
2285 * @param name The name of the setting to modify.
2286 * @param value The new value for the setting.
2287 * @return true if the value was set, false on database errors
2288 */
2289 public static boolean putLong(ContentResolver cr, String name, long value) {
2290 return putString(cr, name, Long.toString(value));
2291 }
2292
2293 /**
2294 * Convenience function for retrieving a single secure settings value
2295 * as a floating point number. Note that internally setting values are
2296 * always stored as strings; this function converts the string to an
2297 * float for you. The default value will be returned if the setting
2298 * is not defined or not a valid float.
2299 *
2300 * @param cr The ContentResolver to access.
2301 * @param name The name of the setting to retrieve.
2302 * @param def Value to return if the setting is not defined.
2303 *
2304 * @return The setting's current value, or 'def' if it is not defined
2305 * or not a valid float.
2306 */
2307 public static float getFloat(ContentResolver cr, String name, float def) {
2308 String v = getString(cr, name);
2309 try {
2310 return v != null ? Float.parseFloat(v) : def;
2311 } catch (NumberFormatException e) {
2312 return def;
2313 }
2314 }
2315
2316 /**
2317 * Convenience function for retrieving a single secure settings value
2318 * as a float. Note that internally setting values are always
2319 * stored as strings; this function converts the string to a float
2320 * for you.
2321 * <p>
2322 * This version does not take a default value. If the setting has not
2323 * been set, or the string value is not a number,
2324 * it throws {@link SettingNotFoundException}.
2325 *
2326 * @param cr The ContentResolver to access.
2327 * @param name The name of the setting to retrieve.
2328 *
2329 * @throws SettingNotFoundException Thrown if a setting by the given
2330 * name can't be found or the setting value is not a float.
2331 *
2332 * @return The setting's current value.
2333 */
2334 public static float getFloat(ContentResolver cr, String name)
2335 throws SettingNotFoundException {
2336 String v = getString(cr, name);
Brian Muramatsue1d46982010-12-06 17:34:20 -08002337 if (v == null) {
2338 throw new SettingNotFoundException(name);
2339 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002340 try {
2341 return Float.parseFloat(v);
2342 } catch (NumberFormatException e) {
2343 throw new SettingNotFoundException(name);
2344 }
2345 }
2346
2347 /**
2348 * Convenience function for updating a single settings value as a
2349 * floating point number. This will either create a new entry in the
2350 * table if the given name does not exist, or modify the value of the
2351 * existing row with that name. Note that internally setting values
2352 * are always stored as strings, so this function converts the given
2353 * value to a string before storing it.
2354 *
2355 * @param cr The ContentResolver to access.
2356 * @param name The name of the setting to modify.
2357 * @param value The new value for the setting.
2358 * @return true if the value was set, false on database errors
2359 */
2360 public static boolean putFloat(ContentResolver cr, String name, float value) {
2361 return putString(cr, name, Float.toString(value));
2362 }
2363
2364 /**
2365 * The content:// style URL for this table
2366 */
2367 public static final Uri CONTENT_URI =
2368 Uri.parse("content://" + AUTHORITY + "/secure");
2369
2370 /**
2371 * Whether ADB is enabled.
2372 */
2373 public static final String ADB_ENABLED = "adb_enabled";
2374
2375 /**
2376 * Setting to allow mock locations and location provider status to be injected into the
2377 * LocationManager service for testing purposes during application development. These
2378 * locations and status values override actual location and status information generated
2379 * by network, gps, or other location providers.
2380 */
2381 public static final String ALLOW_MOCK_LOCATION = "mock_location";
2382
2383 /**
Doug Zongkerd8893db2010-01-26 12:29:44 -08002384 * A 64-bit number (as a hex string) that is randomly
2385 * generated on the device's first boot and should remain
2386 * constant for the lifetime of the device. (The value may
2387 * change if a factory reset is performed on the device.)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002388 */
2389 public static final String ANDROID_ID = "android_id";
2390
2391 /**
2392 * Whether bluetooth is enabled/disabled
2393 * 0=disabled. 1=enabled.
2394 */
2395 public static final String BLUETOOTH_ON = "bluetooth_on";
2396
2397 /**
2398 * Get the key that retrieves a bluetooth headset's priority.
2399 * @hide
2400 */
2401 public static final String getBluetoothHeadsetPriorityKey(String address) {
2402 return ("bluetooth_headset_priority_" + address.toUpperCase());
2403 }
2404
2405 /**
2406 * Get the key that retrieves a bluetooth a2dp sink's priority.
2407 * @hide
2408 */
2409 public static final String getBluetoothA2dpSinkPriorityKey(String address) {
2410 return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
2411 }
2412
2413 /**
Jaikumar Ganesh545e6702010-06-04 10:23:03 -07002414 * Get the key that retrieves a bluetooth Input Device's priority.
2415 * @hide
2416 */
2417 public static final String getBluetoothInputDevicePriorityKey(String address) {
2418 return ("bluetooth_input_device_priority_" + address.toUpperCase());
2419 }
2420
2421 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002422 * Whether or not data roaming is enabled. (0 = false, 1 = true)
2423 */
2424 public static final String DATA_ROAMING = "data_roaming";
2425
2426 /**
2427 * Setting to record the input method used by default, holding the ID
2428 * of the desired method.
2429 */
2430 public static final String DEFAULT_INPUT_METHOD = "default_input_method";
2431
2432 /**
satokab751aa2010-09-14 19:17:36 +09002433 * Setting to record the input method subtype used by default, holding the ID
2434 * of the desired method.
2435 */
2436 public static final String SELECTED_INPUT_METHOD_SUBTYPE =
2437 "selected_input_method_subtype";
2438
2439 /**
satok723a27e2010-11-11 14:58:11 +09002440 * Setting to record the history of input method subtype, holding the pair of ID of IME
2441 * and its last used subtype.
2442 * @hide
2443 */
2444 public static final String INPUT_METHODS_SUBTYPE_HISTORY =
2445 "input_methods_subtype_history";
2446
2447 /**
satok5c58dfc2010-12-14 21:54:47 +09002448 * Setting to record the visibility of input method selector
2449 */
2450 public static final String INPUT_METHOD_SELECTOR_VISIBILITY =
2451 "input_method_selector_visibility";
2452
2453 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002454 * Whether the device has been provisioned (0 = false, 1 = true)
2455 */
2456 public static final String DEVICE_PROVISIONED = "device_provisioned";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002457
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002458 /**
2459 * List of input methods that are currently enabled. This is a string
2460 * containing the IDs of all enabled input methods, each ID separated
2461 * by ':'.
2462 */
2463 public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002464
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002465 /**
Amith Yamasanie861ec12010-03-24 21:39:27 -07002466 * List of system input methods that are currently disabled. This is a string
2467 * containing the IDs of all disabled input methods, each ID separated
2468 * by ':'.
2469 * @hide
2470 */
2471 public static final String DISABLED_SYSTEM_INPUT_METHODS = "disabled_system_input_methods";
2472
2473 /**
Robert Greenwalt434203a2010-10-11 16:00:27 -07002474 * Host name and port for global http proxy. Uses ':' seperator for between host and port
2475 * TODO - deprecate in favor of global_http_proxy_host, etc
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002476 */
2477 public static final String HTTP_PROXY = "http_proxy";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002478
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002479 /**
Robert Greenwalt434203a2010-10-11 16:00:27 -07002480 * Host name for global http proxy. Set via ConnectivityManager.
2481 * @hide
2482 */
2483 public static final String GLOBAL_HTTP_PROXY_HOST = "global_http_proxy_host";
2484
2485 /**
2486 * Integer host port for global http proxy. Set via ConnectivityManager.
2487 * @hide
2488 */
2489 public static final String GLOBAL_HTTP_PROXY_PORT = "global_http_proxy_port";
2490
2491 /**
Oscar Montemayor16fb7912010-08-02 09:38:48 -07002492 * Exclusion list for global proxy. This string contains a list of comma-separated
2493 * domains where the global proxy does not apply. Domains should be listed in a comma-
2494 * separated list. Example of acceptable formats: ".domain1.com,my.domain2.com"
Robert Greenwalt434203a2010-10-11 16:00:27 -07002495 * Use ConnectivityManager to set/get.
Oscar Montemayor16fb7912010-08-02 09:38:48 -07002496 * @hide
2497 */
Robert Greenwalt434203a2010-10-11 16:00:27 -07002498 public static final String GLOBAL_HTTP_PROXY_EXCLUSION_LIST =
2499 "global_http_proxy_exclusion_list";
Oscar Montemayor16fb7912010-08-02 09:38:48 -07002500
2501 /**
2502 * Enables the UI setting to allow the user to specify the global HTTP proxy
2503 * and associated exclusion list.
2504 * @hide
2505 */
2506 public static final String SET_GLOBAL_HTTP_PROXY = "set_global_http_proxy";
2507
2508 /**
Robert Greenwalte90aa5e2010-09-01 11:34:05 -07002509 * Setting for default DNS in case nobody suggests one
2510 * @hide
2511 */
2512 public static final String DEFAULT_DNS_SERVER = "default_dns_server";
2513
2514 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002515 * Whether the package installer should allow installation of apps downloaded from
2516 * sources other than the Android Market (vending machine).
2517 *
2518 * 1 = allow installing from other sources
2519 * 0 = only allow installing from the Android Market
2520 */
2521 public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002522
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002523 /**
2524 * Comma-separated list of location providers that activities may access.
2525 */
2526 public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002527
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002528 /**
Amith Yamasani156c4352010-03-05 17:10:03 -08002529 * Whether autolock is enabled (0 = false, 1 = true)
2530 */
2531 public static final String LOCK_PATTERN_ENABLED = "lock_pattern_autolock";
2532
2533 /**
2534 * Whether lock pattern is visible as user enters (0 = false, 1 = true)
2535 */
2536 public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
2537
2538 /**
2539 * Whether lock pattern will vibrate as user enters (0 = false, 1 = true)
2540 */
2541 public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
2542 "lock_pattern_tactile_feedback_enabled";
2543
2544 /**
Jim Millerbc4603b2010-08-30 21:21:34 -07002545 * This preference allows the device to be locked given time after screen goes off,
2546 * subject to current DeviceAdmin policy limits.
2547 * @hide
2548 */
2549 public static final String LOCK_SCREEN_LOCK_AFTER_TIMEOUT = "lock_screen_lock_after_timeout";
2550
2551
2552 /**
Jim Miller253a5ef2010-10-13 20:57:29 -07002553 * This preference contains the string that shows for owner info on LockScren.
2554 * @hide
2555 */
2556 public static final String LOCK_SCREEN_OWNER_INFO = "lock_screen_owner_info";
2557
2558 /**
2559 * This preference enables showing the owner info on LockScren.
2560 * @hide
2561 */
2562 public static final String LOCK_SCREEN_OWNER_INFO_ENABLED =
2563 "lock_screen_owner_info_enabled";
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 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07003026 * Controls whether settings backup is enabled.
Dianne Hackborncf098292009-07-01 19:55:20 -07003027 * Type: int ( 0 = disabled, 1 = enabled )
3028 * @hide
3029 */
3030 public static final String BACKUP_ENABLED = "backup_enabled";
3031
3032 /**
Christopher Tatecce9da52010-02-03 15:11:15 -08003033 * Controls whether application data is automatically restored from backup
3034 * at install time.
3035 * Type: int ( 0 = disabled, 1 = enabled )
3036 * @hide
3037 */
3038 public static final String BACKUP_AUTO_RESTORE = "backup_auto_restore";
3039
3040 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07003041 * Indicates whether settings backup has been fully provisioned.
3042 * Type: int ( 0 = unprovisioned, 1 = fully provisioned )
3043 * @hide
3044 */
3045 public static final String BACKUP_PROVISIONED = "backup_provisioned";
3046
3047 /**
Dianne Hackborncf098292009-07-01 19:55:20 -07003048 * Component of the transport to use for backup/restore.
3049 * @hide
3050 */
3051 public static final String BACKUP_TRANSPORT = "backup_transport";
Sanjay Jeyakumar21bf2412009-07-09 13:31:48 -07003052
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07003053 /**
3054 * Version for which the setup wizard was last shown. Bumped for
3055 * each release when there is new setup information to show.
3056 * @hide
3057 */
3058 public static final String LAST_SETUP_SHOWN = "last_setup_shown";
Dianne Hackborncf098292009-07-01 19:55:20 -07003059
3060 /**
Doug Zongkerf6888892010-01-06 16:38:14 -08003061 * How frequently (in seconds) to check the memory status of the
3062 * device.
3063 * @hide
3064 */
3065 public static final String MEMCHECK_INTERVAL = "memcheck_interval";
3066
3067 /**
3068 * Max frequency (in seconds) to log memory check stats, in realtime
3069 * seconds. This allows for throttling of logs when the device is
3070 * running for large amounts of time.
3071 * @hide
3072 */
3073 public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
3074 "memcheck_log_realtime_interval";
3075
3076 /**
3077 * Boolean indicating whether rebooting due to system memory checks
3078 * is enabled.
3079 * @hide
3080 */
3081 public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
3082
3083 /**
3084 * How many bytes the system process must be below to avoid scheduling
3085 * a soft reboot. This reboot will happen when it is next determined
3086 * to be a good time.
3087 * @hide
3088 */
3089 public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
3090
3091 /**
3092 * How many bytes the system process must be below to avoid scheduling
3093 * a hard reboot. This reboot will happen immediately.
3094 * @hide
3095 */
3096 public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
3097
3098 /**
3099 * How many bytes the phone process must be below to avoid scheduling
3100 * a soft restart. This restart will happen when it is next determined
3101 * to be a good time.
3102 * @hide
3103 */
3104 public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
3105
3106 /**
3107 * How many bytes the phone process must be below to avoid scheduling
3108 * a hard restart. This restart will happen immediately.
3109 * @hide
3110 */
3111 public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
3112
3113 /**
3114 * Boolean indicating whether restarting the phone process due to
3115 * memory checks is enabled.
3116 * @hide
3117 */
3118 public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
3119
3120 /**
3121 * First time during the day it is okay to kill processes
3122 * or reboot the device due to low memory situations. This number is
3123 * in seconds since midnight.
3124 * @hide
3125 */
3126 public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
3127
3128 /**
3129 * Last time during the day it is okay to kill processes
3130 * or reboot the device due to low memory situations. This number is
3131 * in seconds since midnight.
3132 * @hide
3133 */
3134 public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
3135
3136 /**
3137 * How long the screen must have been off in order to kill processes
3138 * or reboot. This number is in seconds. A value of -1 means to
3139 * entirely disregard whether the screen is on.
3140 * @hide
3141 */
3142 public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
3143
3144 /**
3145 * How much time there must be until the next alarm in order to kill processes
3146 * or reboot. This number is in seconds. Note: this value must be
3147 * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
3148 * always see an alarm scheduled within its time.
3149 * @hide
3150 */
3151 public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
3152
3153 /**
3154 * How frequently to check whether it is a good time to restart things,
3155 * if the device is in a bad state. This number is in seconds. Note:
3156 * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
3157 * the alarm to schedule the recheck will always appear within the
3158 * minimum "do not execute now" time.
3159 * @hide
3160 */
3161 public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
3162
3163 /**
3164 * How frequently (in DAYS) to reboot the device. If 0, no reboots
3165 * will occur.
3166 * @hide
3167 */
3168 public static final String REBOOT_INTERVAL = "reboot_interval";
3169
3170 /**
3171 * First time during the day it is okay to force a reboot of the
3172 * device (if REBOOT_INTERVAL is set). This number is
3173 * in seconds since midnight.
3174 * @hide
3175 */
3176 public static final String REBOOT_START_TIME = "reboot_start_time";
3177
3178 /**
3179 * The window of time (in seconds) after each REBOOT_INTERVAL in which
3180 * a reboot can be executed. If 0, a reboot will always be executed at
3181 * exactly the given time. Otherwise, it will only be executed if
3182 * the device is idle within the window.
3183 * @hide
3184 */
3185 public static final String REBOOT_WINDOW = "reboot_window";
3186
3187 /**
Doug Zongker43866e02010-01-07 12:09:54 -08003188 * Threshold values for the duration and level of a discharge cycle, under
3189 * which we log discharge cycle info.
3190 * @hide
3191 */
3192 public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
3193 "battery_discharge_duration_threshold";
3194 /** @hide */
3195 public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
3196
3197 /**
3198 * Flag for allowing ActivityManagerService to send ACTION_APP_ERROR intents
3199 * on application crashes and ANRs. If this is disabled, the crash/ANR dialog
3200 * will never display the "Report" button.
3201 * Type: int ( 0 = disallow, 1 = allow )
3202 * @hide
3203 */
3204 public static final String SEND_ACTION_APP_ERROR = "send_action_app_error";
3205
3206 /**
3207 * Nonzero causes Log.wtf() to crash.
3208 * @hide
3209 */
3210 public static final String WTF_IS_FATAL = "wtf_is_fatal";
3211
3212 /**
Jake Hambybb371632010-08-23 18:16:48 -07003213 * Maximum age of entries kept by {@link com.android.internal.os.IDropBoxManagerService}.
Doug Zongker43866e02010-01-07 12:09:54 -08003214 * @hide
3215 */
3216 public static final String DROPBOX_AGE_SECONDS =
3217 "dropbox_age_seconds";
3218 /**
Jake Hambybb371632010-08-23 18:16:48 -07003219 * Maximum number of entry files which {@link com.android.internal.os.IDropBoxManagerService} will keep around.
Dan Egnor3a8b0c12010-03-24 17:48:20 -07003220 * @hide
3221 */
3222 public static final String DROPBOX_MAX_FILES =
3223 "dropbox_max_files";
3224 /**
Jake Hambybb371632010-08-23 18:16:48 -07003225 * Maximum amount of disk space used by {@link com.android.internal.os.IDropBoxManagerService} no matter what.
Doug Zongker43866e02010-01-07 12:09:54 -08003226 * @hide
3227 */
3228 public static final String DROPBOX_QUOTA_KB =
3229 "dropbox_quota_kb";
3230 /**
Jake Hambybb371632010-08-23 18:16:48 -07003231 * Percent of free disk (excluding reserve) which {@link com.android.internal.os.IDropBoxManagerService} will use.
Doug Zongker43866e02010-01-07 12:09:54 -08003232 * @hide
3233 */
3234 public static final String DROPBOX_QUOTA_PERCENT =
3235 "dropbox_quota_percent";
3236 /**
Jake Hambybb371632010-08-23 18:16:48 -07003237 * Percent of total disk which {@link com.android.internal.os.IDropBoxManagerService} will never dip into.
Doug Zongker43866e02010-01-07 12:09:54 -08003238 * @hide
3239 */
3240 public static final String DROPBOX_RESERVE_PERCENT =
3241 "dropbox_reserve_percent";
3242 /**
3243 * Prefix for per-tag dropbox disable/enable settings.
3244 * @hide
3245 */
3246 public static final String DROPBOX_TAG_PREFIX =
3247 "dropbox:";
Dan Egnora455d192010-03-12 08:52:28 -08003248 /**
3249 * Lines of logcat to include with system crash/ANR/etc. reports,
3250 * as a prefix of the dropbox tag of the report type.
3251 * For example, "logcat_for_system_server_anr" controls the lines
3252 * of logcat captured with system server ANR reports. 0 to disable.
3253 * @hide
3254 */
3255 public static final String ERROR_LOGCAT_PREFIX =
3256 "logcat_for_";
Doug Zongker43866e02010-01-07 12:09:54 -08003257
3258
3259 /**
3260 * Screen timeout in milliseconds corresponding to the
3261 * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
3262 * possible screen timeout behavior.)
3263 * @hide
3264 */
3265 public static final String SHORT_KEYLIGHT_DELAY_MS =
3266 "short_keylight_delay_ms";
3267
3268 /**
3269 * The interval in minutes after which the amount of free storage left on the
3270 * device is logged to the event log
3271 * @hide
3272 */
3273 public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
3274 "sys_free_storage_log_interval";
3275
3276 /**
3277 * Threshold for the amount of change in disk free space required to report the amount of
3278 * free space. Used to prevent spamming the logs when the disk free space isn't changing
3279 * frequently.
3280 * @hide
3281 */
3282 public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
3283 "disk_free_change_reporting_threshold";
3284
3285
3286 /**
3287 * Minimum percentage of free storage on the device that is used to determine if
Dianne Hackborn247fe742011-01-08 17:25:57 -08003288 * the device is running low on storage. The default is 10.
3289 * <p>Say this value is set to 10, the device is considered running low on storage
Doug Zongker43866e02010-01-07 12:09:54 -08003290 * if 90% or more of the device storage is filled up.
3291 * @hide
3292 */
3293 public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
3294 "sys_storage_threshold_percentage";
3295
3296 /**
Dianne Hackborn247fe742011-01-08 17:25:57 -08003297 * Maximum byte size of the low storage threshold. This is to ensure
3298 * that {@link #SYS_STORAGE_THRESHOLD_PERCENTAGE} does not result in
3299 * an overly large threshold for large storage devices. Currently this
3300 * must be less than 2GB. This default is 500MB.
3301 * @hide
3302 */
3303 public static final String SYS_STORAGE_THRESHOLD_MAX_BYTES =
3304 "sys_storage_threshold_max_bytes";
3305
3306 /**
Jake Hambybb371632010-08-23 18:16:48 -07003307 * Minimum bytes of free storage on the device before the data
3308 * partition is considered full. By default, 1 MB is reserved
3309 * to avoid system-wide SQLite disk full exceptions.
3310 * @hide
3311 */
3312 public static final String SYS_STORAGE_FULL_THRESHOLD_BYTES =
3313 "sys_storage_full_threshold_bytes";
3314
3315 /**
Doug Zongker43866e02010-01-07 12:09:54 -08003316 * The interval in milliseconds after which Wi-Fi is considered idle.
3317 * When idle, it is possible for the device to be switched from Wi-Fi to
3318 * the mobile data network.
3319 * @hide
3320 */
3321 public static final String WIFI_IDLE_MS = "wifi_idle_ms";
3322
3323 /**
Irfan Sheriff2b7f6382011-03-25 14:29:19 -07003324 * The interval in milliseconds to issue wake up scans when wifi needs
3325 * to connect. This is necessary to connect to an access point when
3326 * device is on the move and the screen is off.
Irfan Sheriff4f5f7c92010-10-14 17:01:27 -07003327 * @hide
3328 */
Irfan Sheriff2b7f6382011-03-25 14:29:19 -07003329 public static final String WIFI_FRAMEWORK_SCAN_INTERVAL_MS =
3330 "wifi_framework_scan_interval_ms";
3331
3332 /**
3333 * The interval in milliseconds to scan as used by the wifi supplicant
3334 * @hide
3335 */
3336 public static final String WIFI_SUPPLICANT_SCAN_INTERVAL_MS =
3337 "wifi_supplicant_scan_interval_ms";
Irfan Sheriff4f5f7c92010-10-14 17:01:27 -07003338
3339 /**
Doug Zongkeredc51892010-01-07 13:51:16 -08003340 * The interval in milliseconds at which to check packet counts on the
3341 * mobile data interface when screen is on, to detect possible data
3342 * connection problems.
3343 * @hide
3344 */
3345 public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
3346 "pdp_watchdog_poll_interval_ms";
3347
3348 /**
3349 * The interval in milliseconds at which to check packet counts on the
3350 * mobile data interface when screen is off, to detect possible data
3351 * connection problems.
3352 * @hide
3353 */
3354 public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
3355 "pdp_watchdog_long_poll_interval_ms";
3356
3357 /**
3358 * The interval in milliseconds at which to check packet counts on the
3359 * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
3360 * outgoing packets has been reached without incoming packets.
3361 * @hide
3362 */
3363 public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
3364 "pdp_watchdog_error_poll_interval_ms";
3365
3366 /**
3367 * The number of outgoing packets sent without seeing an incoming packet
3368 * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
3369 * device is logged to the event log
3370 * @hide
3371 */
3372 public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
3373 "pdp_watchdog_trigger_packet_count";
3374
3375 /**
3376 * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
3377 * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
3378 * attempting data connection recovery.
3379 * @hide
3380 */
3381 public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
3382 "pdp_watchdog_error_poll_count";
3383
3384 /**
3385 * The number of failed PDP reset attempts before moving to something more
3386 * drastic: re-registering to the network.
3387 * @hide
3388 */
3389 public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
3390 "pdp_watchdog_max_pdp_reset_fail_count";
3391
3392 /**
Doug Zongkeredc51892010-01-07 13:51:16 -08003393 * The interval in milliseconds at which to check gprs registration
3394 * after the first registration mismatch of gprs and voice service,
3395 * to detect possible data network registration problems.
3396 *
3397 * @hide
3398 */
3399 public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
3400 "gprs_register_check_period_ms";
3401
3402 /**
3403 * The length of time in milli-seconds that automatic small adjustments to
3404 * SystemClock are ignored if NITZ_UPDATE_DIFF is not exceeded.
3405 * @hide
3406 */
3407 public static final String NITZ_UPDATE_SPACING = "nitz_update_spacing";
3408
3409 /**
3410 * If the NITZ_UPDATE_DIFF time is exceeded then an automatic adjustment
3411 * to SystemClock will be allowed even if NITZ_UPDATE_SPACING has not been
3412 * exceeded.
3413 * @hide
3414 */
3415 public static final String NITZ_UPDATE_DIFF = "nitz_update_diff";
3416
3417 /**
3418 * The maximum reconnect delay for short network outages or when the network is suspended
3419 * due to phone use.
3420 * @hide
3421 */
3422 public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
3423 "sync_max_retry_delay_in_seconds";
3424
3425 /**
3426 * The interval in milliseconds at which to check the number of SMS sent
3427 * out without asking for use permit, to limit the un-authorized SMS
3428 * usage.
3429 * @hide
3430 */
3431 public static final String SMS_OUTGOING_CHECK_INTERVAL_MS =
3432 "sms_outgoing_check_interval_ms";
3433
3434 /**
3435 * The number of outgoing SMS sent without asking for user permit
3436 * (of {@link #SMS_OUTGOING_CHECK_INTERVAL_MS}
3437 * @hide
3438 */
3439 public static final String SMS_OUTGOING_CHECK_MAX_COUNT =
3440 "sms_outgoing_check_max_count";
3441
3442 /**
Doug Zongkeraed8f8e2010-01-07 18:07:50 -08003443 * The number of promoted sources in GlobalSearch.
3444 * @hide
3445 */
3446 public static final String SEARCH_NUM_PROMOTED_SOURCES = "search_num_promoted_sources";
3447 /**
3448 * The maximum number of suggestions returned by GlobalSearch.
3449 * @hide
3450 */
3451 public static final String SEARCH_MAX_RESULTS_TO_DISPLAY = "search_max_results_to_display";
3452 /**
3453 * The number of suggestions GlobalSearch will ask each non-web search source for.
3454 * @hide
3455 */
3456 public static final String SEARCH_MAX_RESULTS_PER_SOURCE = "search_max_results_per_source";
3457 /**
3458 * The number of suggestions the GlobalSearch will ask the web search source for.
3459 * @hide
3460 */
3461 public static final String SEARCH_WEB_RESULTS_OVERRIDE_LIMIT =
3462 "search_web_results_override_limit";
3463 /**
3464 * The number of milliseconds that GlobalSearch will wait for suggestions from
3465 * promoted sources before continuing with all other sources.
3466 * @hide
3467 */
3468 public static final String SEARCH_PROMOTED_SOURCE_DEADLINE_MILLIS =
3469 "search_promoted_source_deadline_millis";
3470 /**
3471 * The number of milliseconds before GlobalSearch aborts search suggesiton queries.
3472 * @hide
3473 */
3474 public static final String SEARCH_SOURCE_TIMEOUT_MILLIS = "search_source_timeout_millis";
3475 /**
3476 * The maximum number of milliseconds that GlobalSearch shows the previous results
3477 * after receiving a new query.
3478 * @hide
3479 */
3480 public static final String SEARCH_PREFILL_MILLIS = "search_prefill_millis";
3481 /**
3482 * The maximum age of log data used for shortcuts in GlobalSearch.
3483 * @hide
3484 */
3485 public static final String SEARCH_MAX_STAT_AGE_MILLIS = "search_max_stat_age_millis";
3486 /**
3487 * The maximum age of log data used for source ranking in GlobalSearch.
3488 * @hide
3489 */
3490 public static final String SEARCH_MAX_SOURCE_EVENT_AGE_MILLIS =
3491 "search_max_source_event_age_millis";
3492 /**
3493 * The minimum number of impressions needed to rank a source in GlobalSearch.
3494 * @hide
3495 */
3496 public static final String SEARCH_MIN_IMPRESSIONS_FOR_SOURCE_RANKING =
3497 "search_min_impressions_for_source_ranking";
3498 /**
3499 * The minimum number of clicks needed to rank a source in GlobalSearch.
3500 * @hide
3501 */
3502 public static final String SEARCH_MIN_CLICKS_FOR_SOURCE_RANKING =
3503 "search_min_clicks_for_source_ranking";
3504 /**
3505 * The maximum number of shortcuts shown by GlobalSearch.
3506 * @hide
3507 */
3508 public static final String SEARCH_MAX_SHORTCUTS_RETURNED = "search_max_shortcuts_returned";
3509 /**
3510 * The size of the core thread pool for suggestion queries in GlobalSearch.
3511 * @hide
3512 */
3513 public static final String SEARCH_QUERY_THREAD_CORE_POOL_SIZE =
3514 "search_query_thread_core_pool_size";
3515 /**
3516 * The maximum size of the thread pool for suggestion queries in GlobalSearch.
3517 * @hide
3518 */
3519 public static final String SEARCH_QUERY_THREAD_MAX_POOL_SIZE =
3520 "search_query_thread_max_pool_size";
3521 /**
3522 * The size of the core thread pool for shortcut refreshing in GlobalSearch.
3523 * @hide
3524 */
3525 public static final String SEARCH_SHORTCUT_REFRESH_CORE_POOL_SIZE =
3526 "search_shortcut_refresh_core_pool_size";
3527 /**
3528 * The maximum size of the thread pool for shortcut refreshing in GlobalSearch.
3529 * @hide
3530 */
3531 public static final String SEARCH_SHORTCUT_REFRESH_MAX_POOL_SIZE =
3532 "search_shortcut_refresh_max_pool_size";
3533 /**
3534 * The maximun time that excess threads in the GlobalSeach thread pools will
3535 * wait before terminating.
3536 * @hide
3537 */
3538 public static final String SEARCH_THREAD_KEEPALIVE_SECONDS =
3539 "search_thread_keepalive_seconds";
3540 /**
3541 * The maximum number of concurrent suggestion queries to each source.
3542 * @hide
3543 */
3544 public static final String SEARCH_PER_SOURCE_CONCURRENT_QUERY_LIMIT =
3545 "search_per_source_concurrent_query_limit";
3546
San Mehat87734d32010-01-08 12:53:06 -08003547 /**
3548 * Whether or not alert sounds are played on MountService events. (0 = false, 1 = true)
3549 * @hide
3550 */
3551 public static final String MOUNT_PLAY_NOTIFICATION_SND = "mount_play_not_snd";
3552
3553 /**
3554 * Whether or not UMS auto-starts on UMS host detection. (0 = false, 1 = true)
3555 * @hide
3556 */
3557 public static final String MOUNT_UMS_AUTOSTART = "mount_ums_autostart";
3558
3559 /**
3560 * Whether or not a notification is displayed on UMS host detection. (0 = false, 1 = true)
3561 * @hide
3562 */
3563 public static final String MOUNT_UMS_PROMPT = "mount_ums_prompt";
3564
3565 /**
3566 * Whether or not a notification is displayed while UMS is enabled. (0 = false, 1 = true)
3567 * @hide
3568 */
3569 public static final String MOUNT_UMS_NOTIFY_ENABLED = "mount_ums_notify_enabled";
Doug Zongkeraed8f8e2010-01-07 18:07:50 -08003570
Dan Egnor42471dd2010-01-07 17:25:22 -08003571 /**
3572 * If nonzero, ANRs in invisible background processes bring up a dialog.
3573 * Otherwise, the process will be silently killed.
3574 * @hide
3575 */
3576 public static final String ANR_SHOW_BACKGROUND = "anr_show_background";
Erikeebc8e22010-02-18 13:27:19 -08003577
Mike LeBeau5d34e9b2010-02-10 19:34:56 -08003578 /**
3579 * The {@link ComponentName} string of the service to be used as the voice recognition
3580 * service.
Erikeebc8e22010-02-18 13:27:19 -08003581 *
Mike LeBeau5d34e9b2010-02-10 19:34:56 -08003582 * @hide
3583 */
3584 public static final String VOICE_RECOGNITION_SERVICE = "voice_recognition_service";
Dan Egnor42471dd2010-01-07 17:25:22 -08003585
Doug Zongkeraed8f8e2010-01-07 18:07:50 -08003586 /**
David Brown458e8062010-03-08 21:52:11 -08003587 * What happens when the user presses the Power button while in-call
3588 * and the screen is on.<br/>
3589 * <b>Values:</b><br/>
3590 * 1 - The Power button turns off the screen and locks the device. (Default behavior)<br/>
3591 * 2 - The Power button hangs up the current call.<br/>
3592 *
3593 * @hide
3594 */
3595 public static final String INCALL_POWER_BUTTON_BEHAVIOR = "incall_power_button_behavior";
3596
3597 /**
3598 * INCALL_POWER_BUTTON_BEHAVIOR value for "turn off screen".
3599 * @hide
3600 */
3601 public static final int INCALL_POWER_BUTTON_BEHAVIOR_SCREEN_OFF = 0x1;
3602
3603 /**
3604 * INCALL_POWER_BUTTON_BEHAVIOR value for "hang up".
3605 * @hide
3606 */
3607 public static final int INCALL_POWER_BUTTON_BEHAVIOR_HANGUP = 0x2;
3608
3609 /**
3610 * INCALL_POWER_BUTTON_BEHAVIOR default value.
3611 * @hide
3612 */
3613 public static final int INCALL_POWER_BUTTON_BEHAVIOR_DEFAULT =
3614 INCALL_POWER_BUTTON_BEHAVIOR_SCREEN_OFF;
3615
3616 /**
Dianne Hackborn2ccda4d2010-03-22 21:49:15 -07003617 * The current night mode that has been selected by the user. Owned
3618 * and controlled by UiModeManagerService. Constants are as per
3619 * UiModeManager.
3620 * @hide
3621 */
3622 public static final String UI_NIGHT_MODE = "ui_night_mode";
Suchi Amalapurapu40e47252010-04-07 16:15:50 -07003623
3624 /**
3625 * Let user pick default install location.
3626 * @hide
3627 */
3628 public static final String SET_INSTALL_LOCATION = "set_install_location";
3629
3630 /**
3631 * Default install location value.
3632 * 0 = auto, let system decide
3633 * 1 = internal
3634 * 2 = sdcard
3635 * @hide
3636 */
3637 public static final String DEFAULT_INSTALL_LOCATION = "default_install_location";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003638
3639 /**
3640 * The bandwidth throttle polling freqency in seconds
3641 * @hide
3642 */
3643 public static final String THROTTLE_POLLING_SEC = "throttle_polling_sec";
3644
3645 /**
3646 * The bandwidth throttle threshold (long)
3647 * @hide
3648 */
Robert Greenwaltd3bb93f2010-04-12 19:20:55 -07003649 public static final String THROTTLE_THRESHOLD_BYTES = "throttle_threshold_bytes";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003650
3651 /**
3652 * The bandwidth throttle value (kbps)
3653 * @hide
3654 */
Robert Greenwaltd3bb93f2010-04-12 19:20:55 -07003655 public static final String THROTTLE_VALUE_KBITSPS = "throttle_value_kbitsps";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003656
3657 /**
3658 * The bandwidth throttle reset calendar day (1-28)
3659 * @hide
3660 */
3661 public static final String THROTTLE_RESET_DAY = "throttle_reset_day";
3662
3663 /**
3664 * The throttling notifications we should send
3665 * @hide
3666 */
3667 public static final String THROTTLE_NOTIFICATION_TYPE = "throttle_notification_type";
3668
3669 /**
Irfan Sheriffc9b68512010-04-08 14:12:33 -07003670 * Help URI for data throttling policy
3671 * @hide
3672 */
3673 public static final String THROTTLE_HELP_URI = "throttle_help_uri";
3674
Robert Greenwaltd1055a22010-05-25 15:54:52 -07003675 /**
3676 * The length of time in Sec that we allow our notion of NTP time
3677 * to be cached before we refresh it
3678 * @hide
3679 */
3680 public static final String THROTTLE_MAX_NTP_CACHE_AGE_SEC =
3681 "throttle_max_ntp_cache_age_sec";
3682
Steve Howard9c4e33e2010-07-28 15:59:29 -07003683 /**
3684 * The maximum size, in bytes, of a download that the download manager will transfer over
3685 * a non-wifi connection.
3686 * @hide
3687 */
3688 public static final String DOWNLOAD_MAX_BYTES_OVER_MOBILE =
3689 "download_manager_max_bytes_over_mobile";
3690
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07003691 /**
Steve Howardf1766812010-09-17 16:46:19 -07003692 * The recommended maximum size, in bytes, of a download that the download manager should
3693 * transfer over a non-wifi connection. Over this size, the use will be warned, but will
3694 * have the option to start the download over the mobile connection anyway.
3695 * @hide
3696 */
3697 public static final String DOWNLOAD_RECOMMENDED_MAX_BYTES_OVER_MOBILE =
3698 "download_manager_recommended_max_bytes_over_mobile";
3699
3700 /**
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07003701 * ms during which to consume extra events related to Inet connection condition
3702 * after a transtion to fully-connected
3703 * @hide
3704 */
3705 public static final String INET_CONDITION_DEBOUNCE_UP_DELAY =
3706 "inet_condition_debounce_up_delay";
3707
3708 /**
3709 * ms during which to consume extra events related to Inet connection condtion
3710 * after a transtion to partly-connected
3711 * @hide
3712 */
3713 public static final String INET_CONDITION_DEBOUNCE_DOWN_DELAY =
3714 "inet_condition_debounce_down_delay";
Irfan Sheriffc9b68512010-04-08 14:12:33 -07003715
3716 /**
Freeman Ng96be4e02011-04-07 18:21:40 -07003717 * URL to open browser on to allow user to manage a prepay account
3718 * @hide
3719 */
3720 public static final String SETUP_PREPAID_DATA_SERVICE_URL =
3721 "setup_prepaid_data_service_url";
3722
3723 /**
Freeman Ng3b9089c2011-04-22 16:42:57 -07003724 * URL to attempt a GET on to see if this is a prepay device
3725 * @hide
3726 */
3727 public static final String SETUP_PREPAID_DETECTION_TARGET_URL =
3728 "setup_prepaid_detection_target_url";
3729
3730 /**
3731 * Host to check for a redirect to after an attempt to GET
3732 * SETUP_PREPAID_DETECTION_TARGET_URL. (If we redirected there,
3733 * this is a prepaid device with zero balance.)
3734 * @hide
3735 */
3736 public static final String SETUP_PREPAID_DETECTION_REDIR_HOST =
3737 "setup_prepaid_detection_redir_host";
3738
3739 /**
Daniel Sandler0601eb72011-04-13 01:01:32 -04003740 * The user's preferred "dream" (interactive screensaver) component.
3741 *
3742 * This component will be launched by the PhoneWindowManager after the user's chosen idle
3743 * timeout (specified by {@link #DREAM_TIMEOUT}).
3744 * @hide
3745 */
3746 public static final String DREAM_COMPONENT =
3747 "dream_component";
3748
3749 /**
3750 * The delay before a "dream" is started (set to 0 to disable).
3751 * @hide
3752 */
3753 public static final String DREAM_TIMEOUT =
3754 "dream_timeout";
3755
3756 /**
-b master501eec92009-07-06 13:53:11 -07003757 * @hide
3758 */
3759 public static final String[] SETTINGS_TO_BACKUP = {
Amith Yamasani8823c0a82009-07-07 14:30:17 -07003760 ADB_ENABLED,
3761 ALLOW_MOCK_LOCATION,
-b master501eec92009-07-06 13:53:11 -07003762 PARENTAL_CONTROL_ENABLED,
3763 PARENTAL_CONTROL_REDIRECT_URL,
3764 USB_MASS_STORAGE_ENABLED,
3765 ACCESSIBILITY_ENABLED,
Svetoslav Ganov585f13f8d2010-08-10 07:59:15 -07003766 ACCESSIBILITY_SCRIPT_INJECTION,
Christopher Tate14c2d792010-02-25 16:49:44 -08003767 BACKUP_AUTO_RESTORE,
-b master501eec92009-07-06 13:53:11 -07003768 ENABLED_ACCESSIBILITY_SERVICES,
3769 TTS_USE_DEFAULTS,
3770 TTS_DEFAULT_RATE,
3771 TTS_DEFAULT_PITCH,
3772 TTS_DEFAULT_SYNTH,
3773 TTS_DEFAULT_LANG,
3774 TTS_DEFAULT_COUNTRY,
Charles Chenceffa152010-03-16 21:18:10 -07003775 TTS_ENABLED_PLUGINS,
-b master501eec92009-07-06 13:53:11 -07003776 WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON,
3777 WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY,
-b master501eec92009-07-06 13:53:11 -07003778 WIFI_NUM_OPEN_NETWORKS_KEPT,
San Mehat87734d32010-01-08 12:53:06 -08003779 MOUNT_PLAY_NOTIFICATION_SND,
3780 MOUNT_UMS_AUTOSTART,
3781 MOUNT_UMS_PROMPT,
Dianne Hackborn2ccda4d2010-03-22 21:49:15 -07003782 MOUNT_UMS_NOTIFY_ENABLED,
3783 UI_NIGHT_MODE
-b master501eec92009-07-06 13:53:11 -07003784 };
3785
3786 /**
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003787 * Helper method for determining if a location provider is enabled.
3788 * @param cr the content resolver to use
3789 * @param provider the location provider to query
3790 * @return true if the provider is enabled
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003791 */
3792 public static final boolean isLocationProviderEnabled(ContentResolver cr, String provider) {
3793 String allowedProviders = Settings.Secure.getString(cr, LOCATION_PROVIDERS_ALLOWED);
Brad Fitzpatrick11fe1812010-09-10 16:07:52 -07003794 return TextUtils.delimitedStringContains(allowedProviders, ',', provider);
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003795 }
3796
3797 /**
3798 * Thread-safe method for enabling or disabling a single location provider.
3799 * @param cr the content resolver to use
3800 * @param provider the location provider to enable or disable
3801 * @param enabled true if the provider should be enabled
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07003802 */
3803 public static final void setLocationProviderEnabled(ContentResolver cr,
3804 String provider, boolean enabled) {
3805 // to ensure thread safety, we write the provider name with a '+' or '-'
3806 // and let the SettingsProvider handle it rather than reading and modifying
3807 // the list of enabled providers.
3808 if (enabled) {
3809 provider = "+" + provider;
3810 } else {
3811 provider = "-" + provider;
3812 }
3813 putString(cr, Settings.Secure.LOCATION_PROVIDERS_ALLOWED, provider);
3814 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003815 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003816
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003817 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003818 * User-defined bookmarks and shortcuts. The target of each bookmark is an
3819 * Intent URL, allowing it to be either a web page or a particular
3820 * application activity.
3821 *
3822 * @hide
3823 */
3824 public static final class Bookmarks implements BaseColumns
3825 {
3826 private static final String TAG = "Bookmarks";
3827
3828 /**
3829 * The content:// style URL for this table
3830 */
3831 public static final Uri CONTENT_URI =
3832 Uri.parse("content://" + AUTHORITY + "/bookmarks");
3833
3834 /**
3835 * The row ID.
3836 * <p>Type: INTEGER</p>
3837 */
3838 public static final String ID = "_id";
3839
3840 /**
3841 * Descriptive name of the bookmark that can be displayed to the user.
3842 * If this is empty, the title should be resolved at display time (use
3843 * {@link #getTitle(Context, Cursor)} any time you want to display the
3844 * title of a bookmark.)
3845 * <P>
3846 * Type: TEXT
3847 * </P>
3848 */
3849 public static final String TITLE = "title";
3850
3851 /**
3852 * Arbitrary string (displayed to the user) that allows bookmarks to be
3853 * organized into categories. There are some special names for
3854 * standard folders, which all start with '@'. The label displayed for
3855 * the folder changes with the locale (via {@link #getLabelForFolder}) but
3856 * the folder name does not change so you can consistently query for
3857 * the folder regardless of the current locale.
3858 *
3859 * <P>Type: TEXT</P>
3860 *
3861 */
3862 public static final String FOLDER = "folder";
3863
3864 /**
3865 * The Intent URL of the bookmark, describing what it points to. This
3866 * value is given to {@link android.content.Intent#getIntent} to create
3867 * an Intent that can be launched.
3868 * <P>Type: TEXT</P>
3869 */
3870 public static final String INTENT = "intent";
3871
3872 /**
3873 * Optional shortcut character associated with this bookmark.
3874 * <P>Type: INTEGER</P>
3875 */
3876 public static final String SHORTCUT = "shortcut";
3877
3878 /**
3879 * The order in which the bookmark should be displayed
3880 * <P>Type: INTEGER</P>
3881 */
3882 public static final String ORDERING = "ordering";
3883
3884 private static final String[] sIntentProjection = { INTENT };
3885 private static final String[] sShortcutProjection = { ID, SHORTCUT };
3886 private static final String sShortcutSelection = SHORTCUT + "=?";
3887
3888 /**
3889 * Convenience function to retrieve the bookmarked Intent for a
3890 * particular shortcut key.
3891 *
3892 * @param cr The ContentResolver to query.
3893 * @param shortcut The shortcut key.
3894 *
3895 * @return Intent The bookmarked URL, or null if there is no bookmark
3896 * matching the given shortcut.
3897 */
3898 public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3899 {
3900 Intent intent = null;
3901
3902 Cursor c = cr.query(CONTENT_URI,
3903 sIntentProjection, sShortcutSelection,
3904 new String[] { String.valueOf((int) shortcut) }, ORDERING);
3905 // Keep trying until we find a valid shortcut
3906 try {
3907 while (intent == null && c.moveToNext()) {
3908 try {
3909 String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
Christian Mehlmauera34d2c92010-05-25 19:04:20 +02003910 intent = Intent.parseUri(intentURI, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003911 } catch (java.net.URISyntaxException e) {
3912 // The stored URL is bad... ignore it.
3913 } catch (IllegalArgumentException e) {
3914 // Column not found
Dianne Hackborna33e3f72009-09-29 17:28:24 -07003915 Log.w(TAG, "Intent column not found", e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003916 }
3917 }
3918 } finally {
3919 if (c != null) c.close();
3920 }
3921
3922 return intent;
3923 }
3924
3925 /**
3926 * Add a new bookmark to the system.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003927 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003928 * @param cr The ContentResolver to query.
3929 * @param intent The desired target of the bookmark.
3930 * @param title Bookmark title that is shown to the user; null if none
3931 * or it should be resolved to the intent's title.
3932 * @param folder Folder in which to place the bookmark; null if none.
3933 * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3934 * this is non-zero and there is an existing bookmark entry
3935 * with this same shortcut, then that existing shortcut is
3936 * cleared (the bookmark is not removed).
3937 * @return The unique content URL for the new bookmark entry.
3938 */
3939 public static Uri add(ContentResolver cr,
3940 Intent intent,
3941 String title,
3942 String folder,
3943 char shortcut,
3944 int ordering)
3945 {
3946 // If a shortcut is supplied, and it is already defined for
3947 // another bookmark, then remove the old definition.
3948 if (shortcut != 0) {
Jeff Hamilton7cd51ef2010-05-12 17:30:27 -05003949 cr.delete(CONTENT_URI, sShortcutSelection,
3950 new String[] { String.valueOf((int) shortcut) });
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003951 }
3952
3953 ContentValues values = new ContentValues();
3954 if (title != null) values.put(TITLE, title);
3955 if (folder != null) values.put(FOLDER, folder);
Jean-Baptiste Queru3b9f0a32010-06-21 13:46:59 -07003956 values.put(INTENT, intent.toUri(0));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003957 if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3958 values.put(ORDERING, ordering);
3959 return cr.insert(CONTENT_URI, values);
3960 }
3961
3962 /**
3963 * Return the folder name as it should be displayed to the user. This
3964 * takes care of localizing special folders.
3965 *
3966 * @param r Resources object for current locale; only need access to
3967 * system resources.
3968 * @param folder The value found in the {@link #FOLDER} column.
3969 *
3970 * @return CharSequence The label for this folder that should be shown
3971 * to the user.
3972 */
3973 public static CharSequence getLabelForFolder(Resources r, String folder) {
3974 return folder;
3975 }
3976
3977 /**
3978 * Return the title as it should be displayed to the user. This takes
3979 * care of localizing bookmarks that point to activities.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003980 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003981 * @param context A context.
3982 * @param cursor A cursor pointing to the row whose title should be
3983 * returned. The cursor must contain at least the {@link #TITLE}
3984 * and {@link #INTENT} columns.
3985 * @return A title that is localized and can be displayed to the user,
3986 * or the empty string if one could not be found.
3987 */
3988 public static CharSequence getTitle(Context context, Cursor cursor) {
3989 int titleColumn = cursor.getColumnIndex(TITLE);
3990 int intentColumn = cursor.getColumnIndex(INTENT);
3991 if (titleColumn == -1 || intentColumn == -1) {
3992 throw new IllegalArgumentException(
3993 "The cursor must contain the TITLE and INTENT columns.");
3994 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003995
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003996 String title = cursor.getString(titleColumn);
3997 if (!TextUtils.isEmpty(title)) {
3998 return title;
3999 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07004000
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004001 String intentUri = cursor.getString(intentColumn);
4002 if (TextUtils.isEmpty(intentUri)) {
4003 return "";
4004 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07004005
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004006 Intent intent;
4007 try {
Christian Mehlmauera34d2c92010-05-25 19:04:20 +02004008 intent = Intent.parseUri(intentUri, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004009 } catch (URISyntaxException e) {
4010 return "";
4011 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07004012
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004013 PackageManager packageManager = context.getPackageManager();
4014 ResolveInfo info = packageManager.resolveActivity(intent, 0);
4015 return info != null ? info.loadLabel(packageManager) : "";
4016 }
4017 }
4018
4019 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004020 * Returns the device ID that we should use when connecting to the mobile gtalk server.
4021 * This is a string like "android-0x1242", where the hex string is the Android ID obtained
4022 * from the GoogleLoginService.
4023 *
4024 * @param androidId The Android ID for this device.
4025 * @return The device ID that should be used when connecting to the mobile gtalk server.
4026 * @hide
4027 */
4028 public static String getGTalkDeviceId(long androidId) {
4029 return "android-" + Long.toHexString(androidId);
4030 }
4031}