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