blob: 993e4dc3a738f4eb047994b18f1d37584333e25c [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";
151
152 /**
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";
308
309 /**
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";
322
323 /**
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.
332 *
333 * @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";
352
353 /**
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";
407
408 // 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;
498
499 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}.
888 *
889 * @hide pending API council
890 */
891 public static final String WIFI_SLEEP_POLICY = "wifi_sleep_policy";
892
893 /**
894 * Value for {@link #WIFI_SLEEP_POLICY} to use the default Wi-Fi sleep
895 * policy, which is to sleep shortly after the turning off
896 * according to the {@link #STAY_ON_WHILE_PLUGGED_IN} setting.
897 *
898 * @hide pending API council
899 */
900 public static final int WIFI_SLEEP_POLICY_DEFAULT = 0;
901
902 /**
903 * Value for {@link #WIFI_SLEEP_POLICY} to use the default policy when
904 * the device is on battery, and never go to sleep when the device is
905 * plugged in.
906 *
907 * @hide pending API council
908 */
909 public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED = 1;
910
911 /**
912 * Value for {@link #WIFI_SLEEP_POLICY} to never go to sleep.
913 *
914 * @hide pending API council
915 */
916 public static final int WIFI_SLEEP_POLICY_NEVER = 2;
917
918 /**
919 * Whether to use static IP and other static network attributes.
920 * <p>
921 * Set to 1 for true and 0 for false.
922 */
923 public static final String WIFI_USE_STATIC_IP = "wifi_use_static_ip";
924
925 /**
926 * The static IP address.
927 * <p>
928 * Example: "192.168.1.51"
929 */
930 public static final String WIFI_STATIC_IP = "wifi_static_ip";
931
932 /**
933 * If using static IP, the gateway's IP address.
934 * <p>
935 * Example: "192.168.1.1"
936 */
937 public static final String WIFI_STATIC_GATEWAY = "wifi_static_gateway";
938
939 /**
940 * If using static IP, the net mask.
941 * <p>
942 * Example: "255.255.255.0"
943 */
944 public static final String WIFI_STATIC_NETMASK = "wifi_static_netmask";
945
946 /**
947 * If using static IP, the primary DNS's IP address.
948 * <p>
949 * Example: "192.168.1.1"
950 */
951 public static final String WIFI_STATIC_DNS1 = "wifi_static_dns1";
952
953 /**
954 * If using static IP, the secondary DNS's IP address.
955 * <p>
956 * Example: "192.168.1.2"
957 */
958 public static final String WIFI_STATIC_DNS2 = "wifi_static_dns2";
959
960 /**
961 * The number of radio channels that are allowed in the local
962 * 802.11 regulatory domain.
963 * @hide
964 */
965 public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
966
967 /**
968 * Determines whether remote devices may discover and/or connect to
969 * this device.
970 * <P>Type: INT</P>
971 * 2 -- discoverable and connectable
972 * 1 -- connectable but not discoverable
973 * 0 -- neither connectable nor discoverable
974 */
975 public static final String BLUETOOTH_DISCOVERABILITY =
976 "bluetooth_discoverability";
977
978 /**
979 * Bluetooth discoverability timeout. If this value is nonzero, then
980 * Bluetooth becomes discoverable for a certain number of seconds,
981 * after which is becomes simply connectable. The value is in seconds.
982 */
983 public static final String BLUETOOTH_DISCOVERABILITY_TIMEOUT =
984 "bluetooth_discoverability_timeout";
985
986 /**
987 * Whether autolock is enabled (0 = false, 1 = true)
988 */
989 public static final String LOCK_PATTERN_ENABLED = "lock_pattern_autolock";
990
991 /**
992 * Whether lock pattern is visible as user enters (0 = false, 1 = true)
993 */
994 public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
995
996 /**
997 * Whether lock pattern will vibrate as user enters (0 = false, 1 = true)
998 */
999 public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
1000 "lock_pattern_tactile_feedback_enabled";
1001
1002
1003 /**
1004 * A formatted string of the next alarm that is set, or the empty string
1005 * if there is no alarm set.
1006 */
1007 public static final String NEXT_ALARM_FORMATTED = "next_alarm_formatted";
1008
1009 /**
1010 * Scaling factor for fonts, float.
1011 */
1012 public static final String FONT_SCALE = "font_scale";
1013
1014 /**
1015 * Name of an application package to be debugged.
1016 */
1017 public static final String DEBUG_APP = "debug_app";
1018
1019 /**
1020 * If 1, when launching DEBUG_APP it will wait for the debugger before
1021 * starting user code. If 0, it will run normally.
1022 */
1023 public static final String WAIT_FOR_DEBUGGER = "wait_for_debugger";
1024
1025 /**
1026 * Whether or not to dim the screen. 0=no 1=yes
1027 */
1028 public static final String DIM_SCREEN = "dim_screen";
1029
1030 /**
1031 * The timeout before the screen turns off.
1032 */
1033 public static final String SCREEN_OFF_TIMEOUT = "screen_off_timeout";
1034
1035 /**
1036 * 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.
1126 *
1127 * @hide
1128 */
1129 public static final String NOTIFICATIONS_USE_RING_VOLUME =
1130 "notifications_use_ring_volume";
1131
1132 /**
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";
1199
1200 /**
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 /**
1277 * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1278 * boolean (1 or 0).
1279 */
1280 public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
1281
1282 /**
1283 * Whether the haptic feedback (long presses, ...) are enabled. The value is
1284 * boolean (1 or 0).
1285 */
1286 public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
1287
1288 // Settings moved to Settings.Secure
1289
1290 /**
Mike Lockwood460ae0c2009-04-02 22:33:27 -07001291 * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001292 * instead
1293 */
1294 @Deprecated
1295 public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1296
1297 /**
1298 * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1299 */
1300 @Deprecated
1301 public static final String ANDROID_ID = Secure.ANDROID_ID;
1302
1303 /**
1304 * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1305 */
1306 @Deprecated
1307 public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1308
1309 /**
1310 * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1311 */
1312 @Deprecated
1313 public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1314
1315 /**
1316 * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1317 */
1318 @Deprecated
1319 public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1320
1321 /**
1322 * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1323 */
1324 @Deprecated
1325 public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1326
1327 /**
1328 * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1329 */
1330 @Deprecated
1331 public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
1332
1333 /**
1334 * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1335 * instead
1336 */
1337 @Deprecated
1338 public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1339
1340 /**
1341 * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1342 */
1343 @Deprecated
1344 public static final String LOGGING_ID = Secure.LOGGING_ID;
1345
1346 /**
1347 * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1348 */
1349 @Deprecated
1350 public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1351
1352 /**
1353 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1354 * instead
1355 */
1356 @Deprecated
1357 public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1358
1359 /**
1360 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1361 * instead
1362 */
1363 @Deprecated
1364 public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1365
1366 /**
1367 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1368 * instead
1369 */
1370 @Deprecated
1371 public static final String PARENTAL_CONTROL_REDIRECT_URL =
1372 Secure.PARENTAL_CONTROL_REDIRECT_URL;
1373
1374 /**
1375 * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1376 */
1377 @Deprecated
1378 public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1379
1380 /**
1381 * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1382 */
1383 @Deprecated
1384 public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
1385
1386 /**
1387 * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1388 */
1389 @Deprecated
1390 public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1391
1392// /**
1393// * @deprecated Use {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT}
1394// * instead
1395// */
1396 @Deprecated
1397 public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1398
1399// /**
1400// * @deprecated Use
1401// * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS}
1402// * instead
1403// */
1404 @Deprecated
1405 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1406 Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1407
1408 /**
1409 * @deprecated Use
1410 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1411 */
1412 @Deprecated
1413 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1414 Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
1415
1416 /**
1417 * @deprecated Use
1418 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
1419 */
1420 @Deprecated
1421 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1422 Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
1423
1424 /**
1425 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
1426 * instead
1427 */
1428 @Deprecated
1429 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
1430
1431 /**
1432 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
1433 */
1434 @Deprecated
1435 public static final String WIFI_ON = Secure.WIFI_ON;
1436
1437 /**
1438 * @deprecated Use
1439 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
1440 * instead
1441 */
1442 @Deprecated
1443 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1444 Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
1445
1446 /**
1447 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
1448 */
1449 @Deprecated
1450 public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
1451
1452 /**
1453 * @deprecated Use
1454 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
1455 */
1456 @Deprecated
1457 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1458 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
1459
1460 /**
1461 * @deprecated Use
1462 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
1463 */
1464 @Deprecated
1465 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1466 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
1467
1468 /**
1469 * @deprecated Use
1470 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
1471 * instead
1472 */
1473 @Deprecated
1474 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1475 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
1476
1477 /**
1478 * @deprecated Use
1479 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
1480 */
1481 @Deprecated
1482 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
1483 Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
1484
1485 /**
1486 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
1487 * instead
1488 */
1489 @Deprecated
1490 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
1491
1492 /**
1493 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
1494 */
1495 @Deprecated
1496 public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
1497
1498 /**
1499 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
1500 */
1501 @Deprecated
1502 public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
1503
1504 /**
1505 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
1506 * instead
1507 */
1508 @Deprecated
1509 public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
1510
1511 /**
1512 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
1513 * instead
1514 */
1515 @Deprecated
1516 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
1517 Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
1518 }
1519
1520 /**
1521 * Secure system settings, containing system preferences that applications
1522 * can read but are not allowed to write. These are for preferences that
1523 * the user must explicitly modify through the system UI or specialized
1524 * APIs for those values, not modified directly by applications.
1525 */
1526 public static final class Secure extends NameValueTable {
1527 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
1528
1529 private static volatile NameValueCache mNameValueCache = null;
1530
1531 /**
1532 * Look up a name in the database.
1533 * @param resolver to access the database with
1534 * @param name to look up in the table
1535 * @return the corresponding value, or null if not present
1536 */
1537 public synchronized static String getString(ContentResolver resolver, String name) {
1538 if (mNameValueCache == null) {
1539 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
1540 }
1541 return mNameValueCache.getString(resolver, name);
1542 }
1543
1544 /**
1545 * Store a name/value pair into the database.
1546 * @param resolver to access the database with
1547 * @param name to store
1548 * @param value to associate with the name
1549 * @return true if the value was set, false on database errors
1550 */
1551 public static boolean putString(ContentResolver resolver,
1552 String name, String value) {
1553 return putString(resolver, CONTENT_URI, name, value);
1554 }
1555
1556 /**
1557 * Construct the content URI for a particular name/value pair,
1558 * useful for monitoring changes with a ContentObserver.
1559 * @param name to look up in the table
1560 * @return the corresponding content URI, or null if not present
1561 */
1562 public static Uri getUriFor(String name) {
1563 return getUriFor(CONTENT_URI, name);
1564 }
1565
1566 /**
1567 * Convenience function for retrieving a single secure settings value
1568 * as an integer. Note that internally setting values are always
1569 * stored as strings; this function converts the string to an integer
1570 * for you. The default value will be returned if the setting is
1571 * not defined or not an integer.
1572 *
1573 * @param cr The ContentResolver to access.
1574 * @param name The name of the setting to retrieve.
1575 * @param def Value to return if the setting is not defined.
1576 *
1577 * @return The setting's current value, or 'def' if it is not defined
1578 * or not a valid integer.
1579 */
1580 public static int getInt(ContentResolver cr, String name, int def) {
1581 String v = getString(cr, name);
1582 try {
1583 return v != null ? Integer.parseInt(v) : def;
1584 } catch (NumberFormatException e) {
1585 return def;
1586 }
1587 }
1588
1589 /**
1590 * Convenience function for retrieving a single secure settings value
1591 * as an integer. Note that internally setting values are always
1592 * stored as strings; this function converts the string to an integer
1593 * for you.
1594 * <p>
1595 * This version does not take a default value. If the setting has not
1596 * been set, or the string value is not a number,
1597 * it throws {@link SettingNotFoundException}.
1598 *
1599 * @param cr The ContentResolver to access.
1600 * @param name The name of the setting to retrieve.
1601 *
1602 * @throws SettingNotFoundException Thrown if a setting by the given
1603 * name can't be found or the setting value is not an integer.
1604 *
1605 * @return The setting's current value.
1606 */
1607 public static int getInt(ContentResolver cr, String name)
1608 throws SettingNotFoundException {
1609 String v = getString(cr, name);
1610 try {
1611 return Integer.parseInt(v);
1612 } catch (NumberFormatException e) {
1613 throw new SettingNotFoundException(name);
1614 }
1615 }
1616
1617 /**
1618 * Convenience function for updating a single settings value as an
1619 * integer. This will either create a new entry in the table if the
1620 * given name does not exist, or modify the value of the existing row
1621 * with that name. Note that internally setting values are always
1622 * stored as strings, so this function converts the given value to a
1623 * string before storing it.
1624 *
1625 * @param cr The ContentResolver to access.
1626 * @param name The name of the setting to modify.
1627 * @param value The new value for the setting.
1628 * @return true if the value was set, false on database errors
1629 */
1630 public static boolean putInt(ContentResolver cr, String name, int value) {
1631 return putString(cr, name, Integer.toString(value));
1632 }
1633
1634 /**
1635 * Convenience function for retrieving a single secure settings value
1636 * as a {@code long}. Note that internally setting values are always
1637 * stored as strings; this function converts the string to a {@code long}
1638 * for you. The default value will be returned if the setting is
1639 * not defined or not a {@code long}.
1640 *
1641 * @param cr The ContentResolver to access.
1642 * @param name The name of the setting to retrieve.
1643 * @param def Value to return if the setting is not defined.
1644 *
1645 * @return The setting's current value, or 'def' if it is not defined
1646 * or not a valid {@code long}.
1647 */
1648 public static long getLong(ContentResolver cr, String name, long def) {
1649 String valString = getString(cr, name);
1650 long value;
1651 try {
1652 value = valString != null ? Long.parseLong(valString) : def;
1653 } catch (NumberFormatException e) {
1654 value = def;
1655 }
1656 return value;
1657 }
1658
1659 /**
1660 * Convenience function for retrieving a single secure settings value
1661 * as a {@code long}. Note that internally setting values are always
1662 * stored as strings; this function converts the string to a {@code long}
1663 * for you.
1664 * <p>
1665 * This version does not take a default value. If the setting has not
1666 * been set, or the string value is not a number,
1667 * it throws {@link SettingNotFoundException}.
1668 *
1669 * @param cr The ContentResolver to access.
1670 * @param name The name of the setting to retrieve.
1671 *
1672 * @return The setting's current value.
1673 * @throws SettingNotFoundException Thrown if a setting by the given
1674 * name can't be found or the setting value is not an integer.
1675 */
1676 public static long getLong(ContentResolver cr, String name)
1677 throws SettingNotFoundException {
1678 String valString = getString(cr, name);
1679 try {
1680 return Long.parseLong(valString);
1681 } catch (NumberFormatException e) {
1682 throw new SettingNotFoundException(name);
1683 }
1684 }
1685
1686 /**
1687 * Convenience function for updating a secure settings value as a long
1688 * integer. This will either create a new entry in the table if the
1689 * given name does not exist, or modify the value of the existing row
1690 * with that name. Note that internally setting values are always
1691 * stored as strings, so this function converts the given value to a
1692 * string before storing it.
1693 *
1694 * @param cr The ContentResolver to access.
1695 * @param name The name of the setting to modify.
1696 * @param value The new value for the setting.
1697 * @return true if the value was set, false on database errors
1698 */
1699 public static boolean putLong(ContentResolver cr, String name, long value) {
1700 return putString(cr, name, Long.toString(value));
1701 }
1702
1703 /**
1704 * Convenience function for retrieving a single secure settings value
1705 * as a floating point number. Note that internally setting values are
1706 * always stored as strings; this function converts the string to an
1707 * float for you. The default value will be returned if the setting
1708 * is not defined or not a valid float.
1709 *
1710 * @param cr The ContentResolver to access.
1711 * @param name The name of the setting to retrieve.
1712 * @param def Value to return if the setting is not defined.
1713 *
1714 * @return The setting's current value, or 'def' if it is not defined
1715 * or not a valid float.
1716 */
1717 public static float getFloat(ContentResolver cr, String name, float def) {
1718 String v = getString(cr, name);
1719 try {
1720 return v != null ? Float.parseFloat(v) : def;
1721 } catch (NumberFormatException e) {
1722 return def;
1723 }
1724 }
1725
1726 /**
1727 * Convenience function for retrieving a single secure settings value
1728 * as a float. Note that internally setting values are always
1729 * stored as strings; this function converts the string to a float
1730 * for you.
1731 * <p>
1732 * This version does not take a default value. If the setting has not
1733 * been set, or the string value is not a number,
1734 * it throws {@link SettingNotFoundException}.
1735 *
1736 * @param cr The ContentResolver to access.
1737 * @param name The name of the setting to retrieve.
1738 *
1739 * @throws SettingNotFoundException Thrown if a setting by the given
1740 * name can't be found or the setting value is not a float.
1741 *
1742 * @return The setting's current value.
1743 */
1744 public static float getFloat(ContentResolver cr, String name)
1745 throws SettingNotFoundException {
1746 String v = getString(cr, name);
1747 try {
1748 return Float.parseFloat(v);
1749 } catch (NumberFormatException e) {
1750 throw new SettingNotFoundException(name);
1751 }
1752 }
1753
1754 /**
1755 * Convenience function for updating a single settings value as a
1756 * floating point number. This will either create a new entry in the
1757 * table if the given name does not exist, or modify the value of the
1758 * existing row with that name. Note that internally setting values
1759 * are always stored as strings, so this function converts the given
1760 * value to a string before storing it.
1761 *
1762 * @param cr The ContentResolver to access.
1763 * @param name The name of the setting to modify.
1764 * @param value The new value for the setting.
1765 * @return true if the value was set, false on database errors
1766 */
1767 public static boolean putFloat(ContentResolver cr, String name, float value) {
1768 return putString(cr, name, Float.toString(value));
1769 }
1770
1771 /**
1772 * The content:// style URL for this table
1773 */
1774 public static final Uri CONTENT_URI =
1775 Uri.parse("content://" + AUTHORITY + "/secure");
1776
1777 /**
1778 * Whether ADB is enabled.
1779 */
1780 public static final String ADB_ENABLED = "adb_enabled";
1781
1782 /**
1783 * Setting to allow mock locations and location provider status to be injected into the
1784 * LocationManager service for testing purposes during application development. These
1785 * locations and status values override actual location and status information generated
1786 * by network, gps, or other location providers.
1787 */
1788 public static final String ALLOW_MOCK_LOCATION = "mock_location";
1789
1790 /**
1791 * The Android ID (a unique 64-bit value) as a hex string.
1792 * Identical to that obtained by calling
1793 * GoogleLoginService.getAndroidId(); it is also placed here
1794 * so you can get it without binding to a service.
1795 */
1796 public static final String ANDROID_ID = "android_id";
1797
1798 /**
1799 * Whether bluetooth is enabled/disabled
1800 * 0=disabled. 1=enabled.
1801 */
1802 public static final String BLUETOOTH_ON = "bluetooth_on";
1803
1804 /**
1805 * Get the key that retrieves a bluetooth headset's priority.
1806 * @hide
1807 */
1808 public static final String getBluetoothHeadsetPriorityKey(String address) {
1809 return ("bluetooth_headset_priority_" + address.toUpperCase());
1810 }
1811
1812 /**
1813 * Get the key that retrieves a bluetooth a2dp sink's priority.
1814 * @hide
1815 */
1816 public static final String getBluetoothA2dpSinkPriorityKey(String address) {
1817 return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
1818 }
1819
1820 /**
1821 * Whether or not data roaming is enabled. (0 = false, 1 = true)
1822 */
1823 public static final String DATA_ROAMING = "data_roaming";
1824
1825 /**
1826 * Setting to record the input method used by default, holding the ID
1827 * of the desired method.
1828 */
1829 public static final String DEFAULT_INPUT_METHOD = "default_input_method";
1830
1831 /**
1832 * Whether the device has been provisioned (0 = false, 1 = true)
1833 */
1834 public static final String DEVICE_PROVISIONED = "device_provisioned";
1835
1836 /**
1837 * List of input methods that are currently enabled. This is a string
1838 * containing the IDs of all enabled input methods, each ID separated
1839 * by ':'.
1840 */
1841 public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
1842
1843 /**
1844 * Host name and port for a user-selected proxy.
1845 */
1846 public static final String HTTP_PROXY = "http_proxy";
1847
1848 /**
1849 * Whether the package installer should allow installation of apps downloaded from
1850 * sources other than the Android Market (vending machine).
1851 *
1852 * 1 = allow installing from other sources
1853 * 0 = only allow installing from the Android Market
1854 */
1855 public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
1856
1857 /**
1858 * Comma-separated list of location providers that activities may access.
1859 */
1860 public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
1861
1862 /**
1863 * The Logging ID (a unique 64-bit value) as a hex string.
1864 * Used as a pseudonymous identifier for logging.
1865 * @deprecated This identifier is poorly initialized and has
1866 * many collisions. It should not be used.
1867 */
1868 @Deprecated
1869 public static final String LOGGING_ID = "logging_id";
1870
1871 /**
1872 * The Logging ID (a unique 64-bit value) as a hex string.
1873 * Used as a pseudonymous identifier for logging.
1874 * @hide
1875 */
1876 public static final String LOGGING_ID2 = "logging_id2";
1877
1878 /**
1879 * User preference for which network(s) should be used. Only the
1880 * connectivity service should touch this.
1881 */
1882 public static final String NETWORK_PREFERENCE = "network_preference";
1883
1884 /**
1885 */
1886 public static final String PARENTAL_CONTROL_ENABLED = "parental_control_enabled";
1887
1888 /**
1889 */
1890 public static final String PARENTAL_CONTROL_LAST_UPDATE = "parental_control_last_update";
1891
1892 /**
1893 */
1894 public static final String PARENTAL_CONTROL_REDIRECT_URL = "parental_control_redirect_url";
1895
1896 /**
1897 * Settings classname to launch when Settings is clicked from All
1898 * Applications. Needed because of user testing between the old
1899 * and new Settings apps.
1900 */
1901 // TODO: 881807
1902 public static final String SETTINGS_CLASSNAME = "settings_classname";
1903
1904 /**
1905 * USB Mass Storage Enabled
1906 */
1907 public static final String USB_MASS_STORAGE_ENABLED = "usb_mass_storage_enabled";
1908
1909 /**
1910 * If this setting is set (to anything), then all references
1911 * to Gmail on the device must change to Google Mail.
1912 */
1913 public static final String USE_GOOGLE_MAIL = "use_google_mail";
1914
1915 /**
1916 * Whether to notify the user of open networks.
1917 * <p>
1918 * If not connected and the scan results have an open network, we will
1919 * put this notification up. If we attempt to connect to a network or
1920 * the open network(s) disappear, we remove the notification. When we
1921 * show the notification, we will not show it again for
1922 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} time.
1923 */
1924 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1925 "wifi_networks_available_notification_on";
1926
1927 /**
1928 * Delay (in seconds) before repeating the Wi-Fi networks available notification.
1929 * Connecting to a network will reset the timer.
1930 */
1931 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1932 "wifi_networks_available_repeat_delay";
1933
1934 /**
1935 * The number of radio channels that are allowed in the local
1936 * 802.11 regulatory domain.
1937 * @hide
1938 */
1939 public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
1940
1941 /**
1942 * When the number of open networks exceeds this number, the
1943 * least-recently-used excess networks will be removed.
1944 */
1945 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = "wifi_num_open_networks_kept";
1946
1947 /**
1948 * Whether the Wi-Fi should be on. Only the Wi-Fi service should touch this.
1949 */
1950 public static final String WIFI_ON = "wifi_on";
1951
1952 /**
1953 * The acceptable packet loss percentage (range 0 - 100) before trying
1954 * another AP on the same network.
1955 */
1956 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1957 "wifi_watchdog_acceptable_packet_loss_percentage";
1958
1959 /**
1960 * The number of access points required for a network in order for the
1961 * watchdog to monitor it.
1962 */
1963 public static final String WIFI_WATCHDOG_AP_COUNT = "wifi_watchdog_ap_count";
1964
1965 /**
1966 * The delay between background checks.
1967 */
1968 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1969 "wifi_watchdog_background_check_delay_ms";
1970
1971 /**
1972 * Whether the Wi-Fi watchdog is enabled for background checking even
1973 * after it thinks the user has connected to a good access point.
1974 */
1975 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1976 "wifi_watchdog_background_check_enabled";
1977
1978 /**
1979 * The timeout for a background ping
1980 */
1981 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1982 "wifi_watchdog_background_check_timeout_ms";
1983
1984 /**
1985 * The number of initial pings to perform that *may* be ignored if they
1986 * fail. Again, if these fail, they will *not* be used in packet loss
1987 * calculation. For example, one network always seemed to time out for
1988 * the first couple pings, so this is set to 3 by default.
1989 */
1990 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
1991 "wifi_watchdog_initial_ignored_ping_count";
1992
1993 /**
1994 * The maximum number of access points (per network) to attempt to test.
1995 * If this number is reached, the watchdog will no longer monitor the
1996 * initial connection state for the network. This is a safeguard for
1997 * networks containing multiple APs whose DNS does not respond to pings.
1998 */
1999 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = "wifi_watchdog_max_ap_checks";
2000
2001 /**
2002 * Whether the Wi-Fi watchdog is enabled.
2003 */
2004 public static final String WIFI_WATCHDOG_ON = "wifi_watchdog_on";
2005
2006 /**
2007 * A comma-separated list of SSIDs for which the Wi-Fi watchdog should be enabled.
2008 * @hide pending API council
2009 */
2010 public static final String WIFI_WATCHDOG_WATCH_LIST = "wifi_watchdog_watch_list";
2011
2012 /**
2013 * The number of pings to test if an access point is a good connection.
2014 */
2015 public static final String WIFI_WATCHDOG_PING_COUNT = "wifi_watchdog_ping_count";
2016
2017 /**
2018 * The delay between pings.
2019 */
2020 public static final String WIFI_WATCHDOG_PING_DELAY_MS = "wifi_watchdog_ping_delay_ms";
2021
2022 /**
2023 * The timeout per ping.
2024 */
2025 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS = "wifi_watchdog_ping_timeout_ms";
2026
2027 /**
2028 * The maximum number of times we will retry a connection to an access
2029 * point for which we have failed in acquiring an IP address from DHCP.
2030 * A value of N means that we will make N+1 connection attempts in all.
2031 *
2032 * @hide pending API Council approval
2033 */
2034 public static final String WIFI_MAX_DHCP_RETRY_COUNT = "wifi_max_dhcp_retry_count";
2035
2036 /**
2037 * Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile
2038 * data connectivity to be established after a disconnect from Wi-Fi.
2039 *
2040 * @hide pending API Council approval
2041 */
2042 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
2043 "wifi_mobile_data_transition_wakelock_timeout_ms";
2044
2045 /**
2046 * Whether background data usage is allowed by the user. See
2047 * ConnectivityManager for more info.
2048 *
2049 * @hide pending API council
2050 */
2051 public static final String BACKGROUND_DATA = "background_data";
Wink Saville04e71b32009-04-02 11:00:54 -07002052
2053 /**
2054 * The CDMA roaming mode 0 = Home Networks, CDMA default
2055 * 1 = Roaming on Affiliated networks
2056 * 2 = Roaming on any networks
2057 * @hide
2058 */
2059 public static final String CDMA_ROAMING_MODE = "roaming_settings";
2060
2061 /**
2062 * The CDMA subscription mode 0 = RUIM/SIM (default)
2063 * 1 = NV
2064 * @hide
2065 */
2066 public static final String CDMA_SUBSCRIPTION_MODE = "subscription_mode";
2067
2068 /**
2069 * represents current active phone class
2070 * 1 = GSM-Phone, 0 = CDMA-Phone
2071 * @hide
2072 */
2073 public static final String CURRENT_ACTIVE_PHONE = "current_active_phone";
2074
2075 /**
2076 * The preferred network mode 7 = Global, CDMA default
2077 * 4 = CDMA only
2078 * 3 = GSM/UMTS only
2079 * @hide
2080 */
2081 public static final String PREFERRED_NETWORK_MODE =
2082 "preferred_network_mode";
2083
2084 /**
2085 * CDMA Cell Broadcast SMS
2086 * 0 = CDMA Cell Broadcast SMS disabled
2087 * 1 = CDMA Cell Broadcast SMS enabled
2088 * @hide
2089 */
2090 public static final String CDMA_CELL_BROADCAST_SMS =
2091 "cdma_cell_broadcast_sms";
2092
2093 /**
2094 * The cdma subscription 0 = Subscription from RUIM, when available
2095 * 1 = Subscription from NV
2096 * @hide
2097 */
2098 public static final String PREFERRED_CDMA_SUBSCRIPTION =
2099 "preferred_cdma_subscription";
2100
2101 /**
2102 * Whether the enhanced voice privacy mode is enabled.
2103 * 0 = normal voice privacy
2104 * 1 = enhanced voice privacy
2105 * @hide
2106 */
2107 public static final String ENHANCED_VOICE_PRIVACY_ENABLED = "enhanced_voice_privacy_enabled";
2108
2109 /**
2110 * Whether the TTY mode mode is enabled.
2111 * 0 = disabled
2112 * 1 = enabled
2113 * @hide
2114 */
2115 public static final String TTY_MODE_ENABLED = "tty_mode_enabled";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002116 }
2117
2118 /**
2119 * Gservices settings, containing the network names for Google's
2120 * various services. This table holds simple name/addr pairs.
2121 * Addresses can be accessed through the getString() method.
2122 *
2123 * TODO: This should move to partner/google/... somewhere.
2124 *
2125 * @hide
2126 */
2127 public static final class Gservices extends NameValueTable {
2128 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_gservices_version";
2129
2130 /**
2131 * Intent action broadcast when the Gservices table is updated by the server.
2132 * This is broadcast once after settings change (so many values may have been updated).
2133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String CHANGED_ACTION =
2136 "com.google.gservices.intent.action.GSERVICES_CHANGED";
2137
2138 private static volatile NameValueCache mNameValueCache = null;
2139 private static final Object mNameValueCacheLock = new Object();
2140
2141 /**
2142 * Look up a name in the database.
2143 * @param resolver to access the database with
2144 * @param name to look up in the table
2145 * @return the corresponding value, or null if not present
2146 */
2147 public static String getString(ContentResolver resolver, String name) {
2148 synchronized (mNameValueCacheLock) {
2149 if (mNameValueCache == null) {
2150 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
2151 }
2152 return mNameValueCache.getString(resolver, name);
2153 }
2154 }
2155
2156 /**
2157 * Store a name/value pair into the database.
2158 * @param resolver to access the database with
2159 * @param name to store
2160 * @param value to associate with the name
2161 * @return true if the value was set, false on database errors
2162 */
2163 public static boolean putString(ContentResolver resolver,
2164 String name, String value) {
2165 return putString(resolver, CONTENT_URI, name, value);
2166 }
2167
2168 /**
2169 * Look up the value for name in the database, convert it to an int using Integer.parseInt
2170 * and return it. If it is null or if a NumberFormatException is caught during the
2171 * conversion then return defValue.
2172 */
2173 public static int getInt(ContentResolver resolver, String name, int defValue) {
2174 String valString = getString(resolver, name);
2175 int value;
2176 try {
2177 value = valString != null ? Integer.parseInt(valString) : defValue;
2178 } catch (NumberFormatException e) {
2179 value = defValue;
2180 }
2181 return value;
2182 }
2183
2184 /**
2185 * Look up the value for name in the database, convert it to a long using Long.parseLong
2186 * and return it. If it is null or if a NumberFormatException is caught during the
2187 * conversion then return defValue.
2188 */
2189 public static long getLong(ContentResolver resolver, String name, long defValue) {
2190 String valString = getString(resolver, name);
2191 long value;
2192 try {
2193 value = valString != null ? Long.parseLong(valString) : defValue;
2194 } catch (NumberFormatException e) {
2195 value = defValue;
2196 }
2197 return value;
2198 }
2199
2200 /**
2201 * Construct the content URI for a particular name/value pair,
2202 * useful for monitoring changes with a ContentObserver.
2203 * @param name to look up in the table
2204 * @return the corresponding content URI, or null if not present
2205 */
2206 public static Uri getUriFor(String name) {
2207 return getUriFor(CONTENT_URI, name);
2208 }
2209
2210 /**
2211 * The content:// style URL for this table
2212 */
2213 public static final Uri CONTENT_URI =
2214 Uri.parse("content://" + AUTHORITY + "/gservices");
2215
2216 /**
2217 * MMS - URL to use for HTTP "x-wap-profile" header
2218 */
2219 public static final String MMS_X_WAP_PROFILE_URL
2220 = "mms_x_wap_profile_url";
2221
2222 /**
2223 * YouTube - the flag to indicate whether to use proxy
2224 */
2225 public static final String YOUTUBE_USE_PROXY
2226 = "youtube_use_proxy";
2227
2228 /**
2229 * MMS - maximum message size in bytes for a MMS message.
2230 */
2231 public static final String MMS_MAXIMUM_MESSAGE_SIZE
2232 = "mms_maximum_message_size";
2233
2234 /**
2235 * Event tags from the kernel event log to upload during checkin.
2236 */
2237 public static final String CHECKIN_EVENTS = "checkin_events";
2238
2239 /**
2240 * Event tags for list of services to upload during checkin.
2241 */
2242 public static final String CHECKIN_DUMPSYS_LIST = "checkin_dumpsys_list";
2243
2244 /**
2245 * The interval (in seconds) between periodic checkin attempts.
2246 */
2247 public static final String CHECKIN_INTERVAL = "checkin_interval";
2248
2249 /**
2250 * Boolean indicating if the market app should force market only checkins on
2251 * install/uninstall. Any non-0 value is considered true.
2252 */
2253 public static final String MARKET_FORCE_CHECKIN = "market_force_checkin";
2254
2255 /**
2256 * How frequently (in seconds) to check the memory status of the
2257 * device.
2258 */
2259 public static final String MEMCHECK_INTERVAL = "memcheck_interval";
2260
2261 /**
2262 * Max frequency (in seconds) to log memory check stats, in realtime
2263 * seconds. This allows for throttling of logs when the device is
2264 * running for large amounts of time.
2265 */
2266 public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
2267 "memcheck_log_realtime_interval";
2268
2269 /**
2270 * Boolean indicating whether rebooting due to system memory checks
2271 * is enabled.
2272 */
2273 public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
2274
2275 /**
2276 * How many bytes the system process must be below to avoid scheduling
2277 * a soft reboot. This reboot will happen when it is next determined
2278 * to be a good time.
2279 */
2280 public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
2281
2282 /**
2283 * How many bytes the system process must be below to avoid scheduling
2284 * a hard reboot. This reboot will happen immediately.
2285 */
2286 public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
2287
2288 /**
2289 * How many bytes the phone process must be below to avoid scheduling
2290 * a soft restart. This restart will happen when it is next determined
2291 * to be a good time.
2292 */
2293 public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
2294
2295 /**
2296 * How many bytes the phone process must be below to avoid scheduling
2297 * a hard restart. This restart will happen immediately.
2298 */
2299 public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
2300
2301 /**
2302 * Boolean indicating whether restarting the phone process due to
2303 * memory checks is enabled.
2304 */
2305 public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
2306
2307 /**
2308 * First time during the day it is okay to kill processes
2309 * or reboot the device due to low memory situations. This number is
2310 * in seconds since midnight.
2311 */
2312 public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
2313
2314 /**
2315 * Last time during the day it is okay to kill processes
2316 * or reboot the device due to low memory situations. This number is
2317 * in seconds since midnight.
2318 */
2319 public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
2320
2321 /**
2322 * How long the screen must have been off in order to kill processes
2323 * or reboot. This number is in seconds. A value of -1 means to
2324 * entirely disregard whether the screen is on.
2325 */
2326 public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
2327
2328 /**
2329 * How much time there must be until the next alarm in order to kill processes
2330 * or reboot. This number is in seconds. Note: this value must be
2331 * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
2332 * always see an alarm scheduled within its time.
2333 */
2334 public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
2335
2336 /**
2337 * How frequently to check whether it is a good time to restart things,
2338 * if the device is in a bad state. This number is in seconds. Note:
2339 * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
2340 * the alarm to schedule the recheck will always appear within the
2341 * minimum "do not execute now" time.
2342 */
2343 public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
2344
2345 /**
2346 * How frequently (in DAYS) to reboot the device. If 0, no reboots
2347 * will occur.
2348 */
2349 public static final String REBOOT_INTERVAL = "reboot_interval";
2350
2351 /**
2352 * First time during the day it is okay to force a reboot of the
2353 * device (if REBOOT_INTERVAL is set). This number is
2354 * in seconds since midnight.
2355 */
2356 public static final String REBOOT_START_TIME = "reboot_start_time";
2357
2358 /**
2359 * The window of time (in seconds) after each REBOOT_INTERVAL in which
2360 * a reboot can be executed. If 0, a reboot will always be executed at
2361 * exactly the given time. Otherwise, it will only be executed if
2362 * the device is idle within the window.
2363 */
2364 public static final String REBOOT_WINDOW = "reboot_window";
2365
2366 /**
2367 * The minimum version of the server that is required in order for the device to accept
2368 * the server's recommendations about the initial sync settings to use. When this is unset,
2369 * blank or can't be interpreted as an integer then we will not ask the server for a
2370 * recommendation.
2371 */
2372 public static final String GMAIL_CONFIG_INFO_MIN_SERVER_VERSION =
2373 "gmail_config_info_min_server_version";
2374
2375 /**
2376 * Controls whether Gmail offers a preview button for images.
2377 */
2378 public static final String GMAIL_DISALLOW_IMAGE_PREVIEWS = "gmail_disallow_image_previews";
2379
2380 /**
Cedric Beustafb6c8e2009-03-24 22:35:42 -07002381 * The maximal size in bytes allowed for attachments when composing messages in Gmail
2382 */
2383 public static final String GMAIL_MAX_ATTACHMENT_SIZE = "gmail_max_attachment_size_bytes";
2384
2385 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002386 * The timeout in milliseconds that Gmail uses when opening a connection and reading
2387 * from it. A missing value or a value of -1 instructs Gmail to use the defaults provided
2388 * by GoogleHttpClient.
2389 */
2390 public static final String GMAIL_TIMEOUT_MS = "gmail_timeout_ms";
2391
2392 /**
2393 * Controls whether Gmail will request an expedited sync when a message is sent. Value must
2394 * be an integer where non-zero means true. Defaults to 1.
2395 */
2396 public static final String GMAIL_SEND_IMMEDIATELY = "gmail_send_immediately";
2397
2398 /**
2399 * Controls whether gmail buffers server responses. Possible values are "memory", for a
2400 * memory-based buffer, or "file", for a temp-file-based buffer. All other values
2401 * (including not set) disable buffering.
2402 */
2403 public static final String GMAIL_BUFFER_SERVER_RESPONSE = "gmail_buffer_server_response";
2404
2405 /**
2406 * Hostname of the GTalk server.
2407 */
2408 public static final String GTALK_SERVICE_HOSTNAME = "gtalk_hostname";
2409
2410 /**
2411 * Secure port of the GTalk server.
2412 */
2413 public static final String GTALK_SERVICE_SECURE_PORT = "gtalk_secure_port";
2414
2415 /**
2416 * The server configurable RMQ acking interval
2417 */
2418 public static final String GTALK_SERVICE_RMQ_ACK_INTERVAL = "gtalk_rmq_ack_interval";
2419
2420 /**
2421 * The minimum reconnect delay for short network outages or when the network is suspended
2422 * due to phone use.
2423 */
2424 public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT =
2425 "gtalk_min_reconnect_delay_short";
2426
2427 /**
2428 * The reconnect variant range for short network outages or when the network is suspended
2429 * due to phone use. A random number between 0 and this constant is computed and
2430 * added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT} to form the initial reconnect
2431 * delay.
2432 */
2433 public static final String GTALK_SERVICE_RECONNECT_VARIANT_SHORT =
2434 "gtalk_reconnect_variant_short";
2435
2436 /**
2437 * The minimum reconnect delay for long network outages
2438 */
2439 public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG =
2440 "gtalk_min_reconnect_delay_long";
2441
2442 /**
2443 * The reconnect variant range for long network outages. A random number between 0 and this
2444 * constant is computed and added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG} to
2445 * form the initial reconnect delay.
2446 */
2447 public static final String GTALK_SERVICE_RECONNECT_VARIANT_LONG =
2448 "gtalk_reconnect_variant_long";
2449
2450 /**
2451 * The maximum reconnect delay time, in milliseconds.
2452 */
2453 public static final String GTALK_SERVICE_MAX_RECONNECT_DELAY =
2454 "gtalk_max_reconnect_delay";
2455
2456 /**
2457 * The network downtime that is considered "short" for the above calculations,
2458 * in milliseconds.
2459 */
2460 public static final String GTALK_SERVICE_SHORT_NETWORK_DOWNTIME =
2461 "gtalk_short_network_downtime";
2462
2463 /**
2464 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2465 * will reset the heartbeat timer. The away heartbeat should be used when the user is
2466 * logged into the GTalk app, but not actively using it.
2467 */
2468 public static final String GTALK_SERVICE_AWAY_HEARTBEAT_INTERVAL_MS =
2469 "gtalk_heartbeat_ping_interval_ms"; // keep the string backward compatible
2470
2471 /**
2472 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2473 * will reset the heartbeat timer. The active heartbeat should be used when the user is
2474 * actively using the GTalk app.
2475 */
2476 public static final String GTALK_SERVICE_ACTIVE_HEARTBEAT_INTERVAL_MS =
2477 "gtalk_active_heartbeat_ping_interval_ms";
2478
2479 /**
2480 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2481 * will reset the heartbeat timer. The sync heartbeat should be used when the user isn't
2482 * logged into the GTalk app, but auto-sync is enabled.
2483 */
2484 public static final String GTALK_SERVICE_SYNC_HEARTBEAT_INTERVAL_MS =
2485 "gtalk_sync_heartbeat_ping_interval_ms";
2486
2487 /**
2488 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2489 * will reset the heartbeat timer. The no sync heartbeat should be used when the user isn't
2490 * logged into the GTalk app, and auto-sync is not enabled.
2491 */
2492 public static final String GTALK_SERVICE_NOSYNC_HEARTBEAT_INTERVAL_MS =
2493 "gtalk_nosync_heartbeat_ping_interval_ms";
2494
2495 /**
2496 * How long we wait to receive a heartbeat ping acknowledgement (or another packet)
2497 * from the GTalk server, before deeming the connection dead.
2498 */
2499 public static final String GTALK_SERVICE_HEARTBEAT_ACK_TIMEOUT_MS =
2500 "gtalk_heartbeat_ack_timeout_ms";
2501
2502 /**
2503 * How long after screen is turned off before we consider the user to be idle.
2504 */
2505 public static final String GTALK_SERVICE_IDLE_TIMEOUT_MS =
2506 "gtalk_idle_timeout_ms";
2507
2508 /**
2509 * By default, GTalkService will always connect to the server regardless of the auto-sync
2510 * setting. However, if this parameter is true, then GTalkService will only connect
2511 * if auto-sync is enabled. Using the GTalk app will trigger the connection too.
2512 */
2513 public static final String GTALK_SERVICE_CONNECT_ON_AUTO_SYNC =
2514 "gtalk_connect_on_auto_sync";
2515
2516 /**
2517 * GTalkService holds a wakelock while broadcasting the intent for data message received.
2518 * It then automatically release the wakelock after a timeout. This setting controls what
2519 * the timeout should be.
2520 */
2521 public static final String GTALK_DATA_MESSAGE_WAKELOCK_MS =
2522 "gtalk_data_message_wakelock_ms";
2523
2524 /**
2525 * The socket read timeout used to control how long ssl handshake wait for reads before
2526 * timing out. This is needed so the ssl handshake doesn't hang for a long time in some
2527 * circumstances.
2528 */
2529 public static final String GTALK_SSL_HANDSHAKE_TIMEOUT_MS =
2530 "gtalk_ssl_handshake_timeout_ms";
2531
2532 /**
2533 * Enable use of ssl session caching.
2534 * 'db' - save each session in a (per process) database
2535 * 'file' - save each session in a (per process) file
2536 * not set or any other value - normal java in-memory caching
2537 */
2538 public static final String SSL_SESSION_CACHE = "ssl_session_cache";
2539
2540 /**
2541 * How many bytes long a message has to be, in order to be gzipped.
2542 */
2543 public static final String SYNC_MIN_GZIP_BYTES =
2544 "sync_min_gzip_bytes";
2545
2546 /**
2547 * The hash value of the current provisioning settings
2548 */
2549 public static final String PROVISIONING_DIGEST = "digest";
2550
2551 /**
2552 * Provisioning keys to block from server update
2553 */
2554 public static final String PROVISIONING_OVERRIDE = "override";
2555
2556 /**
2557 * "Generic" service name for authentication requests.
2558 */
2559 public static final String GOOGLE_LOGIN_GENERIC_AUTH_SERVICE
2560 = "google_login_generic_auth_service";
2561
2562 /**
2563 * Frequency in milliseconds at which we should sync the locally installed Vending Machine
2564 * content with the server.
2565 */
2566 public static final String VENDING_SYNC_FREQUENCY_MS = "vending_sync_frequency_ms";
2567
2568 /**
2569 * Support URL that is opened in a browser when user clicks on 'Help and Info' in Vending
2570 * Machine.
2571 */
2572 public static final String VENDING_SUPPORT_URL = "vending_support_url";
2573
2574 /**
2575 * Indicates if Vending Machine requires a SIM to be in the phone to allow a purchase.
2576 *
2577 * true = SIM is required
2578 * false = SIM is not required
2579 */
2580 public static final String VENDING_REQUIRE_SIM_FOR_PURCHASE =
2581 "vending_require_sim_for_purchase";
2582
2583 /**
2584 * The current version id of the Vending Machine terms of service.
2585 */
2586 public static final String VENDING_TOS_VERSION = "vending_tos_version";
2587
2588 /**
2589 * URL that points to the terms of service for Vending Machine.
2590 */
2591 public static final String VENDING_TOS_URL = "vending_tos_url";
2592
2593 /**
2594 * Whether to use sierraqa instead of sierra tokens for the purchase flow in
2595 * Vending Machine.
2596 *
2597 * true = use sierraqa
2598 * false = use sierra (default)
2599 */
2600 public static final String VENDING_USE_CHECKOUT_QA_SERVICE =
2601 "vending_use_checkout_qa_service";
2602
2603 /**
Mark Womack78ef4562009-03-25 16:10:13 -07002604 * Default value to use for all/free/priced filter in Market.
2605 * Valid values: ALL, FREE, PAID (case insensitive)
2606 */
2607 public static final String VENDING_DEFAULT_FILTER = "vending_default_filter";
2608 /**
2609 * Ranking type value to use for the first category tab (currently popular)
2610 */
2611 public static final String VENDING_TAB_1_RANKING_TYPE = "vending_tab_1_ranking_type";
2612
2613 /**
2614 * Title string to use for first category tab.
2615 */
2616 public static final String VENDING_TAB_1_TITLE = "vending_tab_1_title";
2617
2618 /**
2619 * Ranking type value to use for the second category tab (currently newest)
2620 */
2621 public static final String VENDING_TAB_2_RANKING_TYPE = "vending_tab_2_ranking_type";
2622
2623 /**
2624 * Title string to use for second category tab.
2625 */
2626 public static final String VENDING_TAB_2_TITLE = "vending_tab_2_title";
2627
2628 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002629 * URL that points to the legal terms of service to display in Settings.
2630 * <p>
2631 * This should be a https URL. For a pretty user-friendly URL, use
2632 * {@link #SETTINGS_TOS_PRETTY_URL}.
2633 */
2634 public static final String SETTINGS_TOS_URL = "settings_tos_url";
2635
2636 /**
2637 * URL that points to the legal terms of service to display in Settings.
2638 * <p>
2639 * This should be a pretty http URL. For the URL the device will access
2640 * via Settings, use {@link #SETTINGS_TOS_URL}.
2641 */
2642 public static final String SETTINGS_TOS_PRETTY_URL = "settings_tos_pretty_url";
2643
2644 /**
2645 * URL that points to the contributors to display in Settings.
2646 * <p>
2647 * This should be a https URL. For a pretty user-friendly URL, use
2648 * {@link #SETTINGS_CONTRIBUTORS_PRETTY_URL}.
2649 */
2650 public static final String SETTINGS_CONTRIBUTORS_URL = "settings_contributors_url";
2651
2652 /**
2653 * URL that points to the contributors to display in Settings.
2654 * <p>
2655 * This should be a pretty http URL. For the URL the device will access
2656 * via Settings, use {@link #SETTINGS_CONTRIBUTORS_URL}.
2657 */
2658 public static final String SETTINGS_CONTRIBUTORS_PRETTY_URL =
2659 "settings_contributors_pretty_url";
2660
2661 /**
2662 * URL that points to the Terms Of Service for the device.
2663 * <p>
2664 * This should be a pretty http URL.
2665 */
2666 public static final String SETUP_GOOGLE_TOS_URL = "setup_google_tos_url";
2667
2668 /**
2669 * URL that points to the Android privacy policy for the device.
2670 * <p>
2671 * This should be a pretty http URL.
2672 */
2673 public static final String SETUP_ANDROID_PRIVACY_URL = "setup_android_privacy_url";
2674
2675 /**
2676 * URL that points to the Google privacy policy for the device.
2677 * <p>
2678 * This should be a pretty http URL.
2679 */
2680 public static final String SETUP_GOOGLE_PRIVACY_URL = "setup_google_privacy_url";
2681
2682 /**
2683 * Request an MSISDN token for various Google services.
2684 */
2685 public static final String USE_MSISDN_TOKEN = "use_msisdn_token";
2686
2687 /**
2688 * RSA public key used to encrypt passwords stored in the database.
2689 */
2690 public static final String GLS_PUBLIC_KEY = "google_login_public_key";
2691
2692 /**
2693 * Only check parental control status if this is set to "true".
2694 */
2695 public static final String PARENTAL_CONTROL_CHECK_ENABLED =
2696 "parental_control_check_enabled";
2697
2698 /**
2699 * The list of applications we need to block if parental control is
2700 * enabled.
2701 */
2702 public static final String PARENTAL_CONTROL_APPS_LIST =
2703 "parental_control_apps_list";
2704
2705 /**
2706 * Duration in which parental control status is valid.
2707 */
2708 public static final String PARENTAL_CONTROL_TIMEOUT_IN_MS =
2709 "parental_control_timeout_in_ms";
2710
2711 /**
2712 * When parental control is off, we expect to get this string from the
2713 * litmus url.
2714 */
2715 public static final String PARENTAL_CONTROL_EXPECTED_RESPONSE =
2716 "parental_control_expected_response";
2717
2718 /**
2719 * When the litmus url returns a 302, declare parental control to be on
2720 * only if the redirect url matches this regular expression.
2721 */
2722 public static final String PARENTAL_CONTROL_REDIRECT_REGEX =
2723 "parental_control_redirect_regex";
2724
2725 /**
2726 * Threshold for the amount of change in disk free space required to report the amount of
2727 * free space. Used to prevent spamming the logs when the disk free space isn't changing
2728 * frequently.
2729 */
2730 public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
2731 "disk_free_change_reporting_threshold";
2732
2733 /**
2734 * Prefix for new Google services published by the checkin
2735 * server.
2736 */
2737 public static final String GOOGLE_SERVICES_PREFIX
2738 = "google_services:";
2739
2740 /**
2741 * The maximum reconnect delay for short network outages or when the network is suspended
2742 * due to phone use.
2743 */
2744 public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
2745 "sync_max_retry_delay_in_seconds";
2746
2747 /**
2748 * Minimum percentage of free storage on the device that is used to determine if
2749 * the device is running low on storage.
2750 * Say this value is set to 10, the device is considered running low on storage
2751 * if 90% or more of the device storage is filled up.
2752 */
2753 public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
2754 "sys_storage_threshold_percentage";
2755
2756 /**
2757 * The interval in minutes after which the amount of free storage left on the
2758 * device is logged to the event log
2759 */
2760 public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
2761 "sys_free_storage_log_interval";
2762
2763 /**
2764 * The interval in milliseconds at which to check the number of SMS sent
2765 * out without asking for use permit, to limit the un-authorized SMS
2766 * usage.
2767 */
2768 public static final String SMS_OUTGOING_CEHCK_INTERVAL_MS =
2769 "sms_outgoing_check_interval_ms";
2770
2771 /**
2772 * The number of outgoing SMS sent without asking for user permit
2773 * (of {@link #SMS_OUTGOING_CEHCK_INTERVAL_MS}
2774 */
2775 public static final String SMS_OUTGOING_CEHCK_MAX_COUNT =
2776 "sms_outgoing_check_max_count";
2777
2778 /**
2779 * The interval in milliseconds at which to check packet counts on the
2780 * mobile data interface when screen is on, to detect possible data
2781 * connection problems.
2782 */
2783 public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
2784 "pdp_watchdog_poll_interval_ms";
2785
2786 /**
2787 * The interval in milliseconds at which to check packet counts on the
2788 * mobile data interface when screen is off, to detect possible data
2789 * connection problems.
2790 */
2791 public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
2792 "pdp_watchdog_long_poll_interval_ms";
2793
2794 /**
2795 * The interval in milliseconds at which to check packet counts on the
2796 * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
2797 * outgoing packets has been reached without incoming packets.
2798 */
2799 public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
2800 "pdp_watchdog_error_poll_interval_ms";
2801
2802 /**
2803 * The number of outgoing packets sent without seeing an incoming packet
2804 * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
2805 * device is logged to the event log
2806 */
2807 public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
2808 "pdp_watchdog_trigger_packet_count";
2809
2810 /**
2811 * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
2812 * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
2813 * attempting data connection recovery.
2814 */
2815 public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
2816 "pdp_watchdog_error_poll_count";
2817
2818 /**
2819 * The number of failed PDP reset attempts before moving to something more
2820 * drastic: re-registering to the network.
2821 */
2822 public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
2823 "pdp_watchdog_max_pdp_reset_fail_count";
2824
2825 /**
2826 * Address to ping as a last sanity check before attempting any recovery.
2827 * Unset or set to "0.0.0.0" to skip this check.
2828 */
2829 public static final String PDP_WATCHDOG_PING_ADDRESS = "pdp_watchdog_ping_address";
2830
2831 /**
2832 * The "-w deadline" parameter for the ping, ie, the max time in
2833 * seconds to spend pinging.
2834 */
2835 public static final String PDP_WATCHDOG_PING_DEADLINE = "pdp_watchdog_ping_deadline";
2836
2837 /**
2838 * The interval in milliseconds at which to check gprs registration
2839 * after the first registration mismatch of gprs and voice service,
2840 * to detect possible data network registration problems.
2841 *
2842 */
2843 public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
2844 "gprs_register_check_period_ms";
2845
2846 /**
2847 * The interval in milliseconds after which Wi-Fi is considered idle.
2848 * When idle, it is possible for the device to be switched from Wi-Fi to
2849 * the mobile data network.
2850 */
2851 public static final String WIFI_IDLE_MS = "wifi_idle_ms";
2852
2853 /**
2854 * Screen timeout in milliseconds corresponding to the
2855 * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
2856 * possible screen timeout behavior.)
2857 */
2858 public static final String SHORT_KEYLIGHT_DELAY_MS =
2859 "short_keylight_delay_ms";
2860
2861 /**
2862 * URL that points to the voice search servers. To be factored out of this class.
2863 */
2864 public static final String VOICE_SEARCH_URL = "voice_search_url";
2865
2866 /**
2867 * Speech encoding used with voice search on 3G networks. To be factored out of this class.
2868 */
2869 public static final String VOICE_SEARCH_ENCODING_THREE_G = "voice_search_encoding_three_g";
2870
2871 /**
2872 * Speech encoding used with voice search on WIFI networks. To be factored out of this class.
2873 */
2874 public static final String VOICE_SEARCH_ENCODING_WIFI = "voice_search_encoding_wifi";
2875
2876 /**
2877 * Whether to use automatic gain control in voice search (0 = disable, 1 = enable).
2878 * To be factored out of this class.
2879 */
2880 public static final String VOICE_SEARCH_ENABLE_AGC = "voice_search_enable_agc";
2881
2882 /**
2883 * Whether to use noise suppression in voice search (0 = disable, 1 = enable).
2884 * To be factored out of this class.
2885 */
2886 public static final String VOICE_SEARCH_ENABLE_NS = "voice_search_enable_ns";
2887
2888 /**
2889 * Whether to use the IIR filter in voice search (0 = disable, 1 = enable).
2890 * To be factored out of this class.
2891 */
2892 public static final String VOICE_SEARCH_ENABLE_IIR = "voice_search_enable_iir";
2893
2894 /**
2895 * List of test suites (local disk filename) for the automatic instrumentation test runner.
2896 * The file format is similar to automated_suites.xml, see AutoTesterService.
2897 * If this setting is missing or empty, the automatic test runner will not start.
2898 */
2899 public static final String AUTOTEST_SUITES_FILE = "autotest_suites_file";
2900
2901 /**
2902 * Interval between synchronous checkins forced by the automatic test runner.
2903 * If you set this to a value smaller than CHECKIN_INTERVAL, then the test runner's
2904 * frequent checkins will prevent asynchronous background checkins from interfering
2905 * with any performance measurements.
2906 */
2907 public static final String AUTOTEST_CHECKIN_SECONDS = "autotest_checkin_seconds";
2908
2909 /**
2910 * Interval between reboots forced by the automatic test runner.
2911 */
2912 public static final String AUTOTEST_REBOOT_SECONDS = "autotest_reboot_seconds";
2913
2914
2915 /**
2916 * Threshold values for the duration and level of a discharge cycle, under
2917 * which we log discharge cycle info.
2918 */
2919 public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
2920 "battery_discharge_duration_threshold";
2921 public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
The Android Open Source Project4df24232009-03-05 14:34:35 -08002922
2923 /**
2924 * An email address that anr bugreports should be sent to.
2925 */
2926 public static final String ANR_BUGREPORT_RECIPIENT = "anr_bugreport_recipient";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002927
2928 /**
2929 * @deprecated
2930 * @hide
2931 */
2932 @Deprecated // Obviated by NameValueCache: just fetch the value directly.
2933 public static class QueryMap extends ContentQueryMap {
2934
2935 public QueryMap(ContentResolver contentResolver, Cursor cursor, boolean keepUpdated,
2936 Handler handlerForUpdateNotifications) {
2937 super(cursor, NAME, keepUpdated, handlerForUpdateNotifications);
2938 }
2939
2940 public QueryMap(ContentResolver contentResolver, boolean keepUpdated,
2941 Handler handlerForUpdateNotifications) {
2942 this(contentResolver,
2943 contentResolver.query(CONTENT_URI, null, null, null, null),
2944 keepUpdated, handlerForUpdateNotifications);
2945 }
2946
2947 public String getString(String name) {
2948 ContentValues cv = getValues(name);
2949 if (cv == null) return null;
2950 return cv.getAsString(VALUE);
2951 }
2952 }
2953
2954 }
2955
2956 /**
2957 * User-defined bookmarks and shortcuts. The target of each bookmark is an
2958 * Intent URL, allowing it to be either a web page or a particular
2959 * application activity.
2960 *
2961 * @hide
2962 */
2963 public static final class Bookmarks implements BaseColumns
2964 {
2965 private static final String TAG = "Bookmarks";
2966
2967 /**
2968 * The content:// style URL for this table
2969 */
2970 public static final Uri CONTENT_URI =
2971 Uri.parse("content://" + AUTHORITY + "/bookmarks");
2972
2973 /**
2974 * The row ID.
2975 * <p>Type: INTEGER</p>
2976 */
2977 public static final String ID = "_id";
2978
2979 /**
2980 * Descriptive name of the bookmark that can be displayed to the user.
2981 * If this is empty, the title should be resolved at display time (use
2982 * {@link #getTitle(Context, Cursor)} any time you want to display the
2983 * title of a bookmark.)
2984 * <P>
2985 * Type: TEXT
2986 * </P>
2987 */
2988 public static final String TITLE = "title";
2989
2990 /**
2991 * Arbitrary string (displayed to the user) that allows bookmarks to be
2992 * organized into categories. There are some special names for
2993 * standard folders, which all start with '@'. The label displayed for
2994 * the folder changes with the locale (via {@link #getLabelForFolder}) but
2995 * the folder name does not change so you can consistently query for
2996 * the folder regardless of the current locale.
2997 *
2998 * <P>Type: TEXT</P>
2999 *
3000 */
3001 public static final String FOLDER = "folder";
3002
3003 /**
3004 * The Intent URL of the bookmark, describing what it points to. This
3005 * value is given to {@link android.content.Intent#getIntent} to create
3006 * an Intent that can be launched.
3007 * <P>Type: TEXT</P>
3008 */
3009 public static final String INTENT = "intent";
3010
3011 /**
3012 * Optional shortcut character associated with this bookmark.
3013 * <P>Type: INTEGER</P>
3014 */
3015 public static final String SHORTCUT = "shortcut";
3016
3017 /**
3018 * The order in which the bookmark should be displayed
3019 * <P>Type: INTEGER</P>
3020 */
3021 public static final String ORDERING = "ordering";
3022
3023 private static final String[] sIntentProjection = { INTENT };
3024 private static final String[] sShortcutProjection = { ID, SHORTCUT };
3025 private static final String sShortcutSelection = SHORTCUT + "=?";
3026
3027 /**
3028 * Convenience function to retrieve the bookmarked Intent for a
3029 * particular shortcut key.
3030 *
3031 * @param cr The ContentResolver to query.
3032 * @param shortcut The shortcut key.
3033 *
3034 * @return Intent The bookmarked URL, or null if there is no bookmark
3035 * matching the given shortcut.
3036 */
3037 public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3038 {
3039 Intent intent = null;
3040
3041 Cursor c = cr.query(CONTENT_URI,
3042 sIntentProjection, sShortcutSelection,
3043 new String[] { String.valueOf((int) shortcut) }, ORDERING);
3044 // Keep trying until we find a valid shortcut
3045 try {
3046 while (intent == null && c.moveToNext()) {
3047 try {
3048 String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
3049 intent = Intent.getIntent(intentURI);
3050 } catch (java.net.URISyntaxException e) {
3051 // The stored URL is bad... ignore it.
3052 } catch (IllegalArgumentException e) {
3053 // Column not found
3054 Log.e(TAG, "Intent column not found", e);
3055 }
3056 }
3057 } finally {
3058 if (c != null) c.close();
3059 }
3060
3061 return intent;
3062 }
3063
3064 /**
3065 * Add a new bookmark to the system.
3066 *
3067 * @param cr The ContentResolver to query.
3068 * @param intent The desired target of the bookmark.
3069 * @param title Bookmark title that is shown to the user; null if none
3070 * or it should be resolved to the intent's title.
3071 * @param folder Folder in which to place the bookmark; null if none.
3072 * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3073 * this is non-zero and there is an existing bookmark entry
3074 * with this same shortcut, then that existing shortcut is
3075 * cleared (the bookmark is not removed).
3076 * @return The unique content URL for the new bookmark entry.
3077 */
3078 public static Uri add(ContentResolver cr,
3079 Intent intent,
3080 String title,
3081 String folder,
3082 char shortcut,
3083 int ordering)
3084 {
3085 // If a shortcut is supplied, and it is already defined for
3086 // another bookmark, then remove the old definition.
3087 if (shortcut != 0) {
3088 Cursor c = cr.query(CONTENT_URI,
3089 sShortcutProjection, sShortcutSelection,
3090 new String[] { String.valueOf((int) shortcut) }, null);
3091 try {
3092 if (c.moveToFirst()) {
3093 while (c.getCount() > 0) {
3094 if (!c.deleteRow()) {
3095 Log.w(TAG, "Could not delete existing shortcut row");
3096 }
3097 }
3098 }
3099 } finally {
3100 if (c != null) c.close();
3101 }
3102 }
3103
3104 ContentValues values = new ContentValues();
3105 if (title != null) values.put(TITLE, title);
3106 if (folder != null) values.put(FOLDER, folder);
3107 values.put(INTENT, intent.toURI());
3108 if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3109 values.put(ORDERING, ordering);
3110 return cr.insert(CONTENT_URI, values);
3111 }
3112
3113 /**
3114 * Return the folder name as it should be displayed to the user. This
3115 * takes care of localizing special folders.
3116 *
3117 * @param r Resources object for current locale; only need access to
3118 * system resources.
3119 * @param folder The value found in the {@link #FOLDER} column.
3120 *
3121 * @return CharSequence The label for this folder that should be shown
3122 * to the user.
3123 */
3124 public static CharSequence getLabelForFolder(Resources r, String folder) {
3125 return folder;
3126 }
3127
3128 /**
3129 * Return the title as it should be displayed to the user. This takes
3130 * care of localizing bookmarks that point to activities.
3131 *
3132 * @param context A context.
3133 * @param cursor A cursor pointing to the row whose title should be
3134 * returned. The cursor must contain at least the {@link #TITLE}
3135 * and {@link #INTENT} columns.
3136 * @return A title that is localized and can be displayed to the user,
3137 * or the empty string if one could not be found.
3138 */
3139 public static CharSequence getTitle(Context context, Cursor cursor) {
3140 int titleColumn = cursor.getColumnIndex(TITLE);
3141 int intentColumn = cursor.getColumnIndex(INTENT);
3142 if (titleColumn == -1 || intentColumn == -1) {
3143 throw new IllegalArgumentException(
3144 "The cursor must contain the TITLE and INTENT columns.");
3145 }
3146
3147 String title = cursor.getString(titleColumn);
3148 if (!TextUtils.isEmpty(title)) {
3149 return title;
3150 }
3151
3152 String intentUri = cursor.getString(intentColumn);
3153 if (TextUtils.isEmpty(intentUri)) {
3154 return "";
3155 }
3156
3157 Intent intent;
3158 try {
3159 intent = Intent.getIntent(intentUri);
3160 } catch (URISyntaxException e) {
3161 return "";
3162 }
3163
3164 PackageManager packageManager = context.getPackageManager();
3165 ResolveInfo info = packageManager.resolveActivity(intent, 0);
3166 return info != null ? info.loadLabel(packageManager) : "";
3167 }
3168 }
3169
3170 /**
3171 * Returns the GTalk JID resource associated with this device.
3172 *
3173 * @return String the JID resource of the device. It uses the device IMEI in the computation
3174 * of the JID resource. If IMEI is not ready (i.e. telephony module not ready), we'll return
3175 * an empty string.
3176 * @hide
3177 */
3178 // TODO: we shouldn't not have a permenant Jid resource, as that's an easy target for
3179 // spams. We should change it once a while, like when we resubscribe to the subscription feeds
3180 // server.
3181 // (also, should this live in GTalkService?)
3182 public static synchronized String getJidResource() {
3183 if (sJidResource != null) {
3184 return sJidResource;
3185 }
3186
3187 MessageDigest digest;
3188 try {
3189 digest = MessageDigest.getInstance("SHA-1");
3190 } catch (NoSuchAlgorithmException e) {
3191 throw new RuntimeException("this should never happen");
3192 }
3193
Wink Saville04e71b32009-04-02 11:00:54 -07003194 String deviceId = TelephonyManager.getDefault().getDeviceId();
3195 if (TextUtils.isEmpty(deviceId)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003196 return "";
3197 }
3198
Wink Saville04e71b32009-04-02 11:00:54 -07003199 byte[] hashedDeviceId = digest.digest(deviceId.getBytes());
3200 String id = new String(Base64.encodeBase64(hashedDeviceId), 0, 12);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003201 id = id.replaceAll("/", "_");
3202 sJidResource = JID_RESOURCE_PREFIX + id;
3203 return sJidResource;
3204 }
3205
3206 /**
3207 * Returns the device ID that we should use when connecting to the mobile gtalk server.
3208 * This is a string like "android-0x1242", where the hex string is the Android ID obtained
3209 * from the GoogleLoginService.
3210 *
3211 * @param androidId The Android ID for this device.
3212 * @return The device ID that should be used when connecting to the mobile gtalk server.
3213 * @hide
3214 */
3215 public static String getGTalkDeviceId(long androidId) {
3216 return "android-" + Long.toHexString(androidId);
3217 }
3218}
Wink Saville04e71b32009-04-02 11:00:54 -07003219