blob: 0d27e1ec1ec4b9b521a8c30aaec8b9b88e9e3cd3 [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
19import com.google.android.collect.Maps;
20
21import org.apache.commons.codec.binary.Base64;
22
23import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
25import android.content.ContentQueryMap;
26import android.content.ContentResolver;
27import android.content.ContentValues;
28import android.content.Context;
29import android.content.Intent;
30import 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;
37import android.os.*;
38import android.telephony.TelephonyManager;
39import android.text.TextUtils;
40import android.util.AndroidException;
41import android.util.Log;
42
43import java.net.URISyntaxException;
44import java.security.MessageDigest;
45import java.security.NoSuchAlgorithmException;
46import java.util.HashMap;
47import java.util.HashSet;
48
49
50/**
51 * The Settings provider contains global system-level device preferences.
52 */
53public final class Settings {
54
55 // Intent actions for Settings
56
57 /**
58 * Activity Action: Show system settings.
59 * <p>
60 * Input: Nothing.
61 * <p>
62 * Output: nothing.
63 */
64 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
65 public static final String ACTION_SETTINGS = "android.settings.SETTINGS";
66
67 /**
68 * Activity Action: Show settings to allow configuration of APNs.
69 * <p>
70 * Input: Nothing.
71 * <p>
72 * Output: nothing.
73 */
74 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
75 public static final String ACTION_APN_SETTINGS = "android.settings.APN_SETTINGS";
76
77 /**
78 * Activity Action: Show settings to allow configuration of current location
79 * sources.
80 * <p>
81 * In some cases, a matching Activity may not exist, so ensure you
82 * safeguard against this.
83 * <p>
84 * Input: Nothing.
85 * <p>
86 * Output: Nothing.
87 */
88 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
89 public static final String ACTION_LOCATION_SOURCE_SETTINGS =
90 "android.settings.LOCATION_SOURCE_SETTINGS";
91
92 /**
93 * Activity Action: Show settings to allow configuration of wireless controls
94 * such as Wi-Fi, Bluetooth and Mobile networks.
95 * <p>
96 * In some cases, a matching Activity may not exist, so ensure you
97 * safeguard against this.
98 * <p>
99 * Input: Nothing.
100 * <p>
101 * Output: Nothing.
102 */
103 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
104 public static final String ACTION_WIRELESS_SETTINGS =
105 "android.settings.WIRELESS_SETTINGS";
106
107 /**
108 * Activity Action: Show settings to allow entering/exiting airplane mode.
109 * <p>
110 * In some cases, a matching Activity may not exist, so ensure you
111 * safeguard against this.
112 * <p>
113 * Input: Nothing.
114 * <p>
115 * Output: Nothing.
116 */
117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
118 public static final String ACTION_AIRPLANE_MODE_SETTINGS =
119 "android.settings.AIRPLANE_MODE_SETTINGS";
120
121 /**
122 * Activity Action: Show settings to allow configuration of security and
123 * location privacy.
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_SECURITY_SETTINGS =
134 "android.settings.SECURITY_SETTINGS";
135
136 /**
137 * Activity Action: Show settings to allow configuration of Wi-Fi.
138
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 */
148 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
149 public static final String ACTION_WIFI_SETTINGS =
150 "android.settings.WIFI_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700151
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800152 /**
153 * Activity Action: Show settings to allow configuration of a static IP
154 * address for Wi-Fi.
155 * <p>
156 * In some cases, a matching Activity may not exist, so ensure you safeguard
157 * against this.
158 * <p>
159 * Input: Nothing.
160 * <p>
161 * Output: Nothing.
162 */
163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
164 public static final String ACTION_WIFI_IP_SETTINGS =
165 "android.settings.WIFI_IP_SETTINGS";
166
167 /**
168 * Activity Action: Show settings to allow configuration of Bluetooth.
169 * <p>
170 * In some cases, a matching Activity may not exist, so ensure you
171 * safeguard against this.
172 * <p>
173 * Input: Nothing.
174 * <p>
175 * Output: Nothing.
176 */
177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
178 public static final String ACTION_BLUETOOTH_SETTINGS =
179 "android.settings.BLUETOOTH_SETTINGS";
180
181 /**
182 * Activity Action: Show settings to allow configuration of date and time.
183 * <p>
184 * In some cases, a matching Activity may not exist, so ensure you
185 * safeguard against this.
186 * <p>
187 * Input: Nothing.
188 * <p>
189 * Output: Nothing.
190 */
191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
192 public static final String ACTION_DATE_SETTINGS =
193 "android.settings.DATE_SETTINGS";
194
195 /**
196 * Activity Action: Show settings to allow configuration of sound and volume.
197 * <p>
198 * In some cases, a matching Activity may not exist, so ensure you
199 * safeguard against this.
200 * <p>
201 * Input: Nothing.
202 * <p>
203 * Output: Nothing.
204 */
205 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
206 public static final String ACTION_SOUND_SETTINGS =
207 "android.settings.SOUND_SETTINGS";
208
209 /**
210 * Activity Action: Show settings to allow configuration of display.
211 * <p>
212 * In some cases, a matching Activity may not exist, so ensure you
213 * safeguard against this.
214 * <p>
215 * Input: Nothing.
216 * <p>
217 * Output: Nothing.
218 */
219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
220 public static final String ACTION_DISPLAY_SETTINGS =
221 "android.settings.DISPLAY_SETTINGS";
222
223 /**
224 * Activity Action: Show settings to allow configuration of locale.
225 * <p>
226 * In some cases, a matching Activity may not exist, so ensure you
227 * safeguard against this.
228 * <p>
229 * Input: Nothing.
230 * <p>
231 * Output: Nothing.
232 */
233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
234 public static final String ACTION_LOCALE_SETTINGS =
235 "android.settings.LOCALE_SETTINGS";
236
237 /**
238 * Activity Action: Show settings to configure input methods, in particular
239 * allowing the user to enable input methods.
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_INPUT_METHOD_SETTINGS =
250 "android.settings.INPUT_METHOD_SETTINGS";
251
252 /**
253 * Activity Action: Show settings to manage the user input dictionary.
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_USER_DICTIONARY_SETTINGS =
264 "android.settings.USER_DICTIONARY_SETTINGS";
265
266 /**
267 * Activity Action: Show settings to allow configuration of application-related settings.
268 * <p>
269 * In some cases, a matching Activity may not exist, so ensure you
270 * safeguard against this.
271 * <p>
272 * Input: Nothing.
273 * <p>
274 * Output: Nothing.
275 */
276 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
277 public static final String ACTION_APPLICATION_SETTINGS =
278 "android.settings.APPLICATION_SETTINGS";
279
280 /**
281 * Activity Action: Show settings to allow configuration of application
282 * development-related settings.
283 * <p>
284 * In some cases, a matching Activity may not exist, so ensure you safeguard
285 * against this.
286 * <p>
287 * Input: Nothing.
288 * <p>
289 * Output: Nothing.
290 */
291 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
292 public static final String ACTION_APPLICATION_DEVELOPMENT_SETTINGS =
293 "android.settings.APPLICATION_DEVELOPMENT_SETTINGS";
294
295 /**
296 * Activity Action: Show settings to allow configuration of quick launch shortcuts.
297 * <p>
298 * In some cases, a matching Activity may not exist, so ensure you
299 * safeguard against this.
300 * <p>
301 * Input: Nothing.
302 * <p>
303 * Output: Nothing.
304 */
305 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
306 public static final String ACTION_QUICK_LAUNCH_SETTINGS =
307 "android.settings.QUICK_LAUNCH_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700308
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800309 /**
310 * Activity Action: Show settings to manage installed applications.
311 * <p>
312 * In some cases, a matching Activity may not exist, so ensure you
313 * safeguard against this.
314 * <p>
315 * Input: Nothing.
316 * <p>
317 * Output: Nothing.
318 */
319 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
320 public static final String ACTION_MANAGE_APPLICATIONS_SETTINGS =
321 "android.settings.MANAGE_APPLICATIONS_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700322
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800323 /**
324 * Activity Action: Show settings for system update functionality.
325 * <p>
326 * In some cases, a matching Activity may not exist, so ensure you
327 * safeguard against this.
328 * <p>
329 * Input: Nothing.
330 * <p>
331 * Output: Nothing.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700332 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800333 * @hide
334 */
335 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
336 public static final String ACTION_SYSTEM_UPDATE_SETTINGS =
337 "android.settings.SYSTEM_UPDATE_SETTINGS";
338
339 /**
340 * Activity Action: Show settings to allow configuration of sync settings.
341 * <p>
342 * In some cases, a matching Activity may not exist, so ensure you
343 * safeguard against this.
344 * <p>
345 * Input: Nothing.
346 * <p>
347 * Output: Nothing.
348 */
349 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
350 public static final String ACTION_SYNC_SETTINGS =
351 "android.settings.SYNC_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700352
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800353 /**
354 * Activity Action: Show settings for selecting the network operator.
355 * <p>
356 * In some cases, a matching Activity may not exist, so ensure you
357 * safeguard against this.
358 * <p>
359 * Input: Nothing.
360 * <p>
361 * Output: Nothing.
362 */
363 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
364 public static final String ACTION_NETWORK_OPERATOR_SETTINGS =
365 "android.settings.NETWORK_OPERATOR_SETTINGS";
366
367 /**
368 * Activity Action: Show settings for selection of 2G/3G.
369 * <p>
370 * In some cases, a matching Activity may not exist, so ensure you
371 * safeguard against this.
372 * <p>
373 * Input: Nothing.
374 * <p>
375 * Output: Nothing.
376 */
377 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
378 public static final String ACTION_DATA_ROAMING_SETTINGS =
379 "android.settings.DATA_ROAMING_SETTINGS";
380
381 /**
382 * Activity Action: Show settings for internal storage.
383 * <p>
384 * In some cases, a matching Activity may not exist, so ensure you
385 * safeguard against this.
386 * <p>
387 * Input: Nothing.
388 * <p>
389 * Output: Nothing.
390 */
391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
392 public static final String ACTION_INTERNAL_STORAGE_SETTINGS =
393 "android.settings.INTERNAL_STORAGE_SETTINGS";
394 /**
395 * Activity Action: Show settings for memory card storage.
396 * <p>
397 * In some cases, a matching Activity may not exist, so ensure you
398 * safeguard against this.
399 * <p>
400 * Input: Nothing.
401 * <p>
402 * Output: Nothing.
403 */
404 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
405 public static final String ACTION_MEMORY_CARD_SETTINGS =
406 "android.settings.MEMORY_CARD_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700407
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800408 // End of Intent actions for Settings
409
410 private static final String JID_RESOURCE_PREFIX = "android";
411
412 public static final String AUTHORITY = "settings";
413
414 private static final String TAG = "Settings";
415
416 private static String sJidResource = null;
417
418 public static class SettingNotFoundException extends AndroidException {
419 public SettingNotFoundException(String msg) {
420 super(msg);
421 }
422 }
423
424 /**
425 * Common base for tables of name/value settings.
426 */
427 public static class NameValueTable implements BaseColumns {
428 public static final String NAME = "name";
429 public static final String VALUE = "value";
430
431 protected static boolean putString(ContentResolver resolver, Uri uri,
432 String name, String value) {
433 // The database will take care of replacing duplicates.
434 try {
435 ContentValues values = new ContentValues();
436 values.put(NAME, name);
437 values.put(VALUE, value);
438 resolver.insert(uri, values);
439 return true;
440 } catch (SQLException e) {
441 Log.e(TAG, "Can't set key " + name + " in " + uri, e);
442 return false;
443 }
444 }
445
446 public static Uri getUriFor(Uri uri, String name) {
447 return Uri.withAppendedPath(uri, name);
448 }
449 }
450
451 private static class NameValueCache {
452 private final String mVersionSystemProperty;
453 private final HashMap<String, String> mValues = Maps.newHashMap();
454 private long mValuesVersion = 0;
455 private final Uri mUri;
456
457 NameValueCache(String versionSystemProperty, Uri uri) {
458 mVersionSystemProperty = versionSystemProperty;
459 mUri = uri;
460 }
461
462 String getString(ContentResolver cr, String name) {
463 long newValuesVersion = SystemProperties.getLong(mVersionSystemProperty, 0);
464 if (mValuesVersion != newValuesVersion) {
465 mValues.clear();
466 mValuesVersion = newValuesVersion;
467 }
468 if (!mValues.containsKey(name)) {
469 String value = null;
470 Cursor c = null;
471 try {
472 c = cr.query(mUri, new String[] { Settings.NameValueTable.VALUE },
473 Settings.NameValueTable.NAME + "=?", new String[]{name}, null);
474 if (c != null && c.moveToNext()) value = c.getString(0);
475 mValues.put(name, value);
476 } catch (SQLException e) {
477 // SQL error: return null, but don't cache it.
478 Log.e(TAG, "Can't get key " + name + " from " + mUri, e);
479 } finally {
480 if (c != null) c.close();
481 }
482 return value;
483 } else {
484 return mValues.get(name);
485 }
486 }
487 }
488
489 /**
490 * System settings, containing miscellaneous system preferences. This
491 * table holds simple name/value pairs. There are convenience
492 * functions for accessing individual settings entries.
493 */
494 public static final class System extends NameValueTable {
495 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_system_version";
496
497 private static volatile NameValueCache mNameValueCache = null;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700498
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800499 private static final HashSet<String> MOVED_TO_SECURE;
500 static {
501 MOVED_TO_SECURE = new HashSet<String>(30);
502 MOVED_TO_SECURE.add(Secure.ADB_ENABLED);
503 MOVED_TO_SECURE.add(Secure.ANDROID_ID);
504 MOVED_TO_SECURE.add(Secure.BLUETOOTH_ON);
505 MOVED_TO_SECURE.add(Secure.DATA_ROAMING);
506 MOVED_TO_SECURE.add(Secure.DEVICE_PROVISIONED);
507 MOVED_TO_SECURE.add(Secure.HTTP_PROXY);
508 MOVED_TO_SECURE.add(Secure.INSTALL_NON_MARKET_APPS);
509 MOVED_TO_SECURE.add(Secure.LOCATION_PROVIDERS_ALLOWED);
510 MOVED_TO_SECURE.add(Secure.LOGGING_ID);
511 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_ENABLED);
512 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_LAST_UPDATE);
513 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_REDIRECT_URL);
514 MOVED_TO_SECURE.add(Secure.SETTINGS_CLASSNAME);
515 MOVED_TO_SECURE.add(Secure.USB_MASS_STORAGE_ENABLED);
516 MOVED_TO_SECURE.add(Secure.USE_GOOGLE_MAIL);
517 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON);
518 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY);
519 MOVED_TO_SECURE.add(Secure.WIFI_NUM_OPEN_NETWORKS_KEPT);
520 MOVED_TO_SECURE.add(Secure.WIFI_ON);
521 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE);
522 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_AP_COUNT);
523 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS);
524 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED);
525 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS);
526 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT);
527 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_MAX_AP_CHECKS);
528 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ON);
529 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_COUNT);
530 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_DELAY_MS);
531 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS);
532 }
533
534 /**
535 * Look up a name in the database.
536 * @param resolver to access the database with
537 * @param name to look up in the table
538 * @return the corresponding value, or null if not present
539 */
540 public synchronized static String getString(ContentResolver resolver, String name) {
541 if (MOVED_TO_SECURE.contains(name)) {
542 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
543 + " to android.provider.Settings.Secure, returning read-only value.");
544 return Secure.getString(resolver, name);
545 }
546 if (mNameValueCache == null) {
547 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
548 }
549 return mNameValueCache.getString(resolver, name);
550 }
551
552 /**
553 * Store a name/value pair into the database.
554 * @param resolver to access the database with
555 * @param name to store
556 * @param value to associate with the name
557 * @return true if the value was set, false on database errors
558 */
559 public static boolean putString(ContentResolver resolver, String name, String value) {
560 if (MOVED_TO_SECURE.contains(name)) {
561 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
562 + " to android.provider.Settings.Secure, value is unchanged.");
563 return false;
564 }
565 return putString(resolver, CONTENT_URI, name, value);
566 }
567
568 /**
569 * Construct the content URI for a particular name/value pair,
570 * useful for monitoring changes with a ContentObserver.
571 * @param name to look up in the table
572 * @return the corresponding content URI, or null if not present
573 */
574 public static Uri getUriFor(String name) {
575 if (MOVED_TO_SECURE.contains(name)) {
576 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
577 + " to android.provider.Settings.Secure, returning Secure URI.");
578 return Secure.getUriFor(Secure.CONTENT_URI, name);
579 }
580 return getUriFor(CONTENT_URI, name);
581 }
582
583 /**
584 * Convenience function for retrieving a single system settings value
585 * as an integer. Note that internally setting values are always
586 * stored as strings; this function converts the string to an integer
587 * for you. The default value will be returned if the setting is
588 * not defined or not an integer.
589 *
590 * @param cr The ContentResolver to access.
591 * @param name The name of the setting to retrieve.
592 * @param def Value to return if the setting is not defined.
593 *
594 * @return The setting's current value, or 'def' if it is not defined
595 * or not a valid integer.
596 */
597 public static int getInt(ContentResolver cr, String name, int def) {
598 String v = getString(cr, name);
599 try {
600 return v != null ? Integer.parseInt(v) : def;
601 } catch (NumberFormatException e) {
602 return def;
603 }
604 }
605
606 /**
607 * Convenience function for retrieving a single system settings value
608 * as an integer. Note that internally setting values are always
609 * stored as strings; this function converts the string to an integer
610 * for you.
611 * <p>
612 * This version does not take a default value. If the setting has not
613 * been set, or the string value is not a number,
614 * it throws {@link SettingNotFoundException}.
615 *
616 * @param cr The ContentResolver to access.
617 * @param name The name of the setting to retrieve.
618 *
619 * @throws SettingNotFoundException Thrown if a setting by the given
620 * name can't be found or the setting value is not an integer.
621 *
622 * @return The setting's current value.
623 */
624 public static int getInt(ContentResolver cr, String name)
625 throws SettingNotFoundException {
626 String v = getString(cr, name);
627 try {
628 return Integer.parseInt(v);
629 } catch (NumberFormatException e) {
630 throw new SettingNotFoundException(name);
631 }
632 }
633
634 /**
635 * Convenience function for updating a single settings value as an
636 * integer. This will either create a new entry in the table if the
637 * given name does not exist, or modify the value of the existing row
638 * with that name. Note that internally setting values are always
639 * stored as strings, so this function converts the given value to a
640 * string before storing it.
641 *
642 * @param cr The ContentResolver to access.
643 * @param name The name of the setting to modify.
644 * @param value The new value for the setting.
645 * @return true if the value was set, false on database errors
646 */
647 public static boolean putInt(ContentResolver cr, String name, int value) {
648 return putString(cr, name, Integer.toString(value));
649 }
650
651 /**
652 * Convenience function for retrieving a single system settings value
653 * as a {@code long}. Note that internally setting values are always
654 * stored as strings; this function converts the string to a {@code long}
655 * for you. The default value will be returned if the setting is
656 * not defined or not a {@code long}.
657 *
658 * @param cr The ContentResolver to access.
659 * @param name The name of the setting to retrieve.
660 * @param def Value to return if the setting is not defined.
661 *
662 * @return The setting's current value, or 'def' if it is not defined
663 * or not a valid {@code long}.
664 */
665 public static long getLong(ContentResolver cr, String name, long def) {
666 String valString = getString(cr, name);
667 long value;
668 try {
669 value = valString != null ? Long.parseLong(valString) : def;
670 } catch (NumberFormatException e) {
671 value = def;
672 }
673 return value;
674 }
675
676 /**
677 * Convenience function for retrieving a single system settings value
678 * as a {@code long}. Note that internally setting values are always
679 * stored as strings; this function converts the string to a {@code long}
680 * for you.
681 * <p>
682 * This version does not take a default value. If the setting has not
683 * been set, or the string value is not a number,
684 * it throws {@link SettingNotFoundException}.
685 *
686 * @param cr The ContentResolver to access.
687 * @param name The name of the setting to retrieve.
688 *
689 * @return The setting's current value.
690 * @throws SettingNotFoundException Thrown if a setting by the given
691 * name can't be found or the setting value is not an integer.
692 */
693 public static long getLong(ContentResolver cr, String name)
694 throws SettingNotFoundException {
695 String valString = getString(cr, name);
696 try {
697 return Long.parseLong(valString);
698 } catch (NumberFormatException e) {
699 throw new SettingNotFoundException(name);
700 }
701 }
702
703 /**
704 * Convenience function for updating a single settings value as a long
705 * integer. This will either create a new entry in the table if the
706 * given name does not exist, or modify the value of the existing row
707 * with that name. Note that internally setting values are always
708 * stored as strings, so this function converts the given value to a
709 * string before storing it.
710 *
711 * @param cr The ContentResolver to access.
712 * @param name The name of the setting to modify.
713 * @param value The new value for the setting.
714 * @return true if the value was set, false on database errors
715 */
716 public static boolean putLong(ContentResolver cr, String name, long value) {
717 return putString(cr, name, Long.toString(value));
718 }
719
720 /**
721 * Convenience function for retrieving a single system settings value
722 * as a floating point number. Note that internally setting values are
723 * always stored as strings; this function converts the string to an
724 * float for you. The default value will be returned if the setting
725 * is not defined or not a valid float.
726 *
727 * @param cr The ContentResolver to access.
728 * @param name The name of the setting to retrieve.
729 * @param def Value to return if the setting is not defined.
730 *
731 * @return The setting's current value, or 'def' if it is not defined
732 * or not a valid float.
733 */
734 public static float getFloat(ContentResolver cr, String name, float def) {
735 String v = getString(cr, name);
736 try {
737 return v != null ? Float.parseFloat(v) : def;
738 } catch (NumberFormatException e) {
739 return def;
740 }
741 }
742
743 /**
744 * Convenience function for retrieving a single system settings value
745 * as a float. Note that internally setting values are always
746 * stored as strings; this function converts the string to a float
747 * for you.
748 * <p>
749 * This version does not take a default value. If the setting has not
750 * been set, or the string value is not a number,
751 * it throws {@link SettingNotFoundException}.
752 *
753 * @param cr The ContentResolver to access.
754 * @param name The name of the setting to retrieve.
755 *
756 * @throws SettingNotFoundException Thrown if a setting by the given
757 * name can't be found or the setting value is not a float.
758 *
759 * @return The setting's current value.
760 */
761 public static float getFloat(ContentResolver cr, String name)
762 throws SettingNotFoundException {
763 String v = getString(cr, name);
764 try {
765 return Float.parseFloat(v);
766 } catch (NumberFormatException e) {
767 throw new SettingNotFoundException(name);
768 }
769 }
770
771 /**
772 * Convenience function for updating a single settings value as a
773 * floating point number. This will either create a new entry in the
774 * table if the given name does not exist, or modify the value of the
775 * existing row with that name. Note that internally setting values
776 * are always stored as strings, so this function converts the given
777 * value to a string before storing it.
778 *
779 * @param cr The ContentResolver to access.
780 * @param name The name of the setting to modify.
781 * @param value The new value for the setting.
782 * @return true if the value was set, false on database errors
783 */
784 public static boolean putFloat(ContentResolver cr, String name, float value) {
785 return putString(cr, name, Float.toString(value));
786 }
787
788 /**
789 * Convenience function to read all of the current
790 * configuration-related settings into a
791 * {@link Configuration} object.
792 *
793 * @param cr The ContentResolver to access.
794 * @param outConfig Where to place the configuration settings.
795 */
796 public static void getConfiguration(ContentResolver cr, Configuration outConfig) {
797 outConfig.fontScale = Settings.System.getFloat(
798 cr, FONT_SCALE, outConfig.fontScale);
799 if (outConfig.fontScale < 0) {
800 outConfig.fontScale = 1;
801 }
802 }
803
804 /**
805 * Convenience function to write a batch of configuration-related
806 * settings from a {@link Configuration} object.
807 *
808 * @param cr The ContentResolver to access.
809 * @param config The settings to write.
810 * @return true if the values were set, false on database errors
811 */
812 public static boolean putConfiguration(ContentResolver cr, Configuration config) {
813 return Settings.System.putFloat(cr, FONT_SCALE, config.fontScale);
814 }
815
816 public static boolean getShowGTalkServiceStatus(ContentResolver cr) {
817 return getInt(cr, SHOW_GTALK_SERVICE_STATUS, 0) != 0;
818 }
819
820 public static void setShowGTalkServiceStatus(ContentResolver cr, boolean flag) {
821 putInt(cr, SHOW_GTALK_SERVICE_STATUS, flag ? 1 : 0);
822 }
823
824 /**
825 * The content:// style URL for this table
826 */
827 public static final Uri CONTENT_URI =
828 Uri.parse("content://" + AUTHORITY + "/system");
829
830 /**
831 * Whether we keep the device on while the device is plugged in.
832 * Supported values are:
833 * <ul>
834 * <li>{@code 0} to never stay on while plugged in</li>
835 * <li>{@link BatteryManager#BATTERY_PLUGGED_AC} to stay on for AC charger</li>
836 * <li>{@link BatteryManager#BATTERY_PLUGGED_USB} to stay on for USB charger</li>
837 * </ul>
838 * These values can be OR-ed together.
839 */
840 public static final String STAY_ON_WHILE_PLUGGED_IN = "stay_on_while_plugged_in";
841
842 /**
843 * What happens when the user presses the end call button if they're not
844 * on a call.<br/>
845 * <b>Values:</b><br/>
846 * 0 - The end button does nothing.<br/>
847 * 1 - The end button goes to the home screen.<br/>
848 * 2 - The end button puts the device to sleep and locks the keyguard.<br/>
849 * 3 - The end button goes to the home screen. If the user is already on the
850 * home screen, it puts the device to sleep.
851 */
852 public static final String END_BUTTON_BEHAVIOR = "end_button_behavior";
853
854 /**
855 * Whether Airplane Mode is on.
856 */
857 public static final String AIRPLANE_MODE_ON = "airplane_mode_on";
858
859 /**
860 * Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.
861 */
862 public static final String RADIO_BLUETOOTH = "bluetooth";
863
864 /**
865 * Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.
866 */
867 public static final String RADIO_WIFI = "wifi";
868
869 /**
870 * Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.
871 */
872 public static final String RADIO_CELL = "cell";
873
874 /**
875 * A comma separated list of radios that need to be disabled when airplane mode
876 * is on. This overrides WIFI_ON and BLUETOOTH_ON, if Wi-Fi and bluetooth are
877 * included in the comma separated list.
878 */
879 public static final String AIRPLANE_MODE_RADIOS = "airplane_mode_radios";
880
881 /**
882 * The policy for deciding when Wi-Fi should go to sleep (which will in
883 * turn switch to using the mobile data as an Internet connection).
884 * <p>
885 * Set to one of {@link #WIFI_SLEEP_POLICY_DEFAULT},
886 * {@link #WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED}, or
887 * {@link #WIFI_SLEEP_POLICY_NEVER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800888 */
889 public static final String WIFI_SLEEP_POLICY = "wifi_sleep_policy";
890
891 /**
892 * Value for {@link #WIFI_SLEEP_POLICY} to use the default Wi-Fi sleep
893 * policy, which is to sleep shortly after the turning off
894 * according to the {@link #STAY_ON_WHILE_PLUGGED_IN} setting.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800895 */
896 public static final int WIFI_SLEEP_POLICY_DEFAULT = 0;
897
898 /**
899 * Value for {@link #WIFI_SLEEP_POLICY} to use the default policy when
900 * the device is on battery, and never go to sleep when the device is
901 * plugged in.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800902 */
903 public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED = 1;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700904
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800905 /**
906 * Value for {@link #WIFI_SLEEP_POLICY} to never go to sleep.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800907 */
908 public static final int WIFI_SLEEP_POLICY_NEVER = 2;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700909
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800910 /**
911 * Whether to use static IP and other static network attributes.
912 * <p>
913 * Set to 1 for true and 0 for false.
914 */
915 public static final String WIFI_USE_STATIC_IP = "wifi_use_static_ip";
916
917 /**
918 * The static IP address.
919 * <p>
920 * Example: "192.168.1.51"
921 */
922 public static final String WIFI_STATIC_IP = "wifi_static_ip";
923
924 /**
925 * If using static IP, the gateway's IP address.
926 * <p>
927 * Example: "192.168.1.1"
928 */
929 public static final String WIFI_STATIC_GATEWAY = "wifi_static_gateway";
930
931 /**
932 * If using static IP, the net mask.
933 * <p>
934 * Example: "255.255.255.0"
935 */
936 public static final String WIFI_STATIC_NETMASK = "wifi_static_netmask";
937
938 /**
939 * If using static IP, the primary DNS's IP address.
940 * <p>
941 * Example: "192.168.1.1"
942 */
943 public static final String WIFI_STATIC_DNS1 = "wifi_static_dns1";
944
945 /**
946 * If using static IP, the secondary DNS's IP address.
947 * <p>
948 * Example: "192.168.1.2"
949 */
950 public static final String WIFI_STATIC_DNS2 = "wifi_static_dns2";
951
952 /**
953 * The number of radio channels that are allowed in the local
954 * 802.11 regulatory domain.
955 * @hide
956 */
957 public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
958
959 /**
960 * Determines whether remote devices may discover and/or connect to
961 * this device.
962 * <P>Type: INT</P>
963 * 2 -- discoverable and connectable
964 * 1 -- connectable but not discoverable
965 * 0 -- neither connectable nor discoverable
966 */
967 public static final String BLUETOOTH_DISCOVERABILITY =
968 "bluetooth_discoverability";
969
970 /**
971 * Bluetooth discoverability timeout. If this value is nonzero, then
972 * Bluetooth becomes discoverable for a certain number of seconds,
973 * after which is becomes simply connectable. The value is in seconds.
974 */
975 public static final String BLUETOOTH_DISCOVERABILITY_TIMEOUT =
976 "bluetooth_discoverability_timeout";
977
978 /**
979 * Whether autolock is enabled (0 = false, 1 = true)
980 */
981 public static final String LOCK_PATTERN_ENABLED = "lock_pattern_autolock";
982
983 /**
984 * Whether lock pattern is visible as user enters (0 = false, 1 = true)
985 */
986 public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
987
988 /**
989 * Whether lock pattern will vibrate as user enters (0 = false, 1 = true)
990 */
991 public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
992 "lock_pattern_tactile_feedback_enabled";
993
994
995 /**
996 * A formatted string of the next alarm that is set, or the empty string
997 * if there is no alarm set.
998 */
999 public static final String NEXT_ALARM_FORMATTED = "next_alarm_formatted";
1000
1001 /**
1002 * Scaling factor for fonts, float.
1003 */
1004 public static final String FONT_SCALE = "font_scale";
1005
1006 /**
1007 * Name of an application package to be debugged.
1008 */
1009 public static final String DEBUG_APP = "debug_app";
1010
1011 /**
1012 * If 1, when launching DEBUG_APP it will wait for the debugger before
1013 * starting user code. If 0, it will run normally.
1014 */
1015 public static final String WAIT_FOR_DEBUGGER = "wait_for_debugger";
1016
1017 /**
1018 * Whether or not to dim the screen. 0=no 1=yes
1019 */
1020 public static final String DIM_SCREEN = "dim_screen";
1021
1022 /**
1023 * The timeout before the screen turns off.
1024 */
1025 public static final String SCREEN_OFF_TIMEOUT = "screen_off_timeout";
1026
1027 /**
Mitsuru Oshimae5fb3282009-06-09 21:16:08 -07001028 * If 0, the compatibility mode is off for all applications.
1029 * If 1, older applications run under compatibility mode.
1030 * TODO: remove this settings before code freeze (bug/1907571)
1031 * @hide
1032 */
1033 public static final String COMPATIBILITY_MODE = "compatibility_mode";
1034
1035 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001036 * The screen backlight brightness between 0 and 255.
1037 */
1038 public static final String SCREEN_BRIGHTNESS = "screen_brightness";
1039
1040 /**
1041 * Control whether the process CPU usage meter should be shown.
1042 */
1043 public static final String SHOW_PROCESSES = "show_processes";
1044
1045 /**
1046 * If 1, the activity manager will aggressively finish activities and
1047 * processes as soon as they are no longer needed. If 0, the normal
1048 * extended lifetime is used.
1049 */
1050 public static final String ALWAYS_FINISH_ACTIVITIES =
1051 "always_finish_activities";
1052
1053
1054 /**
1055 * Ringer mode. This is used internally, changing this value will not
1056 * change the ringer mode. See AudioManager.
1057 */
1058 public static final String MODE_RINGER = "mode_ringer";
1059
1060 /**
1061 * Determines which streams are affected by ringer mode changes. The
1062 * stream type's bit should be set to 1 if it should be muted when going
1063 * into an inaudible ringer mode.
1064 */
1065 public static final String MODE_RINGER_STREAMS_AFFECTED = "mode_ringer_streams_affected";
1066
1067 /**
1068 * Determines which streams are affected by mute. The
1069 * stream type's bit should be set to 1 if it should be muted when a mute request
1070 * is received.
1071 */
1072 public static final String MUTE_STREAMS_AFFECTED = "mute_streams_affected";
1073
1074 /**
1075 * Whether vibrate is on for different events. This is used internally,
1076 * changing this value will not change the vibrate. See AudioManager.
1077 */
1078 public static final String VIBRATE_ON = "vibrate_on";
1079
1080 /**
1081 * Ringer volume. This is used internally, changing this value will not
1082 * change the volume. See AudioManager.
1083 */
1084 public static final String VOLUME_RING = "volume_ring";
1085
1086 /**
1087 * System/notifications volume. This is used internally, changing this
1088 * value will not change the volume. See AudioManager.
1089 */
1090 public static final String VOLUME_SYSTEM = "volume_system";
1091
1092 /**
1093 * Voice call volume. This is used internally, changing this value will
1094 * not change the volume. See AudioManager.
1095 */
1096 public static final String VOLUME_VOICE = "volume_voice";
1097
1098 /**
1099 * Music/media/gaming volume. This is used internally, changing this
1100 * value will not change the volume. See AudioManager.
1101 */
1102 public static final String VOLUME_MUSIC = "volume_music";
1103
1104 /**
1105 * Alarm volume. This is used internally, changing this
1106 * value will not change the volume. See AudioManager.
1107 */
1108 public static final String VOLUME_ALARM = "volume_alarm";
1109
1110 /**
1111 * Notification volume. This is used internally, changing this
1112 * value will not change the volume. See AudioManager.
1113 */
1114 public static final String VOLUME_NOTIFICATION = "volume_notification";
1115
1116 /**
1117 * Whether the notifications should use the ring volume (value of 1) or
1118 * a separate notification volume (value of 0). In most cases, users
1119 * will have this enabled so the notification and ringer volumes will be
1120 * the same. However, power users can disable this and use the separate
1121 * notification volume control.
1122 * <p>
1123 * Note: This is a one-off setting that will be removed in the future
1124 * when there is profile support. For this reason, it is kept hidden
1125 * from the public APIs.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001126 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001127 * @hide
1128 */
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001129 public static final String NOTIFICATIONS_USE_RING_VOLUME =
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001130 "notifications_use_ring_volume";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001131
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001132 /**
1133 * The mapping of stream type (integer) to its setting.
1134 */
1135 public static final String[] VOLUME_SETTINGS = {
1136 VOLUME_VOICE, VOLUME_SYSTEM, VOLUME_RING, VOLUME_MUSIC,
1137 VOLUME_ALARM, VOLUME_NOTIFICATION
1138 };
1139
1140 /**
1141 * Appended to various volume related settings to record the previous
1142 * values before they the settings were affected by a silent/vibrate
1143 * ringer mode change.
1144 */
1145 public static final String APPEND_FOR_LAST_AUDIBLE = "_last_audible";
1146
1147 /**
1148 * Persistent store for the system-wide default ringtone URI.
1149 * <p>
1150 * If you need to play the default ringtone at any given time, it is recommended
1151 * you give {@link #DEFAULT_RINGTONE_URI} to the media player. It will resolve
1152 * to the set default ringtone at the time of playing.
1153 *
1154 * @see #DEFAULT_RINGTONE_URI
1155 */
1156 public static final String RINGTONE = "ringtone";
1157
1158 /**
1159 * A {@link Uri} that will point to the current default ringtone at any
1160 * given time.
1161 * <p>
1162 * If the current default ringtone is in the DRM provider and the caller
1163 * does not have permission, the exception will be a
1164 * FileNotFoundException.
1165 */
1166 public static final Uri DEFAULT_RINGTONE_URI = getUriFor(RINGTONE);
1167
1168 /**
1169 * Persistent store for the system-wide default notification sound.
1170 *
1171 * @see #RINGTONE
1172 * @see #DEFAULT_NOTIFICATION_URI
1173 */
1174 public static final String NOTIFICATION_SOUND = "notification_sound";
1175
1176 /**
1177 * A {@link Uri} that will point to the current default notification
1178 * sound at any given time.
1179 *
1180 * @see #DEFAULT_RINGTONE_URI
1181 */
1182 public static final Uri DEFAULT_NOTIFICATION_URI = getUriFor(NOTIFICATION_SOUND);
1183
1184 /**
1185 * Setting to enable Auto Replace (AutoText) in text editors. 1 = On, 0 = Off
1186 */
1187 public static final String TEXT_AUTO_REPLACE = "auto_replace";
1188
1189 /**
1190 * Setting to enable Auto Caps in text editors. 1 = On, 0 = Off
1191 */
1192 public static final String TEXT_AUTO_CAPS = "auto_caps";
1193
1194 /**
1195 * Setting to enable Auto Punctuate in text editors. 1 = On, 0 = Off. This
1196 * feature converts two spaces to a "." and space.
1197 */
1198 public static final String TEXT_AUTO_PUNCTUATE = "auto_punctuate";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001199
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001200 /**
1201 * Setting to showing password characters in text editors. 1 = On, 0 = Off
1202 */
1203 public static final String TEXT_SHOW_PASSWORD = "show_password";
1204
1205 public static final String SHOW_GTALK_SERVICE_STATUS =
1206 "SHOW_GTALK_SERVICE_STATUS";
1207
1208 /**
1209 * Name of activity to use for wallpaper on the home screen.
1210 */
1211 public static final String WALLPAPER_ACTIVITY = "wallpaper_activity";
1212
1213 /**
1214 * Value to specify if the user prefers the date, time and time zone
1215 * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1216 */
1217 public static final String AUTO_TIME = "auto_time";
1218
1219 /**
1220 * Display times as 12 or 24 hours
1221 * 12
1222 * 24
1223 */
1224 public static final String TIME_12_24 = "time_12_24";
1225
1226 /**
1227 * Date format string
1228 * mm/dd/yyyy
1229 * dd/mm/yyyy
1230 * yyyy/mm/dd
1231 */
1232 public static final String DATE_FORMAT = "date_format";
1233
1234 /**
1235 * Whether the setup wizard has been run before (on first boot), or if
1236 * it still needs to be run.
1237 *
1238 * nonzero = it has been run in the past
1239 * 0 = it has not been run in the past
1240 */
1241 public static final String SETUP_WIZARD_HAS_RUN = "setup_wizard_has_run";
1242
1243 /**
1244 * Scaling factor for normal window animations. Setting to 0 will disable window
1245 * animations.
1246 */
1247 public static final String WINDOW_ANIMATION_SCALE = "window_animation_scale";
1248
1249 /**
1250 * Scaling factor for activity transition animations. Setting to 0 will disable window
1251 * animations.
1252 */
1253 public static final String TRANSITION_ANIMATION_SCALE = "transition_animation_scale";
1254
1255 /**
1256 * Scaling factor for normal window animations. Setting to 0 will disable window
1257 * animations.
1258 * @hide
1259 */
1260 public static final String FANCY_IME_ANIMATIONS = "fancy_ime_animations";
1261
1262 /**
1263 * Control whether the accelerometer will be used to change screen
1264 * orientation. If 0, it will not be used unless explicitly requested
1265 * by the application; if 1, it will be used by default unless explicitly
1266 * disabled by the application.
1267 */
1268 public static final String ACCELEROMETER_ROTATION = "accelerometer_rotation";
1269
1270 /**
1271 * Whether the audible DTMF tones are played by the dialer when dialing. The value is
1272 * boolean (1 or 0).
1273 */
1274 public static final String DTMF_TONE_WHEN_DIALING = "dtmf_tone";
1275
1276 /**
David Kraused0f67152009-06-13 18:01:13 -05001277 * CDMA only settings
1278 * DTMF tone type played by the dialer when dialing.
1279 * 0 = Normal
1280 * 1 = Long
1281 * @hide
1282 */
1283 public static final String DTMF_TONE_TYPE_WHEN_DIALING = "dtmf_tone_type";
1284
1285 /**
1286 * CDMA only settings
1287 * Emergency Tone 0 = Off
1288 * 1 = Alert
1289 * 2 = Vibrate
1290 * @hide
1291 */
1292 public static final String EMERGENCY_TONE = "emergency_tone";
1293
1294 /**
1295 * CDMA only settings
1296 * Whether the auto retry is enabled. The value is
1297 * boolean (1 or 0).
1298 * @hide
1299 */
1300 public static final String CALL_AUTO_RETRY = "call_auto_retry";
1301
1302 /**
1303 * Whether the hearing aid is enabled. The value is
1304 * boolean (1 or 0).
1305 * @hide
1306 */
1307 public static final String HEARING_AID = "hearing_aid";
1308
1309 /**
1310 * CDMA only settings
1311 * TTY Mode
1312 * 0 = OFF
1313 * 1 = FULL
1314 * 2 = VCO
1315 * 3 = HCO
1316 * @hide
1317 */
1318 public static final String TTY_MODE = "tty_mode";
1319
1320 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001321 * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1322 * boolean (1 or 0).
1323 */
1324 public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001325
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001326 /**
1327 * Whether the haptic feedback (long presses, ...) are enabled. The value is
1328 * boolean (1 or 0).
1329 */
1330 public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
Mike LeBeau48603e72009-06-05 00:27:00 +01001331
1332 /**
1333 * Whether live web suggestions while the user types into search dialogs are
1334 * enabled. Browsers and other search UIs should respect this, as it allows
1335 * a user to avoid sending partial queries to a search engine, if it poses
1336 * any privacy concern. The value is boolean (1 or 0).
1337 */
1338 public static final String SHOW_WEB_SUGGESTIONS = "show_web_suggestions";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001339
Amith Yamasani220f4d62009-07-02 02:34:14 -07001340 /**
1341 * Settings to backup. This is here so that it's in the same place as the settings
1342 * keys and easy to update.
1343 * @hide
1344 */
1345 public static final String[] SETTINGS_TO_BACKUP = {
1346 STAY_ON_WHILE_PLUGGED_IN,
1347 END_BUTTON_BEHAVIOR,
1348 WIFI_SLEEP_POLICY,
1349 WIFI_USE_STATIC_IP,
1350 WIFI_STATIC_IP,
1351 WIFI_STATIC_GATEWAY,
1352 WIFI_STATIC_NETMASK,
1353 WIFI_STATIC_DNS1,
1354 WIFI_STATIC_DNS2,
1355 BLUETOOTH_DISCOVERABILITY,
1356 BLUETOOTH_DISCOVERABILITY_TIMEOUT,
1357 DIM_SCREEN,
1358 SCREEN_OFF_TIMEOUT,
1359 SCREEN_BRIGHTNESS,
1360 VIBRATE_ON,
1361 NOTIFICATIONS_USE_RING_VOLUME,
1362 RINGTONE,
1363 NOTIFICATION_SOUND,
1364 TEXT_AUTO_REPLACE,
1365 TEXT_AUTO_CAPS,
1366 TEXT_AUTO_PUNCTUATE,
1367 TEXT_SHOW_PASSWORD,
1368 AUTO_TIME,
1369 TIME_12_24,
1370 DATE_FORMAT,
1371 ACCELEROMETER_ROTATION,
1372 DTMF_TONE_WHEN_DIALING,
1373 DTMF_TONE_TYPE_WHEN_DIALING,
1374 EMERGENCY_TONE,
1375 CALL_AUTO_RETRY,
1376 HEARING_AID,
1377 TTY_MODE,
1378 SOUND_EFFECTS_ENABLED,
1379 HAPTIC_FEEDBACK_ENABLED,
1380 SHOW_WEB_SUGGESTIONS
1381 };
1382
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001383 // Settings moved to Settings.Secure
1384
1385 /**
Mike Lockwood570d05f2009-04-02 05:27:16 -07001386 * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001387 * instead
1388 */
1389 @Deprecated
1390 public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1391
1392 /**
1393 * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1394 */
1395 @Deprecated
1396 public static final String ANDROID_ID = Secure.ANDROID_ID;
1397
1398 /**
1399 * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1400 */
1401 @Deprecated
1402 public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1403
1404 /**
1405 * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1406 */
1407 @Deprecated
1408 public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1409
1410 /**
1411 * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1412 */
1413 @Deprecated
1414 public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1415
1416 /**
1417 * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1418 */
1419 @Deprecated
1420 public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1421
1422 /**
1423 * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1424 */
1425 @Deprecated
1426 public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001427
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001428 /**
1429 * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1430 * instead
1431 */
1432 @Deprecated
1433 public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1434
1435 /**
1436 * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1437 */
1438 @Deprecated
1439 public static final String LOGGING_ID = Secure.LOGGING_ID;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001440
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001441 /**
1442 * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1443 */
1444 @Deprecated
1445 public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1446
1447 /**
1448 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1449 * instead
1450 */
1451 @Deprecated
1452 public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1453
1454 /**
1455 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1456 * instead
1457 */
1458 @Deprecated
1459 public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1460
1461 /**
1462 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1463 * instead
1464 */
1465 @Deprecated
1466 public static final String PARENTAL_CONTROL_REDIRECT_URL =
1467 Secure.PARENTAL_CONTROL_REDIRECT_URL;
1468
1469 /**
1470 * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1471 */
1472 @Deprecated
1473 public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1474
1475 /**
1476 * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1477 */
1478 @Deprecated
1479 public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001480
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001481 /**
1482 * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1483 */
1484 @Deprecated
1485 public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1486
1487// /**
1488// * @deprecated Use {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT}
1489// * instead
1490// */
1491 @Deprecated
1492 public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1493
1494// /**
1495// * @deprecated Use
1496// * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS}
1497// * instead
1498// */
1499 @Deprecated
1500 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1501 Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1502
1503 /**
1504 * @deprecated Use
1505 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1506 */
1507 @Deprecated
1508 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1509 Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
1510
1511 /**
1512 * @deprecated Use
1513 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
1514 */
1515 @Deprecated
1516 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1517 Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001518
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001519 /**
1520 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
1521 * instead
1522 */
1523 @Deprecated
1524 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
1525
1526 /**
1527 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
1528 */
1529 @Deprecated
1530 public static final String WIFI_ON = Secure.WIFI_ON;
1531
1532 /**
1533 * @deprecated Use
1534 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
1535 * instead
1536 */
1537 @Deprecated
1538 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1539 Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
1540
1541 /**
1542 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
1543 */
1544 @Deprecated
1545 public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
1546
1547 /**
1548 * @deprecated Use
1549 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
1550 */
1551 @Deprecated
1552 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1553 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001554
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001555 /**
1556 * @deprecated Use
1557 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
1558 */
1559 @Deprecated
1560 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1561 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
1562
1563 /**
1564 * @deprecated Use
1565 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
1566 * instead
1567 */
1568 @Deprecated
1569 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1570 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
1571
1572 /**
1573 * @deprecated Use
1574 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
1575 */
1576 @Deprecated
1577 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
1578 Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
1579
1580 /**
1581 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
1582 * instead
1583 */
1584 @Deprecated
1585 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
1586
1587 /**
1588 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
1589 */
1590 @Deprecated
1591 public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
1592
1593 /**
1594 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
1595 */
1596 @Deprecated
1597 public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
1598
1599 /**
1600 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
1601 * instead
1602 */
1603 @Deprecated
1604 public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
1605
1606 /**
1607 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
1608 * instead
1609 */
1610 @Deprecated
1611 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
1612 Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
1613 }
1614
1615 /**
1616 * Secure system settings, containing system preferences that applications
1617 * can read but are not allowed to write. These are for preferences that
1618 * the user must explicitly modify through the system UI or specialized
1619 * APIs for those values, not modified directly by applications.
1620 */
1621 public static final class Secure extends NameValueTable {
1622 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
1623
1624 private static volatile NameValueCache mNameValueCache = null;
1625
1626 /**
1627 * Look up a name in the database.
1628 * @param resolver to access the database with
1629 * @param name to look up in the table
1630 * @return the corresponding value, or null if not present
1631 */
1632 public synchronized static String getString(ContentResolver resolver, String name) {
1633 if (mNameValueCache == null) {
1634 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
1635 }
1636 return mNameValueCache.getString(resolver, name);
1637 }
1638
1639 /**
1640 * Store a name/value pair into the database.
1641 * @param resolver to access the database with
1642 * @param name to store
1643 * @param value to associate with the name
1644 * @return true if the value was set, false on database errors
1645 */
1646 public static boolean putString(ContentResolver resolver,
1647 String name, String value) {
1648 return putString(resolver, CONTENT_URI, name, value);
1649 }
1650
1651 /**
1652 * Construct the content URI for a particular name/value pair,
1653 * useful for monitoring changes with a ContentObserver.
1654 * @param name to look up in the table
1655 * @return the corresponding content URI, or null if not present
1656 */
1657 public static Uri getUriFor(String name) {
1658 return getUriFor(CONTENT_URI, name);
1659 }
1660
1661 /**
1662 * Convenience function for retrieving a single secure settings value
1663 * as an integer. Note that internally setting values are always
1664 * stored as strings; this function converts the string to an integer
1665 * for you. The default value will be returned if the setting is
1666 * not defined or not an integer.
1667 *
1668 * @param cr The ContentResolver to access.
1669 * @param name The name of the setting to retrieve.
1670 * @param def Value to return if the setting is not defined.
1671 *
1672 * @return The setting's current value, or 'def' if it is not defined
1673 * or not a valid integer.
1674 */
1675 public static int getInt(ContentResolver cr, String name, int def) {
1676 String v = getString(cr, name);
1677 try {
1678 return v != null ? Integer.parseInt(v) : def;
1679 } catch (NumberFormatException e) {
1680 return def;
1681 }
1682 }
1683
1684 /**
1685 * Convenience function for retrieving a single secure settings value
1686 * as an integer. Note that internally setting values are always
1687 * stored as strings; this function converts the string to an integer
1688 * for you.
1689 * <p>
1690 * This version does not take a default value. If the setting has not
1691 * been set, or the string value is not a number,
1692 * it throws {@link SettingNotFoundException}.
1693 *
1694 * @param cr The ContentResolver to access.
1695 * @param name The name of the setting to retrieve.
1696 *
1697 * @throws SettingNotFoundException Thrown if a setting by the given
1698 * name can't be found or the setting value is not an integer.
1699 *
1700 * @return The setting's current value.
1701 */
1702 public static int getInt(ContentResolver cr, String name)
1703 throws SettingNotFoundException {
1704 String v = getString(cr, name);
1705 try {
1706 return Integer.parseInt(v);
1707 } catch (NumberFormatException e) {
1708 throw new SettingNotFoundException(name);
1709 }
1710 }
1711
1712 /**
1713 * Convenience function for updating a single settings value as an
1714 * integer. This will either create a new entry in the table if the
1715 * given name does not exist, or modify the value of the existing row
1716 * with that name. Note that internally setting values are always
1717 * stored as strings, so this function converts the given value to a
1718 * string before storing it.
1719 *
1720 * @param cr The ContentResolver to access.
1721 * @param name The name of the setting to modify.
1722 * @param value The new value for the setting.
1723 * @return true if the value was set, false on database errors
1724 */
1725 public static boolean putInt(ContentResolver cr, String name, int value) {
1726 return putString(cr, name, Integer.toString(value));
1727 }
1728
1729 /**
1730 * Convenience function for retrieving a single secure settings value
1731 * as a {@code long}. Note that internally setting values are always
1732 * stored as strings; this function converts the string to a {@code long}
1733 * for you. The default value will be returned if the setting is
1734 * not defined or not a {@code long}.
1735 *
1736 * @param cr The ContentResolver to access.
1737 * @param name The name of the setting to retrieve.
1738 * @param def Value to return if the setting is not defined.
1739 *
1740 * @return The setting's current value, or 'def' if it is not defined
1741 * or not a valid {@code long}.
1742 */
1743 public static long getLong(ContentResolver cr, String name, long def) {
1744 String valString = getString(cr, name);
1745 long value;
1746 try {
1747 value = valString != null ? Long.parseLong(valString) : def;
1748 } catch (NumberFormatException e) {
1749 value = def;
1750 }
1751 return value;
1752 }
1753
1754 /**
1755 * Convenience function for retrieving a single secure settings value
1756 * as a {@code long}. Note that internally setting values are always
1757 * stored as strings; this function converts the string to a {@code long}
1758 * for you.
1759 * <p>
1760 * This version does not take a default value. If the setting has not
1761 * been set, or the string value is not a number,
1762 * it throws {@link SettingNotFoundException}.
1763 *
1764 * @param cr The ContentResolver to access.
1765 * @param name The name of the setting to retrieve.
1766 *
1767 * @return The setting's current value.
1768 * @throws SettingNotFoundException Thrown if a setting by the given
1769 * name can't be found or the setting value is not an integer.
1770 */
1771 public static long getLong(ContentResolver cr, String name)
1772 throws SettingNotFoundException {
1773 String valString = getString(cr, name);
1774 try {
1775 return Long.parseLong(valString);
1776 } catch (NumberFormatException e) {
1777 throw new SettingNotFoundException(name);
1778 }
1779 }
1780
1781 /**
1782 * Convenience function for updating a secure settings value as a long
1783 * integer. This will either create a new entry in the table if the
1784 * given name does not exist, or modify the value of the existing row
1785 * with that name. Note that internally setting values are always
1786 * stored as strings, so this function converts the given value to a
1787 * string before storing it.
1788 *
1789 * @param cr The ContentResolver to access.
1790 * @param name The name of the setting to modify.
1791 * @param value The new value for the setting.
1792 * @return true if the value was set, false on database errors
1793 */
1794 public static boolean putLong(ContentResolver cr, String name, long value) {
1795 return putString(cr, name, Long.toString(value));
1796 }
1797
1798 /**
1799 * Convenience function for retrieving a single secure settings value
1800 * as a floating point number. Note that internally setting values are
1801 * always stored as strings; this function converts the string to an
1802 * float for you. The default value will be returned if the setting
1803 * is not defined or not a valid float.
1804 *
1805 * @param cr The ContentResolver to access.
1806 * @param name The name of the setting to retrieve.
1807 * @param def Value to return if the setting is not defined.
1808 *
1809 * @return The setting's current value, or 'def' if it is not defined
1810 * or not a valid float.
1811 */
1812 public static float getFloat(ContentResolver cr, String name, float def) {
1813 String v = getString(cr, name);
1814 try {
1815 return v != null ? Float.parseFloat(v) : def;
1816 } catch (NumberFormatException e) {
1817 return def;
1818 }
1819 }
1820
1821 /**
1822 * Convenience function for retrieving a single secure settings value
1823 * as a float. Note that internally setting values are always
1824 * stored as strings; this function converts the string to a float
1825 * for you.
1826 * <p>
1827 * This version does not take a default value. If the setting has not
1828 * been set, or the string value is not a number,
1829 * it throws {@link SettingNotFoundException}.
1830 *
1831 * @param cr The ContentResolver to access.
1832 * @param name The name of the setting to retrieve.
1833 *
1834 * @throws SettingNotFoundException Thrown if a setting by the given
1835 * name can't be found or the setting value is not a float.
1836 *
1837 * @return The setting's current value.
1838 */
1839 public static float getFloat(ContentResolver cr, String name)
1840 throws SettingNotFoundException {
1841 String v = getString(cr, name);
1842 try {
1843 return Float.parseFloat(v);
1844 } catch (NumberFormatException e) {
1845 throw new SettingNotFoundException(name);
1846 }
1847 }
1848
1849 /**
1850 * Convenience function for updating a single settings value as a
1851 * floating point number. This will either create a new entry in the
1852 * table if the given name does not exist, or modify the value of the
1853 * existing row with that name. Note that internally setting values
1854 * are always stored as strings, so this function converts the given
1855 * value to a string before storing it.
1856 *
1857 * @param cr The ContentResolver to access.
1858 * @param name The name of the setting to modify.
1859 * @param value The new value for the setting.
1860 * @return true if the value was set, false on database errors
1861 */
1862 public static boolean putFloat(ContentResolver cr, String name, float value) {
1863 return putString(cr, name, Float.toString(value));
1864 }
1865
1866 /**
1867 * The content:// style URL for this table
1868 */
1869 public static final Uri CONTENT_URI =
1870 Uri.parse("content://" + AUTHORITY + "/secure");
1871
1872 /**
1873 * Whether ADB is enabled.
1874 */
1875 public static final String ADB_ENABLED = "adb_enabled";
1876
1877 /**
1878 * Setting to allow mock locations and location provider status to be injected into the
1879 * LocationManager service for testing purposes during application development. These
1880 * locations and status values override actual location and status information generated
1881 * by network, gps, or other location providers.
1882 */
1883 public static final String ALLOW_MOCK_LOCATION = "mock_location";
1884
1885 /**
1886 * The Android ID (a unique 64-bit value) as a hex string.
1887 * Identical to that obtained by calling
1888 * GoogleLoginService.getAndroidId(); it is also placed here
1889 * so you can get it without binding to a service.
1890 */
1891 public static final String ANDROID_ID = "android_id";
1892
1893 /**
1894 * Whether bluetooth is enabled/disabled
1895 * 0=disabled. 1=enabled.
1896 */
1897 public static final String BLUETOOTH_ON = "bluetooth_on";
1898
1899 /**
1900 * Get the key that retrieves a bluetooth headset's priority.
1901 * @hide
1902 */
1903 public static final String getBluetoothHeadsetPriorityKey(String address) {
1904 return ("bluetooth_headset_priority_" + address.toUpperCase());
1905 }
1906
1907 /**
1908 * Get the key that retrieves a bluetooth a2dp sink's priority.
1909 * @hide
1910 */
1911 public static final String getBluetoothA2dpSinkPriorityKey(String address) {
1912 return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
1913 }
1914
1915 /**
1916 * Whether or not data roaming is enabled. (0 = false, 1 = true)
1917 */
1918 public static final String DATA_ROAMING = "data_roaming";
1919
1920 /**
1921 * Setting to record the input method used by default, holding the ID
1922 * of the desired method.
1923 */
1924 public static final String DEFAULT_INPUT_METHOD = "default_input_method";
1925
1926 /**
1927 * Whether the device has been provisioned (0 = false, 1 = true)
1928 */
1929 public static final String DEVICE_PROVISIONED = "device_provisioned";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001930
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001931 /**
1932 * List of input methods that are currently enabled. This is a string
1933 * containing the IDs of all enabled input methods, each ID separated
1934 * by ':'.
1935 */
1936 public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001937
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001938 /**
1939 * Host name and port for a user-selected proxy.
1940 */
1941 public static final String HTTP_PROXY = "http_proxy";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001942
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001943 /**
1944 * Whether the package installer should allow installation of apps downloaded from
1945 * sources other than the Android Market (vending machine).
1946 *
1947 * 1 = allow installing from other sources
1948 * 0 = only allow installing from the Android Market
1949 */
1950 public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001951
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001952 /**
1953 * Comma-separated list of location providers that activities may access.
1954 */
1955 public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001956
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001957 /**
1958 * The Logging ID (a unique 64-bit value) as a hex string.
1959 * Used as a pseudonymous identifier for logging.
1960 * @deprecated This identifier is poorly initialized and has
1961 * many collisions. It should not be used.
1962 */
1963 @Deprecated
1964 public static final String LOGGING_ID = "logging_id";
1965
1966 /**
1967 * The Logging ID (a unique 64-bit value) as a hex string.
1968 * Used as a pseudonymous identifier for logging.
1969 * @hide
1970 */
1971 public static final String LOGGING_ID2 = "logging_id2";
1972
1973 /**
1974 * User preference for which network(s) should be used. Only the
1975 * connectivity service should touch this.
1976 */
1977 public static final String NETWORK_PREFERENCE = "network_preference";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001978
1979 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001980 */
1981 public static final String PARENTAL_CONTROL_ENABLED = "parental_control_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001982
1983 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001984 */
1985 public static final String PARENTAL_CONTROL_LAST_UPDATE = "parental_control_last_update";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001986
1987 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001988 */
1989 public static final String PARENTAL_CONTROL_REDIRECT_URL = "parental_control_redirect_url";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001990
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001991 /**
1992 * Settings classname to launch when Settings is clicked from All
1993 * Applications. Needed because of user testing between the old
1994 * and new Settings apps.
1995 */
1996 // TODO: 881807
1997 public static final String SETTINGS_CLASSNAME = "settings_classname";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001998
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001999 /**
2000 * USB Mass Storage Enabled
2001 */
2002 public static final String USB_MASS_STORAGE_ENABLED = "usb_mass_storage_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002003
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002004 /**
2005 * If this setting is set (to anything), then all references
2006 * to Gmail on the device must change to Google Mail.
2007 */
2008 public static final String USE_GOOGLE_MAIL = "use_google_mail";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002009
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002010 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002011 * If accessibility is enabled.
2012 */
2013 public static final String ACCESSIBILITY_ENABLED = "accessibility_enabled";
2014
2015 /**
2016 * List of the enabled accessibility providers.
2017 */
2018 public static final String ENABLED_ACCESSIBILITY_SERVICES =
2019 "enabled_accessibility_services";
2020
2021 /**
Jean-Michel Trivif62ba452009-06-04 14:55:24 -07002022 * Setting to always use the default text-to-speech settings regardless
2023 * of the application settings.
2024 * 1 = override application settings,
2025 * 0 = use application settings (if specified).
2026 */
2027 public static final String TTS_USE_DEFAULTS = "tts_use_defaults";
2028
2029 /**
2030 * Default text-to-speech engine speech rate. 100 = 1x
2031 */
2032 public static final String TTS_DEFAULT_RATE = "tts_default_rate";
2033
2034 /**
2035 * Default text-to-speech engine pitch. 100 = 1x
2036 */
2037 public static final String TTS_DEFAULT_PITCH = "tts_default_pitch";
2038
2039 /**
2040 * Default text-to-speech engine.
2041 */
2042 public static final String TTS_DEFAULT_SYNTH = "tts_default_synth";
2043
2044 /**
Jean-Michel Trivif4782672009-06-09 16:22:48 -07002045 * Default text-to-speech language.
2046 */
2047 public static final String TTS_DEFAULT_LANG = "tts_default_lang";
2048
2049 /**
Jean-Michel Trivia6fcc952009-06-19 14:06:01 -07002050 * Default text-to-speech country.
2051 */
2052 public static final String TTS_DEFAULT_COUNTRY = "tts_default_country";
2053
2054 /**
2055 * Default text-to-speech locale variant.
2056 */
2057 public static final String TTS_DEFAULT_VARIANT = "tts_default_variant";
2058
2059 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002060 * Whether to notify the user of open networks.
2061 * <p>
2062 * If not connected and the scan results have an open network, we will
2063 * put this notification up. If we attempt to connect to a network or
2064 * the open network(s) disappear, we remove the notification. When we
2065 * show the notification, we will not show it again for
2066 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} time.
2067 */
2068 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
2069 "wifi_networks_available_notification_on";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002070
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002071 /**
2072 * Delay (in seconds) before repeating the Wi-Fi networks available notification.
2073 * Connecting to a network will reset the timer.
2074 */
2075 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
2076 "wifi_networks_available_repeat_delay";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002077
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 /**
2079 * The number of radio channels that are allowed in the local
2080 * 802.11 regulatory domain.
2081 * @hide
2082 */
2083 public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002084
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002085 /**
2086 * When the number of open networks exceeds this number, the
2087 * least-recently-used excess networks will be removed.
2088 */
2089 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = "wifi_num_open_networks_kept";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002090
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002091 /**
2092 * Whether the Wi-Fi should be on. Only the Wi-Fi service should touch this.
2093 */
2094 public static final String WIFI_ON = "wifi_on";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002095
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002096 /**
2097 * The acceptable packet loss percentage (range 0 - 100) before trying
2098 * another AP on the same network.
2099 */
2100 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
2101 "wifi_watchdog_acceptable_packet_loss_percentage";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002102
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002103 /**
2104 * The number of access points required for a network in order for the
2105 * watchdog to monitor it.
2106 */
2107 public static final String WIFI_WATCHDOG_AP_COUNT = "wifi_watchdog_ap_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002108
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002109 /**
2110 * The delay between background checks.
2111 */
2112 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
2113 "wifi_watchdog_background_check_delay_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002114
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002115 /**
2116 * Whether the Wi-Fi watchdog is enabled for background checking even
2117 * after it thinks the user has connected to a good access point.
2118 */
2119 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
2120 "wifi_watchdog_background_check_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002121
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002122 /**
2123 * The timeout for a background ping
2124 */
2125 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
2126 "wifi_watchdog_background_check_timeout_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002127
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002128 /**
2129 * The number of initial pings to perform that *may* be ignored if they
2130 * fail. Again, if these fail, they will *not* be used in packet loss
2131 * calculation. For example, one network always seemed to time out for
2132 * the first couple pings, so this is set to 3 by default.
2133 */
2134 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2135 "wifi_watchdog_initial_ignored_ping_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002136
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002137 /**
2138 * The maximum number of access points (per network) to attempt to test.
2139 * If this number is reached, the watchdog will no longer monitor the
2140 * initial connection state for the network. This is a safeguard for
2141 * networks containing multiple APs whose DNS does not respond to pings.
2142 */
2143 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = "wifi_watchdog_max_ap_checks";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002144
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002145 /**
2146 * Whether the Wi-Fi watchdog is enabled.
2147 */
2148 public static final String WIFI_WATCHDOG_ON = "wifi_watchdog_on";
2149
2150 /**
2151 * 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 -08002152 */
2153 public static final String WIFI_WATCHDOG_WATCH_LIST = "wifi_watchdog_watch_list";
2154
2155 /**
2156 * The number of pings to test if an access point is a good connection.
2157 */
2158 public static final String WIFI_WATCHDOG_PING_COUNT = "wifi_watchdog_ping_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002159
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002160 /**
2161 * The delay between pings.
2162 */
2163 public static final String WIFI_WATCHDOG_PING_DELAY_MS = "wifi_watchdog_ping_delay_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002164
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002165 /**
2166 * The timeout per ping.
2167 */
2168 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS = "wifi_watchdog_ping_timeout_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002169
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002170 /**
2171 * The maximum number of times we will retry a connection to an access
2172 * point for which we have failed in acquiring an IP address from DHCP.
2173 * 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 -08002174 */
2175 public static final String WIFI_MAX_DHCP_RETRY_COUNT = "wifi_max_dhcp_retry_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002176
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002177 /**
2178 * Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile
2179 * data connectivity to be established after a disconnect from Wi-Fi.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002180 */
2181 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
2182 "wifi_mobile_data_transition_wakelock_timeout_ms";
2183
2184 /**
2185 * Whether background data usage is allowed by the user. See
2186 * ConnectivityManager for more info.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002187 */
2188 public static final String BACKGROUND_DATA = "background_data";
Wink Saville767a6622009-04-02 01:37:02 -07002189
2190 /**
2191 * The CDMA roaming mode 0 = Home Networks, CDMA default
2192 * 1 = Roaming on Affiliated networks
2193 * 2 = Roaming on any networks
2194 * @hide
2195 */
2196 public static final String CDMA_ROAMING_MODE = "roaming_settings";
2197
2198 /**
2199 * The CDMA subscription mode 0 = RUIM/SIM (default)
2200 * 1 = NV
2201 * @hide
2202 */
2203 public static final String CDMA_SUBSCRIPTION_MODE = "subscription_mode";
2204
2205 /**
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002206 * The preferred network mode 7 = Global
2207 * 6 = EvDo only
2208 * 5 = CDMA w/o EvDo
2209 * 4 = CDMA / EvDo auto
2210 * 3 = GSM / WCDMA auto
2211 * 2 = WCDMA only
2212 * 1 = GSM only
2213 * 0 = GSM / WCDMA preferred
Wink Saville767a6622009-04-02 01:37:02 -07002214 * @hide
2215 */
2216 public static final String PREFERRED_NETWORK_MODE =
2217 "preferred_network_mode";
2218
2219 /**
Wink Savillee9b06d72009-05-18 21:47:50 -07002220 * The preferred TTY mode 0 = TTy Off, CDMA default
2221 * 1 = TTY Full
2222 * 2 = TTY HCO
2223 * 3 = TTY VCO
2224 * @hide
2225 */
2226 public static final String PREFERRED_TTY_MODE =
2227 "preferred_tty_mode";
2228
2229
2230 /**
Wink Saville767a6622009-04-02 01:37:02 -07002231 * CDMA Cell Broadcast SMS
2232 * 0 = CDMA Cell Broadcast SMS disabled
2233 * 1 = CDMA Cell Broadcast SMS enabled
2234 * @hide
2235 */
2236 public static final String CDMA_CELL_BROADCAST_SMS =
2237 "cdma_cell_broadcast_sms";
2238
2239 /**
2240 * The cdma subscription 0 = Subscription from RUIM, when available
2241 * 1 = Subscription from NV
2242 * @hide
2243 */
2244 public static final String PREFERRED_CDMA_SUBSCRIPTION =
2245 "preferred_cdma_subscription";
2246
2247 /**
2248 * Whether the enhanced voice privacy mode is enabled.
2249 * 0 = normal voice privacy
2250 * 1 = enhanced voice privacy
2251 * @hide
2252 */
2253 public static final String ENHANCED_VOICE_PRIVACY_ENABLED = "enhanced_voice_privacy_enabled";
2254
2255 /**
2256 * Whether the TTY mode mode is enabled.
2257 * 0 = disabled
2258 * 1 = enabled
2259 * @hide
2260 */
2261 public static final String TTY_MODE_ENABLED = "tty_mode_enabled";
Mike Lockwood9637d472009-04-02 21:41:57 -07002262
2263 /**
Amith Yamasani630cd062009-06-19 12:07:02 -07002264 * Flag for allowing service provider to use location information to improve products and
2265 * services.
2266 * Type: int ( 0 = disallow, 1 = allow )
2267 * @hide
2268 */
2269 public static final String USE_LOCATION_FOR_SERVICES = "use_location";
2270
2271 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07002272 * Controls whether settings backup is enabled.
Dianne Hackborncf098292009-07-01 19:55:20 -07002273 * Type: int ( 0 = disabled, 1 = enabled )
2274 * @hide
2275 */
2276 public static final String BACKUP_ENABLED = "backup_enabled";
2277
2278 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07002279 * Indicates whether settings backup has been fully provisioned.
2280 * Type: int ( 0 = unprovisioned, 1 = fully provisioned )
2281 * @hide
2282 */
2283 public static final String BACKUP_PROVISIONED = "backup_provisioned";
2284
2285 /**
Dianne Hackborncf098292009-07-01 19:55:20 -07002286 * Component of the transport to use for backup/restore.
2287 * @hide
2288 */
2289 public static final String BACKUP_TRANSPORT = "backup_transport";
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07002290
2291 /**
2292 * Version for which the setup wizard was last shown. Bumped for
2293 * each release when there is new setup information to show.
2294 * @hide
2295 */
2296 public static final String LAST_SETUP_SHOWN = "last_setup_shown";
Dianne Hackborncf098292009-07-01 19:55:20 -07002297
2298 /**
Amith Yamasani220f4d62009-07-02 02:34:14 -07002299 * @hide
2300 */
2301 public static final String[] SETTINGS_TO_BACKUP = {
2302 INSTALL_NON_MARKET_APPS,
2303 PARENTAL_CONTROL_ENABLED,
2304 PARENTAL_CONTROL_REDIRECT_URL,
2305 USB_MASS_STORAGE_ENABLED,
2306 ACCESSIBILITY_ENABLED,
2307 ENABLED_ACCESSIBILITY_SERVICES,
2308 TTS_USE_DEFAULTS,
2309 TTS_DEFAULT_RATE,
2310 TTS_DEFAULT_PITCH,
2311 TTS_DEFAULT_SYNTH,
2312 TTS_DEFAULT_LANG,
2313 TTS_DEFAULT_COUNTRY,
2314 WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON,
2315 WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY,
2316 WIFI_NUM_ALLOWED_CHANNELS,
2317 WIFI_NUM_OPEN_NETWORKS_KEPT,
2318 BACKGROUND_DATA,
2319 PREFERRED_NETWORK_MODE,
2320 PREFERRED_TTY_MODE,
2321 CDMA_CELL_BROADCAST_SMS,
2322 PREFERRED_CDMA_SUBSCRIPTION,
2323 ENHANCED_VOICE_PRIVACY_ENABLED
2324 };
2325
2326 /**
Mike Lockwood9637d472009-04-02 21:41:57 -07002327 * Helper method for determining if a location provider is enabled.
2328 * @param cr the content resolver to use
2329 * @param provider the location provider to query
2330 * @return true if the provider is enabled
2331 *
2332 * @hide
2333 */
2334 public static final boolean isLocationProviderEnabled(ContentResolver cr, String provider) {
2335 String allowedProviders = Settings.Secure.getString(cr, LOCATION_PROVIDERS_ALLOWED);
2336 if (allowedProviders != null) {
2337 return (allowedProviders.equals(provider) ||
2338 allowedProviders.contains("," + provider + ",") ||
2339 allowedProviders.startsWith(provider + ",") ||
2340 allowedProviders.endsWith("," + provider));
2341 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002342 return false;
Mike Lockwood9637d472009-04-02 21:41:57 -07002343 }
2344
2345 /**
2346 * Thread-safe method for enabling or disabling a single location provider.
2347 * @param cr the content resolver to use
2348 * @param provider the location provider to enable or disable
2349 * @param enabled true if the provider should be enabled
2350 *
2351 * @hide
2352 */
2353 public static final void setLocationProviderEnabled(ContentResolver cr,
2354 String provider, boolean enabled) {
2355 // to ensure thread safety, we write the provider name with a '+' or '-'
2356 // and let the SettingsProvider handle it rather than reading and modifying
2357 // the list of enabled providers.
2358 if (enabled) {
2359 provider = "+" + provider;
2360 } else {
2361 provider = "-" + provider;
2362 }
2363 putString(cr, Settings.Secure.LOCATION_PROVIDERS_ALLOWED, provider);
2364 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002365 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002366
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002367 /**
2368 * Gservices settings, containing the network names for Google's
2369 * various services. This table holds simple name/addr pairs.
2370 * Addresses can be accessed through the getString() method.
2371 *
2372 * TODO: This should move to partner/google/... somewhere.
2373 *
2374 * @hide
2375 */
2376 public static final class Gservices extends NameValueTable {
2377 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_gservices_version";
2378
2379 /**
2380 * Intent action broadcast when the Gservices table is updated by the server.
2381 * This is broadcast once after settings change (so many values may have been updated).
2382 */
2383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2384 public static final String CHANGED_ACTION =
2385 "com.google.gservices.intent.action.GSERVICES_CHANGED";
2386
Dan Egnorabc25e32009-05-13 19:22:08 -07002387 /**
2388 * Intent action to override Gservices for testing. (Requires WRITE_GSERVICES permission.)
2389 */
2390 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2391 public static final String OVERRIDE_ACTION =
2392 "com.google.gservices.intent.action.GSERVICES_OVERRIDE";
2393
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002394 private static volatile NameValueCache mNameValueCache = null;
2395 private static final Object mNameValueCacheLock = new Object();
2396
2397 /**
2398 * Look up a name in the database.
2399 * @param resolver to access the database with
2400 * @param name to look up in the table
2401 * @return the corresponding value, or null if not present
2402 */
2403 public static String getString(ContentResolver resolver, String name) {
2404 synchronized (mNameValueCacheLock) {
2405 if (mNameValueCache == null) {
2406 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
2407 }
2408 return mNameValueCache.getString(resolver, name);
2409 }
2410 }
2411
2412 /**
2413 * Store a name/value pair into the database.
2414 * @param resolver to access the database with
2415 * @param name to store
2416 * @param value to associate with the name
2417 * @return true if the value was set, false on database errors
2418 */
2419 public static boolean putString(ContentResolver resolver,
2420 String name, String value) {
2421 return putString(resolver, CONTENT_URI, name, value);
2422 }
2423
2424 /**
2425 * Look up the value for name in the database, convert it to an int using Integer.parseInt
2426 * and return it. If it is null or if a NumberFormatException is caught during the
2427 * conversion then return defValue.
2428 */
2429 public static int getInt(ContentResolver resolver, String name, int defValue) {
2430 String valString = getString(resolver, name);
2431 int value;
2432 try {
2433 value = valString != null ? Integer.parseInt(valString) : defValue;
2434 } catch (NumberFormatException e) {
2435 value = defValue;
2436 }
2437 return value;
2438 }
2439
2440 /**
2441 * Look up the value for name in the database, convert it to a long using Long.parseLong
2442 * and return it. If it is null or if a NumberFormatException is caught during the
2443 * conversion then return defValue.
2444 */
2445 public static long getLong(ContentResolver resolver, String name, long defValue) {
2446 String valString = getString(resolver, name);
2447 long value;
2448 try {
2449 value = valString != null ? Long.parseLong(valString) : defValue;
2450 } catch (NumberFormatException e) {
2451 value = defValue;
2452 }
2453 return value;
2454 }
2455
2456 /**
2457 * Construct the content URI for a particular name/value pair,
2458 * useful for monitoring changes with a ContentObserver.
2459 * @param name to look up in the table
2460 * @return the corresponding content URI, or null if not present
2461 */
2462 public static Uri getUriFor(String name) {
2463 return getUriFor(CONTENT_URI, name);
2464 }
2465
2466 /**
2467 * The content:// style URL for this table
2468 */
2469 public static final Uri CONTENT_URI =
2470 Uri.parse("content://" + AUTHORITY + "/gservices");
2471
2472 /**
2473 * MMS - URL to use for HTTP "x-wap-profile" header
2474 */
2475 public static final String MMS_X_WAP_PROFILE_URL
2476 = "mms_x_wap_profile_url";
2477
2478 /**
2479 * YouTube - the flag to indicate whether to use proxy
2480 */
2481 public static final String YOUTUBE_USE_PROXY
2482 = "youtube_use_proxy";
2483
2484 /**
2485 * MMS - maximum message size in bytes for a MMS message.
2486 */
2487 public static final String MMS_MAXIMUM_MESSAGE_SIZE
2488 = "mms_maximum_message_size";
2489
2490 /**
2491 * Event tags from the kernel event log to upload during checkin.
2492 */
2493 public static final String CHECKIN_EVENTS = "checkin_events";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002494
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002495 /**
2496 * Event tags for list of services to upload during checkin.
2497 */
2498 public static final String CHECKIN_DUMPSYS_LIST = "checkin_dumpsys_list";
2499
2500 /**
2501 * The interval (in seconds) between periodic checkin attempts.
2502 */
2503 public static final String CHECKIN_INTERVAL = "checkin_interval";
2504
2505 /**
2506 * Boolean indicating if the market app should force market only checkins on
2507 * install/uninstall. Any non-0 value is considered true.
2508 */
2509 public static final String MARKET_FORCE_CHECKIN = "market_force_checkin";
2510
2511 /**
2512 * How frequently (in seconds) to check the memory status of the
2513 * device.
2514 */
2515 public static final String MEMCHECK_INTERVAL = "memcheck_interval";
2516
2517 /**
2518 * Max frequency (in seconds) to log memory check stats, in realtime
2519 * seconds. This allows for throttling of logs when the device is
2520 * running for large amounts of time.
2521 */
2522 public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
2523 "memcheck_log_realtime_interval";
2524
2525 /**
2526 * Boolean indicating whether rebooting due to system memory checks
2527 * is enabled.
2528 */
2529 public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
2530
2531 /**
2532 * How many bytes the system process must be below to avoid scheduling
2533 * a soft reboot. This reboot will happen when it is next determined
2534 * to be a good time.
2535 */
2536 public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
2537
2538 /**
2539 * How many bytes the system process must be below to avoid scheduling
2540 * a hard reboot. This reboot will happen immediately.
2541 */
2542 public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
2543
2544 /**
2545 * How many bytes the phone process must be below to avoid scheduling
2546 * a soft restart. This restart will happen when it is next determined
2547 * to be a good time.
2548 */
2549 public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
2550
2551 /**
2552 * How many bytes the phone process must be below to avoid scheduling
2553 * a hard restart. This restart will happen immediately.
2554 */
2555 public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
2556
2557 /**
2558 * Boolean indicating whether restarting the phone process due to
2559 * memory checks is enabled.
2560 */
2561 public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
2562
2563 /**
2564 * First time during the day it is okay to kill processes
2565 * or reboot the device due to low memory situations. This number is
2566 * in seconds since midnight.
2567 */
2568 public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
2569
2570 /**
2571 * Last time during the day it is okay to kill processes
2572 * or reboot the device due to low memory situations. This number is
2573 * in seconds since midnight.
2574 */
2575 public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
2576
2577 /**
2578 * How long the screen must have been off in order to kill processes
2579 * or reboot. This number is in seconds. A value of -1 means to
2580 * entirely disregard whether the screen is on.
2581 */
2582 public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
2583
2584 /**
2585 * How much time there must be until the next alarm in order to kill processes
2586 * or reboot. This number is in seconds. Note: this value must be
2587 * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
2588 * always see an alarm scheduled within its time.
2589 */
2590 public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
2591
2592 /**
2593 * How frequently to check whether it is a good time to restart things,
2594 * if the device is in a bad state. This number is in seconds. Note:
2595 * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
2596 * the alarm to schedule the recheck will always appear within the
2597 * minimum "do not execute now" time.
2598 */
2599 public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
2600
2601 /**
2602 * How frequently (in DAYS) to reboot the device. If 0, no reboots
2603 * will occur.
2604 */
2605 public static final String REBOOT_INTERVAL = "reboot_interval";
2606
2607 /**
2608 * First time during the day it is okay to force a reboot of the
2609 * device (if REBOOT_INTERVAL is set). This number is
2610 * in seconds since midnight.
2611 */
2612 public static final String REBOOT_START_TIME = "reboot_start_time";
2613
2614 /**
2615 * The window of time (in seconds) after each REBOOT_INTERVAL in which
2616 * a reboot can be executed. If 0, a reboot will always be executed at
2617 * exactly the given time. Otherwise, it will only be executed if
2618 * the device is idle within the window.
2619 */
2620 public static final String REBOOT_WINDOW = "reboot_window";
2621
2622 /**
2623 * The minimum version of the server that is required in order for the device to accept
2624 * the server's recommendations about the initial sync settings to use. When this is unset,
2625 * blank or can't be interpreted as an integer then we will not ask the server for a
2626 * recommendation.
2627 */
2628 public static final String GMAIL_CONFIG_INFO_MIN_SERVER_VERSION =
2629 "gmail_config_info_min_server_version";
2630
2631 /**
2632 * Controls whether Gmail offers a preview button for images.
2633 */
2634 public static final String GMAIL_DISALLOW_IMAGE_PREVIEWS = "gmail_disallow_image_previews";
2635
2636 /**
Cedric Beust079c6f62009-03-24 22:28:03 -07002637 * The maximal size in bytes allowed for attachments when composing messages in Gmail
2638 */
2639 public static final String GMAIL_MAX_ATTACHMENT_SIZE = "gmail_max_attachment_size_bytes";
2640
2641 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002642 * The timeout in milliseconds that Gmail uses when opening a connection and reading
2643 * from it. A missing value or a value of -1 instructs Gmail to use the defaults provided
2644 * by GoogleHttpClient.
2645 */
2646 public static final String GMAIL_TIMEOUT_MS = "gmail_timeout_ms";
2647
2648 /**
2649 * Controls whether Gmail will request an expedited sync when a message is sent. Value must
2650 * be an integer where non-zero means true. Defaults to 1.
2651 */
2652 public static final String GMAIL_SEND_IMMEDIATELY = "gmail_send_immediately";
2653
2654 /**
2655 * Controls whether gmail buffers server responses. Possible values are "memory", for a
2656 * memory-based buffer, or "file", for a temp-file-based buffer. All other values
2657 * (including not set) disable buffering.
2658 */
2659 public static final String GMAIL_BUFFER_SERVER_RESPONSE = "gmail_buffer_server_response";
2660
2661 /**
Cynthia Wong85427f712009-06-10 14:42:42 -07002662 * The maximum size in bytes allowed for the provider to gzip a protocol buffer uploaded to
2663 * the server.
2664 */
2665 public static final String GMAIL_MAX_GZIP_SIZE = "gmail_max_gzip_size_bytes";
2666
2667 /**
Cynthia Wongf62b80fa2009-04-07 17:24:14 -07002668 * Controls whether Gmail will discard uphill operations that repeatedly fail. Value must be
2669 * an integer where non-zero means true. Defaults to 1.
2670 */
2671 public static final String GMAIL_DISCARD_ERROR_UPHILL_OP = "gmail_discard_error_uphill_op";
2672
2673 /**
Cynthia Wong04f0b052009-07-07 11:14:21 -07002674 * Controls how many attempts Gmail will try to upload an uphill operations before it
2675 * abandons the operation. Defaults to 20.
2676 */
2677 public static final String GMAIL_NUM_RETRY_UPHILL_OP = "gmail_discard_error_uphill_op";
2678
2679 /**
Wei Huangceca25f2009-06-19 13:08:39 -07002680 * the transcoder URL for mobile devices.
2681 */
2682 public static final String TRANSCODER_URL = "mobile_transcoder_url";
2683
2684 /**
2685 * URL that points to the privacy terms of the Google Talk service.
2686 */
Tom Taylor2c0a01a2009-06-22 15:17:59 -07002687 public static final String GTALK_TERMS_OF_SERVICE_URL = "gtalk_terms_of_service_url";
Wei Huangceca25f2009-06-19 13:08:39 -07002688
2689 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002690 * Hostname of the GTalk server.
2691 */
2692 public static final String GTALK_SERVICE_HOSTNAME = "gtalk_hostname";
2693
2694 /**
2695 * Secure port of the GTalk server.
2696 */
2697 public static final String GTALK_SERVICE_SECURE_PORT = "gtalk_secure_port";
2698
2699 /**
2700 * The server configurable RMQ acking interval
2701 */
2702 public static final String GTALK_SERVICE_RMQ_ACK_INTERVAL = "gtalk_rmq_ack_interval";
2703
2704 /**
2705 * The minimum reconnect delay for short network outages or when the network is suspended
2706 * due to phone use.
2707 */
2708 public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT =
2709 "gtalk_min_reconnect_delay_short";
2710
2711 /**
2712 * The reconnect variant range for short network outages or when the network is suspended
2713 * due to phone use. A random number between 0 and this constant is computed and
2714 * added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT} to form the initial reconnect
2715 * delay.
2716 */
2717 public static final String GTALK_SERVICE_RECONNECT_VARIANT_SHORT =
2718 "gtalk_reconnect_variant_short";
2719
2720 /**
2721 * The minimum reconnect delay for long network outages
2722 */
2723 public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG =
2724 "gtalk_min_reconnect_delay_long";
2725
2726 /**
2727 * The reconnect variant range for long network outages. A random number between 0 and this
2728 * constant is computed and added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG} to
2729 * form the initial reconnect delay.
2730 */
2731 public static final String GTALK_SERVICE_RECONNECT_VARIANT_LONG =
2732 "gtalk_reconnect_variant_long";
2733
2734 /**
2735 * The maximum reconnect delay time, in milliseconds.
2736 */
2737 public static final String GTALK_SERVICE_MAX_RECONNECT_DELAY =
2738 "gtalk_max_reconnect_delay";
2739
2740 /**
2741 * The network downtime that is considered "short" for the above calculations,
2742 * in milliseconds.
2743 */
2744 public static final String GTALK_SERVICE_SHORT_NETWORK_DOWNTIME =
2745 "gtalk_short_network_downtime";
2746
2747 /**
2748 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2749 * will reset the heartbeat timer. The away heartbeat should be used when the user is
2750 * logged into the GTalk app, but not actively using it.
2751 */
2752 public static final String GTALK_SERVICE_AWAY_HEARTBEAT_INTERVAL_MS =
2753 "gtalk_heartbeat_ping_interval_ms"; // keep the string backward compatible
2754
2755 /**
2756 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2757 * will reset the heartbeat timer. The active heartbeat should be used when the user is
2758 * actively using the GTalk app.
2759 */
2760 public static final String GTALK_SERVICE_ACTIVE_HEARTBEAT_INTERVAL_MS =
2761 "gtalk_active_heartbeat_ping_interval_ms";
2762
2763 /**
2764 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2765 * will reset the heartbeat timer. The sync heartbeat should be used when the user isn't
2766 * logged into the GTalk app, but auto-sync is enabled.
2767 */
2768 public static final String GTALK_SERVICE_SYNC_HEARTBEAT_INTERVAL_MS =
2769 "gtalk_sync_heartbeat_ping_interval_ms";
2770
2771 /**
2772 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2773 * will reset the heartbeat timer. The no sync heartbeat should be used when the user isn't
2774 * logged into the GTalk app, and auto-sync is not enabled.
2775 */
2776 public static final String GTALK_SERVICE_NOSYNC_HEARTBEAT_INTERVAL_MS =
2777 "gtalk_nosync_heartbeat_ping_interval_ms";
2778
2779 /**
2780 * How long we wait to receive a heartbeat ping acknowledgement (or another packet)
2781 * from the GTalk server, before deeming the connection dead.
2782 */
2783 public static final String GTALK_SERVICE_HEARTBEAT_ACK_TIMEOUT_MS =
2784 "gtalk_heartbeat_ack_timeout_ms";
2785
2786 /**
2787 * How long after screen is turned off before we consider the user to be idle.
2788 */
2789 public static final String GTALK_SERVICE_IDLE_TIMEOUT_MS =
2790 "gtalk_idle_timeout_ms";
2791
2792 /**
2793 * By default, GTalkService will always connect to the server regardless of the auto-sync
2794 * setting. However, if this parameter is true, then GTalkService will only connect
2795 * if auto-sync is enabled. Using the GTalk app will trigger the connection too.
2796 */
2797 public static final String GTALK_SERVICE_CONNECT_ON_AUTO_SYNC =
2798 "gtalk_connect_on_auto_sync";
2799
2800 /**
2801 * GTalkService holds a wakelock while broadcasting the intent for data message received.
2802 * It then automatically release the wakelock after a timeout. This setting controls what
2803 * the timeout should be.
2804 */
2805 public static final String GTALK_DATA_MESSAGE_WAKELOCK_MS =
2806 "gtalk_data_message_wakelock_ms";
2807
2808 /**
2809 * The socket read timeout used to control how long ssl handshake wait for reads before
2810 * timing out. This is needed so the ssl handshake doesn't hang for a long time in some
2811 * circumstances.
2812 */
2813 public static final String GTALK_SSL_HANDSHAKE_TIMEOUT_MS =
2814 "gtalk_ssl_handshake_timeout_ms";
2815
2816 /**
Costin Manolacheb8490562009-04-17 17:37:29 -07002817 * Compress the gtalk stream.
2818 */
2819 public static final String GTALK_COMPRESS = "gtalk_compress";
2820
2821 /**
Wei Huanga85d46a2009-05-22 13:30:03 -07002822 * This is the timeout for which Google Talk will send the message using bareJID. In a
2823 * established chat between two XMPP endpoints, Google Talk uses fullJID in the format
2824 * of user@domain/resource in order to send the message to the specific client. However,
2825 * if Google Talk hasn't received a message from that client after some time, it would
2826 * fall back to use the bareJID, which would broadcast the message to all clients for
2827 * the other user.
2828 */
2829 public static final String GTALK_USE_BARE_JID_TIMEOUT_MS = "gtalk_use_barejid_timeout_ms";
2830
2831 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002832 * Enable use of ssl session caching.
2833 * 'db' - save each session in a (per process) database
2834 * 'file' - save each session in a (per process) file
2835 * not set or any other value - normal java in-memory caching
2836 */
2837 public static final String SSL_SESSION_CACHE = "ssl_session_cache";
2838
2839 /**
2840 * How many bytes long a message has to be, in order to be gzipped.
2841 */
2842 public static final String SYNC_MIN_GZIP_BYTES =
2843 "sync_min_gzip_bytes";
2844
2845 /**
2846 * The hash value of the current provisioning settings
2847 */
2848 public static final String PROVISIONING_DIGEST = "digest";
2849
2850 /**
2851 * Provisioning keys to block from server update
2852 */
2853 public static final String PROVISIONING_OVERRIDE = "override";
2854
2855 /**
2856 * "Generic" service name for authentication requests.
2857 */
2858 public static final String GOOGLE_LOGIN_GENERIC_AUTH_SERVICE
2859 = "google_login_generic_auth_service";
2860
2861 /**
2862 * Frequency in milliseconds at which we should sync the locally installed Vending Machine
2863 * content with the server.
2864 */
2865 public static final String VENDING_SYNC_FREQUENCY_MS = "vending_sync_frequency_ms";
2866
2867 /**
2868 * Support URL that is opened in a browser when user clicks on 'Help and Info' in Vending
2869 * Machine.
2870 */
2871 public static final String VENDING_SUPPORT_URL = "vending_support_url";
2872
2873 /**
2874 * Indicates if Vending Machine requires a SIM to be in the phone to allow a purchase.
2875 *
2876 * true = SIM is required
2877 * false = SIM is not required
2878 */
2879 public static final String VENDING_REQUIRE_SIM_FOR_PURCHASE =
2880 "vending_require_sim_for_purchase";
2881
2882 /**
2883 * The current version id of the Vending Machine terms of service.
2884 */
2885 public static final String VENDING_TOS_VERSION = "vending_tos_version";
2886
2887 /**
2888 * URL that points to the terms of service for Vending Machine.
2889 */
2890 public static final String VENDING_TOS_URL = "vending_tos_url";
2891
2892 /**
2893 * Whether to use sierraqa instead of sierra tokens for the purchase flow in
2894 * Vending Machine.
2895 *
2896 * true = use sierraqa
2897 * false = use sierra (default)
2898 */
2899 public static final String VENDING_USE_CHECKOUT_QA_SERVICE =
2900 "vending_use_checkout_qa_service";
2901
2902 /**
Mark Womack63f49f12009-03-25 16:54:49 -07002903 * Default value to use for all/free/priced filter in Market.
2904 * Valid values: ALL, FREE, PAID (case insensitive)
2905 */
2906 public static final String VENDING_DEFAULT_FILTER = "vending_default_filter";
2907 /**
2908 * Ranking type value to use for the first category tab (currently popular)
2909 */
2910 public static final String VENDING_TAB_1_RANKING_TYPE = "vending_tab_1_ranking_type";
2911
2912 /**
2913 * Title string to use for first category tab.
2914 */
2915 public static final String VENDING_TAB_1_TITLE = "vending_tab_1_title";
2916
2917 /**
2918 * Ranking type value to use for the second category tab (currently newest)
2919 */
2920 public static final String VENDING_TAB_2_RANKING_TYPE = "vending_tab_2_ranking_type";
2921
2922 /**
2923 * Title string to use for second category tab.
2924 */
2925 public static final String VENDING_TAB_2_TITLE = "vending_tab_2_title";
2926
2927 /**
Linda Nguyenabd7eba2009-06-18 18:52:59 -07002928 * Frequency in milliseconds at which we should request MCS heartbeats
2929 * from the Vending Machine client.
2930 */
2931 public static final String VENDING_HEARTBEAT_FREQUENCY_MS =
2932 "vending_heartbeat_frequency_ms";
2933
2934 /**
lknguyenb0cba432009-06-29 20:50:25 -07002935 * Frequency in milliseconds at which we should resend pending download
2936 * requests to the API Server from the Vending Machine client.
2937 */
2938 public static final String VENDING_PENDING_DOWNLOAD_RESEND_FREQUENCY_MS =
lknguyen09b33732009-06-30 13:52:45 -07002939 "vending_pd_resend_frequency_ms";
lknguyenb0cba432009-06-29 20:50:25 -07002940
2941 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002942 * URL that points to the legal terms of service to display in Settings.
2943 * <p>
2944 * This should be a https URL. For a pretty user-friendly URL, use
2945 * {@link #SETTINGS_TOS_PRETTY_URL}.
2946 */
2947 public static final String SETTINGS_TOS_URL = "settings_tos_url";
2948
2949 /**
2950 * URL that points to the legal terms of service to display in Settings.
2951 * <p>
2952 * This should be a pretty http URL. For the URL the device will access
2953 * via Settings, use {@link #SETTINGS_TOS_URL}.
2954 */
2955 public static final String SETTINGS_TOS_PRETTY_URL = "settings_tos_pretty_url";
2956
2957 /**
2958 * URL that points to the contributors to display in Settings.
2959 * <p>
2960 * This should be a https URL. For a pretty user-friendly URL, use
2961 * {@link #SETTINGS_CONTRIBUTORS_PRETTY_URL}.
2962 */
2963 public static final String SETTINGS_CONTRIBUTORS_URL = "settings_contributors_url";
2964
2965 /**
2966 * URL that points to the contributors to display in Settings.
2967 * <p>
2968 * This should be a pretty http URL. For the URL the device will access
2969 * via Settings, use {@link #SETTINGS_CONTRIBUTORS_URL}.
2970 */
2971 public static final String SETTINGS_CONTRIBUTORS_PRETTY_URL =
2972 "settings_contributors_pretty_url";
2973
2974 /**
2975 * URL that points to the Terms Of Service for the device.
2976 * <p>
2977 * This should be a pretty http URL.
2978 */
2979 public static final String SETUP_GOOGLE_TOS_URL = "setup_google_tos_url";
2980
2981 /**
2982 * URL that points to the Android privacy policy for the device.
2983 * <p>
2984 * This should be a pretty http URL.
2985 */
2986 public static final String SETUP_ANDROID_PRIVACY_URL = "setup_android_privacy_url";
2987
2988 /**
2989 * URL that points to the Google privacy policy for the device.
2990 * <p>
2991 * This should be a pretty http URL.
2992 */
2993 public static final String SETUP_GOOGLE_PRIVACY_URL = "setup_google_privacy_url";
2994
2995 /**
2996 * Request an MSISDN token for various Google services.
2997 */
2998 public static final String USE_MSISDN_TOKEN = "use_msisdn_token";
2999
3000 /**
3001 * RSA public key used to encrypt passwords stored in the database.
3002 */
3003 public static final String GLS_PUBLIC_KEY = "google_login_public_key";
3004
3005 /**
3006 * Only check parental control status if this is set to "true".
3007 */
3008 public static final String PARENTAL_CONTROL_CHECK_ENABLED =
3009 "parental_control_check_enabled";
3010
3011 /**
3012 * The list of applications we need to block if parental control is
3013 * enabled.
3014 */
3015 public static final String PARENTAL_CONTROL_APPS_LIST =
3016 "parental_control_apps_list";
3017
3018 /**
3019 * Duration in which parental control status is valid.
3020 */
3021 public static final String PARENTAL_CONTROL_TIMEOUT_IN_MS =
3022 "parental_control_timeout_in_ms";
3023
3024 /**
3025 * When parental control is off, we expect to get this string from the
3026 * litmus url.
3027 */
3028 public static final String PARENTAL_CONTROL_EXPECTED_RESPONSE =
3029 "parental_control_expected_response";
3030
3031 /**
3032 * When the litmus url returns a 302, declare parental control to be on
3033 * only if the redirect url matches this regular expression.
3034 */
3035 public static final String PARENTAL_CONTROL_REDIRECT_REGEX =
3036 "parental_control_redirect_regex";
3037
3038 /**
3039 * Threshold for the amount of change in disk free space required to report the amount of
3040 * free space. Used to prevent spamming the logs when the disk free space isn't changing
3041 * frequently.
3042 */
3043 public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
3044 "disk_free_change_reporting_threshold";
3045
3046 /**
3047 * Prefix for new Google services published by the checkin
3048 * server.
3049 */
3050 public static final String GOOGLE_SERVICES_PREFIX
3051 = "google_services:";
3052
3053 /**
3054 * The maximum reconnect delay for short network outages or when the network is suspended
3055 * due to phone use.
3056 */
3057 public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
3058 "sync_max_retry_delay_in_seconds";
3059
3060 /**
3061 * Minimum percentage of free storage on the device that is used to determine if
3062 * the device is running low on storage.
3063 * Say this value is set to 10, the device is considered running low on storage
3064 * if 90% or more of the device storage is filled up.
3065 */
3066 public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
3067 "sys_storage_threshold_percentage";
3068
3069 /**
3070 * The interval in minutes after which the amount of free storage left on the
3071 * device is logged to the event log
3072 */
3073 public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
3074 "sys_free_storage_log_interval";
3075
3076 /**
3077 * The interval in milliseconds at which to check the number of SMS sent
3078 * out without asking for use permit, to limit the un-authorized SMS
3079 * usage.
3080 */
jsh867641e2009-05-27 17:32:50 -07003081 public static final String SMS_OUTGOING_CHECK_INTERVAL_MS =
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003082 "sms_outgoing_check_interval_ms";
3083
3084 /**
3085 * The number of outgoing SMS sent without asking for user permit
jsh867641e2009-05-27 17:32:50 -07003086 * (of {@link #SMS_OUTGOING_CHECK_INTERVAL_MS}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003087 */
3088 public static final String SMS_OUTGOING_CEHCK_MAX_COUNT =
3089 "sms_outgoing_check_max_count";
3090
3091 /**
3092 * The interval in milliseconds at which to check packet counts on the
3093 * mobile data interface when screen is on, to detect possible data
3094 * connection problems.
3095 */
3096 public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
3097 "pdp_watchdog_poll_interval_ms";
3098
3099 /**
3100 * The interval in milliseconds at which to check packet counts on the
3101 * mobile data interface when screen is off, to detect possible data
3102 * connection problems.
3103 */
3104 public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
3105 "pdp_watchdog_long_poll_interval_ms";
3106
3107 /**
3108 * The interval in milliseconds at which to check packet counts on the
3109 * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
3110 * outgoing packets has been reached without incoming packets.
3111 */
3112 public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
3113 "pdp_watchdog_error_poll_interval_ms";
3114
3115 /**
3116 * The number of outgoing packets sent without seeing an incoming packet
3117 * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
3118 * device is logged to the event log
3119 */
3120 public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
3121 "pdp_watchdog_trigger_packet_count";
3122
3123 /**
3124 * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
3125 * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
3126 * attempting data connection recovery.
3127 */
3128 public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
3129 "pdp_watchdog_error_poll_count";
3130
3131 /**
3132 * The number of failed PDP reset attempts before moving to something more
3133 * drastic: re-registering to the network.
3134 */
3135 public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
3136 "pdp_watchdog_max_pdp_reset_fail_count";
3137
3138 /**
3139 * Address to ping as a last sanity check before attempting any recovery.
3140 * Unset or set to "0.0.0.0" to skip this check.
3141 */
3142 public static final String PDP_WATCHDOG_PING_ADDRESS = "pdp_watchdog_ping_address";
3143
3144 /**
3145 * The "-w deadline" parameter for the ping, ie, the max time in
3146 * seconds to spend pinging.
3147 */
3148 public static final String PDP_WATCHDOG_PING_DEADLINE = "pdp_watchdog_ping_deadline";
3149
3150 /**
3151 * The interval in milliseconds at which to check gprs registration
3152 * after the first registration mismatch of gprs and voice service,
3153 * to detect possible data network registration problems.
3154 *
3155 */
3156 public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
3157 "gprs_register_check_period_ms";
3158
3159 /**
3160 * The interval in milliseconds after which Wi-Fi is considered idle.
3161 * When idle, it is possible for the device to be switched from Wi-Fi to
3162 * the mobile data network.
3163 */
3164 public static final String WIFI_IDLE_MS = "wifi_idle_ms";
3165
3166 /**
3167 * Screen timeout in milliseconds corresponding to the
3168 * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
3169 * possible screen timeout behavior.)
3170 */
3171 public static final String SHORT_KEYLIGHT_DELAY_MS =
3172 "short_keylight_delay_ms";
3173
3174 /**
3175 * URL that points to the voice search servers. To be factored out of this class.
3176 */
3177 public static final String VOICE_SEARCH_URL = "voice_search_url";
3178
3179 /**
3180 * Speech encoding used with voice search on 3G networks. To be factored out of this class.
3181 */
3182 public static final String VOICE_SEARCH_ENCODING_THREE_G = "voice_search_encoding_three_g";
3183
3184 /**
3185 * Speech encoding used with voice search on WIFI networks. To be factored out of this class.
3186 */
3187 public static final String VOICE_SEARCH_ENCODING_WIFI = "voice_search_encoding_wifi";
3188
3189 /**
3190 * Whether to use automatic gain control in voice search (0 = disable, 1 = enable).
3191 * To be factored out of this class.
3192 */
3193 public static final String VOICE_SEARCH_ENABLE_AGC = "voice_search_enable_agc";
3194
3195 /**
3196 * Whether to use noise suppression in voice search (0 = disable, 1 = enable).
3197 * To be factored out of this class.
3198 */
3199 public static final String VOICE_SEARCH_ENABLE_NS = "voice_search_enable_ns";
3200
3201 /**
3202 * Whether to use the IIR filter in voice search (0 = disable, 1 = enable).
3203 * To be factored out of this class.
3204 */
3205 public static final String VOICE_SEARCH_ENABLE_IIR = "voice_search_enable_iir";
3206
3207 /**
3208 * List of test suites (local disk filename) for the automatic instrumentation test runner.
3209 * The file format is similar to automated_suites.xml, see AutoTesterService.
3210 * If this setting is missing or empty, the automatic test runner will not start.
3211 */
3212 public static final String AUTOTEST_SUITES_FILE = "autotest_suites_file";
3213
3214 /**
3215 * Interval between synchronous checkins forced by the automatic test runner.
3216 * If you set this to a value smaller than CHECKIN_INTERVAL, then the test runner's
3217 * frequent checkins will prevent asynchronous background checkins from interfering
3218 * with any performance measurements.
3219 */
3220 public static final String AUTOTEST_CHECKIN_SECONDS = "autotest_checkin_seconds";
3221
3222 /**
3223 * Interval between reboots forced by the automatic test runner.
3224 */
3225 public static final String AUTOTEST_REBOOT_SECONDS = "autotest_reboot_seconds";
3226
3227
3228 /**
3229 * Threshold values for the duration and level of a discharge cycle, under
3230 * which we log discharge cycle info.
3231 */
3232 public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
3233 "battery_discharge_duration_threshold";
3234 public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003235
The Android Open Source Project4df24232009-03-05 14:34:35 -08003236 /**
3237 * An email address that anr bugreports should be sent to.
3238 */
3239 public static final String ANR_BUGREPORT_RECIPIENT = "anr_bugreport_recipient";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003240
3241 /**
Amith Yamasani430555ac2009-06-11 22:35:39 -07003242 * Flag for allowing service provider to use location information to improve products and
3243 * services.
3244 * Type: int ( 0 = disallow, 1 = allow )
Amith Yamasani630cd062009-06-19 12:07:02 -07003245 * @deprecated
Amith Yamasani430555ac2009-06-11 22:35:39 -07003246 */
3247 public static final String USE_LOCATION_FOR_SERVICES = "use_location";
3248
3249 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003250 * @deprecated
3251 * @hide
3252 */
3253 @Deprecated // Obviated by NameValueCache: just fetch the value directly.
3254 public static class QueryMap extends ContentQueryMap {
3255
3256 public QueryMap(ContentResolver contentResolver, Cursor cursor, boolean keepUpdated,
3257 Handler handlerForUpdateNotifications) {
3258 super(cursor, NAME, keepUpdated, handlerForUpdateNotifications);
3259 }
3260
3261 public QueryMap(ContentResolver contentResolver, boolean keepUpdated,
3262 Handler handlerForUpdateNotifications) {
3263 this(contentResolver,
3264 contentResolver.query(CONTENT_URI, null, null, null, null),
3265 keepUpdated, handlerForUpdateNotifications);
3266 }
3267
3268 public String getString(String name) {
3269 ContentValues cv = getValues(name);
3270 if (cv == null) return null;
3271 return cv.getAsString(VALUE);
3272 }
3273 }
3274
3275 }
3276
3277 /**
3278 * User-defined bookmarks and shortcuts. The target of each bookmark is an
3279 * Intent URL, allowing it to be either a web page or a particular
3280 * application activity.
3281 *
3282 * @hide
3283 */
3284 public static final class Bookmarks implements BaseColumns
3285 {
3286 private static final String TAG = "Bookmarks";
3287
3288 /**
3289 * The content:// style URL for this table
3290 */
3291 public static final Uri CONTENT_URI =
3292 Uri.parse("content://" + AUTHORITY + "/bookmarks");
3293
3294 /**
3295 * The row ID.
3296 * <p>Type: INTEGER</p>
3297 */
3298 public static final String ID = "_id";
3299
3300 /**
3301 * Descriptive name of the bookmark that can be displayed to the user.
3302 * If this is empty, the title should be resolved at display time (use
3303 * {@link #getTitle(Context, Cursor)} any time you want to display the
3304 * title of a bookmark.)
3305 * <P>
3306 * Type: TEXT
3307 * </P>
3308 */
3309 public static final String TITLE = "title";
3310
3311 /**
3312 * Arbitrary string (displayed to the user) that allows bookmarks to be
3313 * organized into categories. There are some special names for
3314 * standard folders, which all start with '@'. The label displayed for
3315 * the folder changes with the locale (via {@link #getLabelForFolder}) but
3316 * the folder name does not change so you can consistently query for
3317 * the folder regardless of the current locale.
3318 *
3319 * <P>Type: TEXT</P>
3320 *
3321 */
3322 public static final String FOLDER = "folder";
3323
3324 /**
3325 * The Intent URL of the bookmark, describing what it points to. This
3326 * value is given to {@link android.content.Intent#getIntent} to create
3327 * an Intent that can be launched.
3328 * <P>Type: TEXT</P>
3329 */
3330 public static final String INTENT = "intent";
3331
3332 /**
3333 * Optional shortcut character associated with this bookmark.
3334 * <P>Type: INTEGER</P>
3335 */
3336 public static final String SHORTCUT = "shortcut";
3337
3338 /**
3339 * The order in which the bookmark should be displayed
3340 * <P>Type: INTEGER</P>
3341 */
3342 public static final String ORDERING = "ordering";
3343
3344 private static final String[] sIntentProjection = { INTENT };
3345 private static final String[] sShortcutProjection = { ID, SHORTCUT };
3346 private static final String sShortcutSelection = SHORTCUT + "=?";
3347
3348 /**
3349 * Convenience function to retrieve the bookmarked Intent for a
3350 * particular shortcut key.
3351 *
3352 * @param cr The ContentResolver to query.
3353 * @param shortcut The shortcut key.
3354 *
3355 * @return Intent The bookmarked URL, or null if there is no bookmark
3356 * matching the given shortcut.
3357 */
3358 public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3359 {
3360 Intent intent = null;
3361
3362 Cursor c = cr.query(CONTENT_URI,
3363 sIntentProjection, sShortcutSelection,
3364 new String[] { String.valueOf((int) shortcut) }, ORDERING);
3365 // Keep trying until we find a valid shortcut
3366 try {
3367 while (intent == null && c.moveToNext()) {
3368 try {
3369 String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
3370 intent = Intent.getIntent(intentURI);
3371 } catch (java.net.URISyntaxException e) {
3372 // The stored URL is bad... ignore it.
3373 } catch (IllegalArgumentException e) {
3374 // Column not found
3375 Log.e(TAG, "Intent column not found", e);
3376 }
3377 }
3378 } finally {
3379 if (c != null) c.close();
3380 }
3381
3382 return intent;
3383 }
3384
3385 /**
3386 * Add a new bookmark to the system.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003387 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003388 * @param cr The ContentResolver to query.
3389 * @param intent The desired target of the bookmark.
3390 * @param title Bookmark title that is shown to the user; null if none
3391 * or it should be resolved to the intent's title.
3392 * @param folder Folder in which to place the bookmark; null if none.
3393 * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3394 * this is non-zero and there is an existing bookmark entry
3395 * with this same shortcut, then that existing shortcut is
3396 * cleared (the bookmark is not removed).
3397 * @return The unique content URL for the new bookmark entry.
3398 */
3399 public static Uri add(ContentResolver cr,
3400 Intent intent,
3401 String title,
3402 String folder,
3403 char shortcut,
3404 int ordering)
3405 {
3406 // If a shortcut is supplied, and it is already defined for
3407 // another bookmark, then remove the old definition.
3408 if (shortcut != 0) {
3409 Cursor c = cr.query(CONTENT_URI,
3410 sShortcutProjection, sShortcutSelection,
3411 new String[] { String.valueOf((int) shortcut) }, null);
3412 try {
3413 if (c.moveToFirst()) {
3414 while (c.getCount() > 0) {
3415 if (!c.deleteRow()) {
3416 Log.w(TAG, "Could not delete existing shortcut row");
3417 }
3418 }
3419 }
3420 } finally {
3421 if (c != null) c.close();
3422 }
3423 }
3424
3425 ContentValues values = new ContentValues();
3426 if (title != null) values.put(TITLE, title);
3427 if (folder != null) values.put(FOLDER, folder);
3428 values.put(INTENT, intent.toURI());
3429 if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3430 values.put(ORDERING, ordering);
3431 return cr.insert(CONTENT_URI, values);
3432 }
3433
3434 /**
3435 * Return the folder name as it should be displayed to the user. This
3436 * takes care of localizing special folders.
3437 *
3438 * @param r Resources object for current locale; only need access to
3439 * system resources.
3440 * @param folder The value found in the {@link #FOLDER} column.
3441 *
3442 * @return CharSequence The label for this folder that should be shown
3443 * to the user.
3444 */
3445 public static CharSequence getLabelForFolder(Resources r, String folder) {
3446 return folder;
3447 }
3448
3449 /**
3450 * Return the title as it should be displayed to the user. This takes
3451 * care of localizing bookmarks that point to activities.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003452 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003453 * @param context A context.
3454 * @param cursor A cursor pointing to the row whose title should be
3455 * returned. The cursor must contain at least the {@link #TITLE}
3456 * and {@link #INTENT} columns.
3457 * @return A title that is localized and can be displayed to the user,
3458 * or the empty string if one could not be found.
3459 */
3460 public static CharSequence getTitle(Context context, Cursor cursor) {
3461 int titleColumn = cursor.getColumnIndex(TITLE);
3462 int intentColumn = cursor.getColumnIndex(INTENT);
3463 if (titleColumn == -1 || intentColumn == -1) {
3464 throw new IllegalArgumentException(
3465 "The cursor must contain the TITLE and INTENT columns.");
3466 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003467
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003468 String title = cursor.getString(titleColumn);
3469 if (!TextUtils.isEmpty(title)) {
3470 return title;
3471 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003472
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003473 String intentUri = cursor.getString(intentColumn);
3474 if (TextUtils.isEmpty(intentUri)) {
3475 return "";
3476 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003477
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003478 Intent intent;
3479 try {
3480 intent = Intent.getIntent(intentUri);
3481 } catch (URISyntaxException e) {
3482 return "";
3483 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003484
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003485 PackageManager packageManager = context.getPackageManager();
3486 ResolveInfo info = packageManager.resolveActivity(intent, 0);
3487 return info != null ? info.loadLabel(packageManager) : "";
3488 }
3489 }
3490
3491 /**
3492 * Returns the GTalk JID resource associated with this device.
3493 *
3494 * @return String the JID resource of the device. It uses the device IMEI in the computation
3495 * of the JID resource. If IMEI is not ready (i.e. telephony module not ready), we'll return
3496 * an empty string.
3497 * @hide
3498 */
3499 // TODO: we shouldn't not have a permenant Jid resource, as that's an easy target for
3500 // spams. We should change it once a while, like when we resubscribe to the subscription feeds
3501 // server.
3502 // (also, should this live in GTalkService?)
3503 public static synchronized String getJidResource() {
3504 if (sJidResource != null) {
3505 return sJidResource;
3506 }
3507
3508 MessageDigest digest;
3509 try {
3510 digest = MessageDigest.getInstance("SHA-1");
3511 } catch (NoSuchAlgorithmException e) {
3512 throw new RuntimeException("this should never happen");
3513 }
3514
Wink Saville767a6622009-04-02 01:37:02 -07003515 String deviceId = TelephonyManager.getDefault().getDeviceId();
3516 if (TextUtils.isEmpty(deviceId)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003517 return "";
3518 }
3519
Wink Saville767a6622009-04-02 01:37:02 -07003520 byte[] hashedDeviceId = digest.digest(deviceId.getBytes());
3521 String id = new String(Base64.encodeBase64(hashedDeviceId), 0, 12);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003522 id = id.replaceAll("/", "_");
3523 sJidResource = JID_RESOURCE_PREFIX + id;
3524 return sJidResource;
3525 }
3526
3527 /**
3528 * Returns the device ID that we should use when connecting to the mobile gtalk server.
3529 * This is a string like "android-0x1242", where the hex string is the Android ID obtained
3530 * from the GoogleLoginService.
3531 *
3532 * @param androidId The Android ID for this device.
3533 * @return The device ID that should be used when connecting to the mobile gtalk server.
3534 * @hide
3535 */
3536 public static String getGTalkDeviceId(long androidId) {
3537 return "android-" + Long.toHexString(androidId);
3538 }
3539}