blob: 97955ae6a9e2149a2df2bc8fee4145f315602631 [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 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -0700122 * Activity Action: Show settings for accessibility modules.
123 * <p>
124 * In some cases, a matching Activity may not exist, so ensure you
125 * safeguard against this.
126 * <p>
127 * Input: Nothing.
128 * <p>
129 * Output: Nothing.
130 */
131 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
132 public static final String ACTION_ACCESSIBILITY_SETTINGS =
133 "android.settings.ACCESSIBILITY_SETTINGS";
134
135 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800136 * Activity Action: Show settings to allow configuration of security and
137 * location privacy.
138 * <p>
139 * In some cases, a matching Activity may not exist, so ensure you
140 * safeguard against this.
141 * <p>
142 * Input: Nothing.
143 * <p>
144 * Output: Nothing.
145 */
146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
147 public static final String ACTION_SECURITY_SETTINGS =
148 "android.settings.SECURITY_SETTINGS";
149
150 /**
151 * Activity Action: Show settings to allow configuration of Wi-Fi.
152
153 * <p>
154 * In some cases, a matching Activity may not exist, so ensure you
155 * safeguard against this.
156 * <p>
157 * Input: Nothing.
158 * <p>
159 * Output: Nothing.
160
161 */
162 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
163 public static final String ACTION_WIFI_SETTINGS =
164 "android.settings.WIFI_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700165
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800166 /**
167 * Activity Action: Show settings to allow configuration of a static IP
168 * address for Wi-Fi.
169 * <p>
170 * In some cases, a matching Activity may not exist, so ensure you safeguard
171 * 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_WIFI_IP_SETTINGS =
179 "android.settings.WIFI_IP_SETTINGS";
180
181 /**
182 * Activity Action: Show settings to allow configuration of Bluetooth.
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_BLUETOOTH_SETTINGS =
193 "android.settings.BLUETOOTH_SETTINGS";
194
195 /**
196 * Activity Action: Show settings to allow configuration of date and time.
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_DATE_SETTINGS =
207 "android.settings.DATE_SETTINGS";
208
209 /**
210 * Activity Action: Show settings to allow configuration of sound and volume.
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_SOUND_SETTINGS =
221 "android.settings.SOUND_SETTINGS";
222
223 /**
224 * Activity Action: Show settings to allow configuration of display.
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_DISPLAY_SETTINGS =
235 "android.settings.DISPLAY_SETTINGS";
236
237 /**
238 * Activity Action: Show settings to allow configuration of locale.
239 * <p>
240 * In some cases, a matching Activity may not exist, so ensure you
241 * safeguard against this.
242 * <p>
243 * Input: Nothing.
244 * <p>
245 * Output: Nothing.
246 */
247 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
248 public static final String ACTION_LOCALE_SETTINGS =
249 "android.settings.LOCALE_SETTINGS";
250
251 /**
252 * Activity Action: Show settings to configure input methods, in particular
253 * allowing the user to enable input methods.
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_INPUT_METHOD_SETTINGS =
264 "android.settings.INPUT_METHOD_SETTINGS";
265
266 /**
267 * Activity Action: Show settings to manage the user input dictionary.
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_USER_DICTIONARY_SETTINGS =
278 "android.settings.USER_DICTIONARY_SETTINGS";
279
280 /**
281 * Activity Action: Show settings to allow configuration of application-related settings.
282 * <p>
283 * In some cases, a matching Activity may not exist, so ensure you
284 * safeguard against this.
285 * <p>
286 * Input: Nothing.
287 * <p>
288 * Output: Nothing.
289 */
290 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
291 public static final String ACTION_APPLICATION_SETTINGS =
292 "android.settings.APPLICATION_SETTINGS";
293
294 /**
295 * Activity Action: Show settings to allow configuration of application
296 * development-related settings.
297 * <p>
298 * In some cases, a matching Activity may not exist, so ensure you safeguard
299 * 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_APPLICATION_DEVELOPMENT_SETTINGS =
307 "android.settings.APPLICATION_DEVELOPMENT_SETTINGS";
308
309 /**
310 * Activity Action: Show settings to allow configuration of quick launch shortcuts.
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_QUICK_LAUNCH_SETTINGS =
321 "android.settings.QUICK_LAUNCH_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 to manage installed applications.
325 * <p>
326 * In some cases, a matching Activity may not exist, so ensure you
327 * safeguard against this.
328 * <p>
329 * Input: Nothing.
330 * <p>
331 * Output: Nothing.
332 */
333 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
334 public static final String ACTION_MANAGE_APPLICATIONS_SETTINGS =
335 "android.settings.MANAGE_APPLICATIONS_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700336
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800337 /**
338 * Activity Action: Show settings for system update functionality.
339 * <p>
340 * In some cases, a matching Activity may not exist, so ensure you
341 * safeguard against this.
342 * <p>
343 * Input: Nothing.
344 * <p>
345 * Output: Nothing.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700346 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800347 * @hide
348 */
349 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
350 public static final String ACTION_SYSTEM_UPDATE_SETTINGS =
351 "android.settings.SYSTEM_UPDATE_SETTINGS";
352
353 /**
354 * Activity Action: Show settings to allow configuration of sync settings.
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_SYNC_SETTINGS =
365 "android.settings.SYNC_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700366
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800367 /**
368 * Activity Action: Show settings for selecting the network operator.
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_NETWORK_OPERATOR_SETTINGS =
379 "android.settings.NETWORK_OPERATOR_SETTINGS";
380
381 /**
382 * Activity Action: Show settings for selection of 2G/3G.
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_DATA_ROAMING_SETTINGS =
393 "android.settings.DATA_ROAMING_SETTINGS";
394
395 /**
396 * Activity Action: Show settings for internal storage.
397 * <p>
398 * In some cases, a matching Activity may not exist, so ensure you
399 * safeguard against this.
400 * <p>
401 * Input: Nothing.
402 * <p>
403 * Output: Nothing.
404 */
405 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
406 public static final String ACTION_INTERNAL_STORAGE_SETTINGS =
407 "android.settings.INTERNAL_STORAGE_SETTINGS";
408 /**
409 * Activity Action: Show settings for memory card storage.
410 * <p>
411 * In some cases, a matching Activity may not exist, so ensure you
412 * safeguard against this.
413 * <p>
414 * Input: Nothing.
415 * <p>
416 * Output: Nothing.
417 */
418 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
419 public static final String ACTION_MEMORY_CARD_SETTINGS =
420 "android.settings.MEMORY_CARD_SETTINGS";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700421
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800422 // End of Intent actions for Settings
423
424 private static final String JID_RESOURCE_PREFIX = "android";
425
426 public static final String AUTHORITY = "settings";
427
428 private static final String TAG = "Settings";
429
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800430 public static class SettingNotFoundException extends AndroidException {
431 public SettingNotFoundException(String msg) {
432 super(msg);
433 }
434 }
435
436 /**
437 * Common base for tables of name/value settings.
438 */
439 public static class NameValueTable implements BaseColumns {
440 public static final String NAME = "name";
441 public static final String VALUE = "value";
442
443 protected static boolean putString(ContentResolver resolver, Uri uri,
444 String name, String value) {
445 // The database will take care of replacing duplicates.
446 try {
447 ContentValues values = new ContentValues();
448 values.put(NAME, name);
449 values.put(VALUE, value);
450 resolver.insert(uri, values);
451 return true;
452 } catch (SQLException e) {
453 Log.e(TAG, "Can't set key " + name + " in " + uri, e);
454 return false;
455 }
456 }
457
458 public static Uri getUriFor(Uri uri, String name) {
459 return Uri.withAppendedPath(uri, name);
460 }
461 }
462
463 private static class NameValueCache {
464 private final String mVersionSystemProperty;
465 private final HashMap<String, String> mValues = Maps.newHashMap();
466 private long mValuesVersion = 0;
467 private final Uri mUri;
468
469 NameValueCache(String versionSystemProperty, Uri uri) {
470 mVersionSystemProperty = versionSystemProperty;
471 mUri = uri;
472 }
473
474 String getString(ContentResolver cr, String name) {
475 long newValuesVersion = SystemProperties.getLong(mVersionSystemProperty, 0);
476 if (mValuesVersion != newValuesVersion) {
477 mValues.clear();
478 mValuesVersion = newValuesVersion;
479 }
480 if (!mValues.containsKey(name)) {
481 String value = null;
482 Cursor c = null;
483 try {
484 c = cr.query(mUri, new String[] { Settings.NameValueTable.VALUE },
485 Settings.NameValueTable.NAME + "=?", new String[]{name}, null);
486 if (c != null && c.moveToNext()) value = c.getString(0);
487 mValues.put(name, value);
488 } catch (SQLException e) {
489 // SQL error: return null, but don't cache it.
490 Log.e(TAG, "Can't get key " + name + " from " + mUri, e);
491 } finally {
492 if (c != null) c.close();
493 }
494 return value;
495 } else {
496 return mValues.get(name);
497 }
498 }
499 }
500
501 /**
502 * System settings, containing miscellaneous system preferences. This
503 * table holds simple name/value pairs. There are convenience
504 * functions for accessing individual settings entries.
505 */
506 public static final class System extends NameValueTable {
507 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_system_version";
508
509 private static volatile NameValueCache mNameValueCache = null;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700510
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800511 private static final HashSet<String> MOVED_TO_SECURE;
512 static {
513 MOVED_TO_SECURE = new HashSet<String>(30);
514 MOVED_TO_SECURE.add(Secure.ADB_ENABLED);
515 MOVED_TO_SECURE.add(Secure.ANDROID_ID);
516 MOVED_TO_SECURE.add(Secure.BLUETOOTH_ON);
517 MOVED_TO_SECURE.add(Secure.DATA_ROAMING);
518 MOVED_TO_SECURE.add(Secure.DEVICE_PROVISIONED);
519 MOVED_TO_SECURE.add(Secure.HTTP_PROXY);
520 MOVED_TO_SECURE.add(Secure.INSTALL_NON_MARKET_APPS);
521 MOVED_TO_SECURE.add(Secure.LOCATION_PROVIDERS_ALLOWED);
522 MOVED_TO_SECURE.add(Secure.LOGGING_ID);
523 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_ENABLED);
524 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_LAST_UPDATE);
525 MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_REDIRECT_URL);
526 MOVED_TO_SECURE.add(Secure.SETTINGS_CLASSNAME);
527 MOVED_TO_SECURE.add(Secure.USB_MASS_STORAGE_ENABLED);
528 MOVED_TO_SECURE.add(Secure.USE_GOOGLE_MAIL);
529 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON);
530 MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY);
531 MOVED_TO_SECURE.add(Secure.WIFI_NUM_OPEN_NETWORKS_KEPT);
532 MOVED_TO_SECURE.add(Secure.WIFI_ON);
533 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE);
534 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_AP_COUNT);
535 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS);
536 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED);
537 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS);
538 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT);
539 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_MAX_AP_CHECKS);
540 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ON);
541 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_COUNT);
542 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_DELAY_MS);
543 MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS);
544 }
545
546 /**
547 * Look up a name in the database.
548 * @param resolver to access the database with
549 * @param name to look up in the table
550 * @return the corresponding value, or null if not present
551 */
552 public synchronized static String getString(ContentResolver resolver, String name) {
553 if (MOVED_TO_SECURE.contains(name)) {
554 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
555 + " to android.provider.Settings.Secure, returning read-only value.");
556 return Secure.getString(resolver, name);
557 }
558 if (mNameValueCache == null) {
559 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
560 }
561 return mNameValueCache.getString(resolver, name);
562 }
563
564 /**
565 * Store a name/value pair into the database.
566 * @param resolver to access the database with
567 * @param name to store
568 * @param value to associate with the name
569 * @return true if the value was set, false on database errors
570 */
571 public static boolean putString(ContentResolver resolver, String name, String value) {
572 if (MOVED_TO_SECURE.contains(name)) {
573 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
574 + " to android.provider.Settings.Secure, value is unchanged.");
575 return false;
576 }
577 return putString(resolver, CONTENT_URI, name, value);
578 }
579
580 /**
581 * Construct the content URI for a particular name/value pair,
582 * useful for monitoring changes with a ContentObserver.
583 * @param name to look up in the table
584 * @return the corresponding content URI, or null if not present
585 */
586 public static Uri getUriFor(String name) {
587 if (MOVED_TO_SECURE.contains(name)) {
588 Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
589 + " to android.provider.Settings.Secure, returning Secure URI.");
590 return Secure.getUriFor(Secure.CONTENT_URI, name);
591 }
592 return getUriFor(CONTENT_URI, name);
593 }
594
595 /**
596 * Convenience function for retrieving a single system settings value
597 * as an integer. Note that internally setting values are always
598 * stored as strings; this function converts the string to an integer
599 * for you. The default value will be returned if the setting is
600 * not defined or not an integer.
601 *
602 * @param cr The ContentResolver to access.
603 * @param name The name of the setting to retrieve.
604 * @param def Value to return if the setting is not defined.
605 *
606 * @return The setting's current value, or 'def' if it is not defined
607 * or not a valid integer.
608 */
609 public static int getInt(ContentResolver cr, String name, int def) {
610 String v = getString(cr, name);
611 try {
612 return v != null ? Integer.parseInt(v) : def;
613 } catch (NumberFormatException e) {
614 return def;
615 }
616 }
617
618 /**
619 * Convenience function for retrieving a single system settings value
620 * as an integer. Note that internally setting values are always
621 * stored as strings; this function converts the string to an integer
622 * for you.
623 * <p>
624 * This version does not take a default value. If the setting has not
625 * been set, or the string value is not a number,
626 * it throws {@link SettingNotFoundException}.
627 *
628 * @param cr The ContentResolver to access.
629 * @param name The name of the setting to retrieve.
630 *
631 * @throws SettingNotFoundException Thrown if a setting by the given
632 * name can't be found or the setting value is not an integer.
633 *
634 * @return The setting's current value.
635 */
636 public static int getInt(ContentResolver cr, String name)
637 throws SettingNotFoundException {
638 String v = getString(cr, name);
639 try {
640 return Integer.parseInt(v);
641 } catch (NumberFormatException e) {
642 throw new SettingNotFoundException(name);
643 }
644 }
645
646 /**
647 * Convenience function for updating a single settings value as an
648 * integer. This will either create a new entry in the table if the
649 * given name does not exist, or modify the value of the existing row
650 * with that name. Note that internally setting values are always
651 * stored as strings, so this function converts the given value to a
652 * string before storing it.
653 *
654 * @param cr The ContentResolver to access.
655 * @param name The name of the setting to modify.
656 * @param value The new value for the setting.
657 * @return true if the value was set, false on database errors
658 */
659 public static boolean putInt(ContentResolver cr, String name, int value) {
660 return putString(cr, name, Integer.toString(value));
661 }
662
663 /**
664 * Convenience function for retrieving a single system settings value
665 * as a {@code long}. Note that internally setting values are always
666 * stored as strings; this function converts the string to a {@code long}
667 * for you. The default value will be returned if the setting is
668 * not defined or not a {@code long}.
669 *
670 * @param cr The ContentResolver to access.
671 * @param name The name of the setting to retrieve.
672 * @param def Value to return if the setting is not defined.
673 *
674 * @return The setting's current value, or 'def' if it is not defined
675 * or not a valid {@code long}.
676 */
677 public static long getLong(ContentResolver cr, String name, long def) {
678 String valString = getString(cr, name);
679 long value;
680 try {
681 value = valString != null ? Long.parseLong(valString) : def;
682 } catch (NumberFormatException e) {
683 value = def;
684 }
685 return value;
686 }
687
688 /**
689 * Convenience function for retrieving a single system settings value
690 * as a {@code long}. Note that internally setting values are always
691 * stored as strings; this function converts the string to a {@code long}
692 * for you.
693 * <p>
694 * This version does not take a default value. If the setting has not
695 * been set, or the string value is not a number,
696 * it throws {@link SettingNotFoundException}.
697 *
698 * @param cr The ContentResolver to access.
699 * @param name The name of the setting to retrieve.
700 *
701 * @return The setting's current value.
702 * @throws SettingNotFoundException Thrown if a setting by the given
703 * name can't be found or the setting value is not an integer.
704 */
705 public static long getLong(ContentResolver cr, String name)
706 throws SettingNotFoundException {
707 String valString = getString(cr, name);
708 try {
709 return Long.parseLong(valString);
710 } catch (NumberFormatException e) {
711 throw new SettingNotFoundException(name);
712 }
713 }
714
715 /**
716 * Convenience function for updating a single settings value as a long
717 * integer. This will either create a new entry in the table if the
718 * given name does not exist, or modify the value of the existing row
719 * with that name. Note that internally setting values are always
720 * stored as strings, so this function converts the given value to a
721 * string before storing it.
722 *
723 * @param cr The ContentResolver to access.
724 * @param name The name of the setting to modify.
725 * @param value The new value for the setting.
726 * @return true if the value was set, false on database errors
727 */
728 public static boolean putLong(ContentResolver cr, String name, long value) {
729 return putString(cr, name, Long.toString(value));
730 }
731
732 /**
733 * Convenience function for retrieving a single system settings value
734 * as a floating point number. Note that internally setting values are
735 * always stored as strings; this function converts the string to an
736 * float for you. The default value will be returned if the setting
737 * is not defined or not a valid float.
738 *
739 * @param cr The ContentResolver to access.
740 * @param name The name of the setting to retrieve.
741 * @param def Value to return if the setting is not defined.
742 *
743 * @return The setting's current value, or 'def' if it is not defined
744 * or not a valid float.
745 */
746 public static float getFloat(ContentResolver cr, String name, float def) {
747 String v = getString(cr, name);
748 try {
749 return v != null ? Float.parseFloat(v) : def;
750 } catch (NumberFormatException e) {
751 return def;
752 }
753 }
754
755 /**
756 * Convenience function for retrieving a single system settings value
757 * as a float. Note that internally setting values are always
758 * stored as strings; this function converts the string to a float
759 * for you.
760 * <p>
761 * This version does not take a default value. If the setting has not
762 * been set, or the string value is not a number,
763 * it throws {@link SettingNotFoundException}.
764 *
765 * @param cr The ContentResolver to access.
766 * @param name The name of the setting to retrieve.
767 *
768 * @throws SettingNotFoundException Thrown if a setting by the given
769 * name can't be found or the setting value is not a float.
770 *
771 * @return The setting's current value.
772 */
773 public static float getFloat(ContentResolver cr, String name)
774 throws SettingNotFoundException {
775 String v = getString(cr, name);
776 try {
777 return Float.parseFloat(v);
778 } catch (NumberFormatException e) {
779 throw new SettingNotFoundException(name);
780 }
781 }
782
783 /**
784 * Convenience function for updating a single settings value as a
785 * floating point number. This will either create a new entry in the
786 * table if the given name does not exist, or modify the value of the
787 * existing row with that name. Note that internally setting values
788 * are always stored as strings, so this function converts the given
789 * value to a string before storing it.
790 *
791 * @param cr The ContentResolver to access.
792 * @param name The name of the setting to modify.
793 * @param value The new value for the setting.
794 * @return true if the value was set, false on database errors
795 */
796 public static boolean putFloat(ContentResolver cr, String name, float value) {
797 return putString(cr, name, Float.toString(value));
798 }
799
800 /**
801 * Convenience function to read all of the current
802 * configuration-related settings into a
803 * {@link Configuration} object.
804 *
805 * @param cr The ContentResolver to access.
806 * @param outConfig Where to place the configuration settings.
807 */
808 public static void getConfiguration(ContentResolver cr, Configuration outConfig) {
809 outConfig.fontScale = Settings.System.getFloat(
810 cr, FONT_SCALE, outConfig.fontScale);
811 if (outConfig.fontScale < 0) {
812 outConfig.fontScale = 1;
813 }
814 }
815
816 /**
817 * Convenience function to write a batch of configuration-related
818 * settings from a {@link Configuration} object.
819 *
820 * @param cr The ContentResolver to access.
821 * @param config The settings to write.
822 * @return true if the values were set, false on database errors
823 */
824 public static boolean putConfiguration(ContentResolver cr, Configuration config) {
825 return Settings.System.putFloat(cr, FONT_SCALE, config.fontScale);
826 }
827
828 public static boolean getShowGTalkServiceStatus(ContentResolver cr) {
829 return getInt(cr, SHOW_GTALK_SERVICE_STATUS, 0) != 0;
830 }
831
832 public static void setShowGTalkServiceStatus(ContentResolver cr, boolean flag) {
833 putInt(cr, SHOW_GTALK_SERVICE_STATUS, flag ? 1 : 0);
834 }
835
836 /**
837 * The content:// style URL for this table
838 */
839 public static final Uri CONTENT_URI =
840 Uri.parse("content://" + AUTHORITY + "/system");
841
842 /**
843 * Whether we keep the device on while the device is plugged in.
844 * Supported values are:
845 * <ul>
846 * <li>{@code 0} to never stay on while plugged in</li>
847 * <li>{@link BatteryManager#BATTERY_PLUGGED_AC} to stay on for AC charger</li>
848 * <li>{@link BatteryManager#BATTERY_PLUGGED_USB} to stay on for USB charger</li>
849 * </ul>
850 * These values can be OR-ed together.
851 */
852 public static final String STAY_ON_WHILE_PLUGGED_IN = "stay_on_while_plugged_in";
853
854 /**
855 * What happens when the user presses the end call button if they're not
856 * on a call.<br/>
857 * <b>Values:</b><br/>
858 * 0 - The end button does nothing.<br/>
859 * 1 - The end button goes to the home screen.<br/>
860 * 2 - The end button puts the device to sleep and locks the keyguard.<br/>
861 * 3 - The end button goes to the home screen. If the user is already on the
862 * home screen, it puts the device to sleep.
863 */
864 public static final String END_BUTTON_BEHAVIOR = "end_button_behavior";
865
866 /**
867 * Whether Airplane Mode is on.
868 */
869 public static final String AIRPLANE_MODE_ON = "airplane_mode_on";
870
871 /**
872 * Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.
873 */
874 public static final String RADIO_BLUETOOTH = "bluetooth";
875
876 /**
877 * Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.
878 */
879 public static final String RADIO_WIFI = "wifi";
880
881 /**
882 * Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.
883 */
884 public static final String RADIO_CELL = "cell";
885
886 /**
887 * A comma separated list of radios that need to be disabled when airplane mode
888 * is on. This overrides WIFI_ON and BLUETOOTH_ON, if Wi-Fi and bluetooth are
889 * included in the comma separated list.
890 */
891 public static final String AIRPLANE_MODE_RADIOS = "airplane_mode_radios";
892
893 /**
Mike Lockwoodbd5ddf02009-07-29 21:37:14 -0700894 * A comma separated list of radios that should to be disabled when airplane mode
895 * is on, but can be manually reenabled by the user. For example, if RADIO_WIFI is
896 * added to both AIRPLANE_MODE_RADIOS and AIRPLANE_MODE_TOGGLEABLE_RADIOS, then Wifi
897 * will be turned off when entering airplane mode, but the user will be able to reenable
898 * Wifi in the Settings app.
899 *
900 * {@hide}
901 */
902 public static final String AIRPLANE_MODE_TOGGLEABLE_RADIOS = "airplane_mode_toggleable_radios";
903
904 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800905 * The policy for deciding when Wi-Fi should go to sleep (which will in
906 * turn switch to using the mobile data as an Internet connection).
907 * <p>
908 * Set to one of {@link #WIFI_SLEEP_POLICY_DEFAULT},
909 * {@link #WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED}, or
910 * {@link #WIFI_SLEEP_POLICY_NEVER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800911 */
912 public static final String WIFI_SLEEP_POLICY = "wifi_sleep_policy";
913
914 /**
915 * Value for {@link #WIFI_SLEEP_POLICY} to use the default Wi-Fi sleep
916 * policy, which is to sleep shortly after the turning off
917 * according to the {@link #STAY_ON_WHILE_PLUGGED_IN} setting.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800918 */
919 public static final int WIFI_SLEEP_POLICY_DEFAULT = 0;
920
921 /**
922 * Value for {@link #WIFI_SLEEP_POLICY} to use the default policy when
923 * the device is on battery, and never go to sleep when the device is
924 * plugged in.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800925 */
926 public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED = 1;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700927
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800928 /**
929 * Value for {@link #WIFI_SLEEP_POLICY} to never go to sleep.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800930 */
931 public static final int WIFI_SLEEP_POLICY_NEVER = 2;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -0700932
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800933 /**
934 * Whether to use static IP and other static network attributes.
935 * <p>
936 * Set to 1 for true and 0 for false.
937 */
938 public static final String WIFI_USE_STATIC_IP = "wifi_use_static_ip";
939
940 /**
941 * The static IP address.
942 * <p>
943 * Example: "192.168.1.51"
944 */
945 public static final String WIFI_STATIC_IP = "wifi_static_ip";
946
947 /**
948 * If using static IP, the gateway's IP address.
949 * <p>
950 * Example: "192.168.1.1"
951 */
952 public static final String WIFI_STATIC_GATEWAY = "wifi_static_gateway";
953
954 /**
955 * If using static IP, the net mask.
956 * <p>
957 * Example: "255.255.255.0"
958 */
959 public static final String WIFI_STATIC_NETMASK = "wifi_static_netmask";
960
961 /**
962 * If using static IP, the primary DNS's IP address.
963 * <p>
964 * Example: "192.168.1.1"
965 */
966 public static final String WIFI_STATIC_DNS1 = "wifi_static_dns1";
967
968 /**
969 * If using static IP, the secondary DNS's IP address.
970 * <p>
971 * Example: "192.168.1.2"
972 */
973 public static final String WIFI_STATIC_DNS2 = "wifi_static_dns2";
974
975 /**
976 * The number of radio channels that are allowed in the local
977 * 802.11 regulatory domain.
978 * @hide
979 */
980 public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
981
982 /**
983 * Determines whether remote devices may discover and/or connect to
984 * this device.
985 * <P>Type: INT</P>
986 * 2 -- discoverable and connectable
987 * 1 -- connectable but not discoverable
988 * 0 -- neither connectable nor discoverable
989 */
990 public static final String BLUETOOTH_DISCOVERABILITY =
991 "bluetooth_discoverability";
992
993 /**
994 * Bluetooth discoverability timeout. If this value is nonzero, then
995 * Bluetooth becomes discoverable for a certain number of seconds,
996 * after which is becomes simply connectable. The value is in seconds.
997 */
998 public static final String BLUETOOTH_DISCOVERABILITY_TIMEOUT =
999 "bluetooth_discoverability_timeout";
1000
1001 /**
1002 * Whether autolock is enabled (0 = false, 1 = true)
1003 */
1004 public static final String LOCK_PATTERN_ENABLED = "lock_pattern_autolock";
1005
1006 /**
1007 * Whether lock pattern is visible as user enters (0 = false, 1 = true)
1008 */
1009 public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
1010
1011 /**
1012 * Whether lock pattern will vibrate as user enters (0 = false, 1 = true)
1013 */
1014 public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
1015 "lock_pattern_tactile_feedback_enabled";
1016
1017
1018 /**
1019 * A formatted string of the next alarm that is set, or the empty string
1020 * if there is no alarm set.
1021 */
1022 public static final String NEXT_ALARM_FORMATTED = "next_alarm_formatted";
1023
1024 /**
1025 * Scaling factor for fonts, float.
1026 */
1027 public static final String FONT_SCALE = "font_scale";
1028
1029 /**
1030 * Name of an application package to be debugged.
1031 */
1032 public static final String DEBUG_APP = "debug_app";
1033
1034 /**
1035 * If 1, when launching DEBUG_APP it will wait for the debugger before
1036 * starting user code. If 0, it will run normally.
1037 */
1038 public static final String WAIT_FOR_DEBUGGER = "wait_for_debugger";
1039
1040 /**
1041 * Whether or not to dim the screen. 0=no 1=yes
1042 */
1043 public static final String DIM_SCREEN = "dim_screen";
1044
1045 /**
1046 * The timeout before the screen turns off.
1047 */
1048 public static final String SCREEN_OFF_TIMEOUT = "screen_off_timeout";
1049
1050 /**
Mitsuru Oshimae5fb3282009-06-09 21:16:08 -07001051 * If 0, the compatibility mode is off for all applications.
1052 * If 1, older applications run under compatibility mode.
1053 * TODO: remove this settings before code freeze (bug/1907571)
1054 * @hide
1055 */
1056 public static final String COMPATIBILITY_MODE = "compatibility_mode";
1057
1058 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001059 * The screen backlight brightness between 0 and 255.
1060 */
1061 public static final String SCREEN_BRIGHTNESS = "screen_brightness";
1062
1063 /**
1064 * Control whether the process CPU usage meter should be shown.
1065 */
1066 public static final String SHOW_PROCESSES = "show_processes";
1067
1068 /**
1069 * If 1, the activity manager will aggressively finish activities and
1070 * processes as soon as they are no longer needed. If 0, the normal
1071 * extended lifetime is used.
1072 */
1073 public static final String ALWAYS_FINISH_ACTIVITIES =
1074 "always_finish_activities";
1075
1076
1077 /**
1078 * Ringer mode. This is used internally, changing this value will not
1079 * change the ringer mode. See AudioManager.
1080 */
1081 public static final String MODE_RINGER = "mode_ringer";
1082
1083 /**
1084 * Determines which streams are affected by ringer mode changes. The
1085 * stream type's bit should be set to 1 if it should be muted when going
1086 * into an inaudible ringer mode.
1087 */
1088 public static final String MODE_RINGER_STREAMS_AFFECTED = "mode_ringer_streams_affected";
1089
1090 /**
1091 * Determines which streams are affected by mute. The
1092 * stream type's bit should be set to 1 if it should be muted when a mute request
1093 * is received.
1094 */
1095 public static final String MUTE_STREAMS_AFFECTED = "mute_streams_affected";
1096
1097 /**
1098 * Whether vibrate is on for different events. This is used internally,
1099 * changing this value will not change the vibrate. See AudioManager.
1100 */
1101 public static final String VIBRATE_ON = "vibrate_on";
1102
1103 /**
1104 * Ringer volume. This is used internally, changing this value will not
1105 * change the volume. See AudioManager.
1106 */
1107 public static final String VOLUME_RING = "volume_ring";
1108
1109 /**
1110 * System/notifications volume. This is used internally, changing this
1111 * value will not change the volume. See AudioManager.
1112 */
1113 public static final String VOLUME_SYSTEM = "volume_system";
1114
1115 /**
1116 * Voice call volume. This is used internally, changing this value will
1117 * not change the volume. See AudioManager.
1118 */
1119 public static final String VOLUME_VOICE = "volume_voice";
1120
1121 /**
1122 * Music/media/gaming volume. This is used internally, changing this
1123 * value will not change the volume. See AudioManager.
1124 */
1125 public static final String VOLUME_MUSIC = "volume_music";
1126
1127 /**
1128 * Alarm volume. This is used internally, changing this
1129 * value will not change the volume. See AudioManager.
1130 */
1131 public static final String VOLUME_ALARM = "volume_alarm";
1132
1133 /**
1134 * Notification volume. This is used internally, changing this
1135 * value will not change the volume. See AudioManager.
1136 */
1137 public static final String VOLUME_NOTIFICATION = "volume_notification";
1138
1139 /**
1140 * Whether the notifications should use the ring volume (value of 1) or
1141 * a separate notification volume (value of 0). In most cases, users
1142 * will have this enabled so the notification and ringer volumes will be
1143 * the same. However, power users can disable this and use the separate
1144 * notification volume control.
1145 * <p>
1146 * Note: This is a one-off setting that will be removed in the future
1147 * when there is profile support. For this reason, it is kept hidden
1148 * from the public APIs.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001149 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001150 * @hide
1151 */
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001152 public static final String NOTIFICATIONS_USE_RING_VOLUME =
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001153 "notifications_use_ring_volume";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001154
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001155 /**
1156 * The mapping of stream type (integer) to its setting.
1157 */
1158 public static final String[] VOLUME_SETTINGS = {
1159 VOLUME_VOICE, VOLUME_SYSTEM, VOLUME_RING, VOLUME_MUSIC,
1160 VOLUME_ALARM, VOLUME_NOTIFICATION
1161 };
1162
1163 /**
1164 * Appended to various volume related settings to record the previous
1165 * values before they the settings were affected by a silent/vibrate
1166 * ringer mode change.
1167 */
1168 public static final String APPEND_FOR_LAST_AUDIBLE = "_last_audible";
1169
1170 /**
1171 * Persistent store for the system-wide default ringtone URI.
1172 * <p>
1173 * If you need to play the default ringtone at any given time, it is recommended
1174 * you give {@link #DEFAULT_RINGTONE_URI} to the media player. It will resolve
1175 * to the set default ringtone at the time of playing.
1176 *
1177 * @see #DEFAULT_RINGTONE_URI
1178 */
1179 public static final String RINGTONE = "ringtone";
1180
1181 /**
1182 * A {@link Uri} that will point to the current default ringtone at any
1183 * given time.
1184 * <p>
1185 * If the current default ringtone is in the DRM provider and the caller
1186 * does not have permission, the exception will be a
1187 * FileNotFoundException.
1188 */
1189 public static final Uri DEFAULT_RINGTONE_URI = getUriFor(RINGTONE);
1190
1191 /**
1192 * Persistent store for the system-wide default notification sound.
1193 *
1194 * @see #RINGTONE
1195 * @see #DEFAULT_NOTIFICATION_URI
1196 */
1197 public static final String NOTIFICATION_SOUND = "notification_sound";
1198
1199 /**
1200 * A {@link Uri} that will point to the current default notification
1201 * sound at any given time.
1202 *
1203 * @see #DEFAULT_RINGTONE_URI
1204 */
1205 public static final Uri DEFAULT_NOTIFICATION_URI = getUriFor(NOTIFICATION_SOUND);
1206
1207 /**
Patrick Scott3156bb002009-04-13 09:57:38 -07001208 * Persistent store for the system-wide default alarm alert.
1209 *
1210 * @see #RINGTONE
1211 * @see #DEFAULT_ALARM_ALERT_URI
1212 */
1213 public static final String ALARM_ALERT = "alarm_alert";
1214
1215 /**
1216 * A {@link Uri} that will point to the current default alarm alert at
1217 * any given time.
1218 *
1219 * @see #DEFAULT_ALARM_ALERT_URI
1220 */
1221 public static final Uri DEFAULT_ALARM_ALERT_URI = getUriFor(ALARM_ALERT);
1222
1223 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001224 * Setting to enable Auto Replace (AutoText) in text editors. 1 = On, 0 = Off
1225 */
1226 public static final String TEXT_AUTO_REPLACE = "auto_replace";
1227
1228 /**
1229 * Setting to enable Auto Caps in text editors. 1 = On, 0 = Off
1230 */
1231 public static final String TEXT_AUTO_CAPS = "auto_caps";
1232
1233 /**
1234 * Setting to enable Auto Punctuate in text editors. 1 = On, 0 = Off. This
1235 * feature converts two spaces to a "." and space.
1236 */
1237 public static final String TEXT_AUTO_PUNCTUATE = "auto_punctuate";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001238
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001239 /**
1240 * Setting to showing password characters in text editors. 1 = On, 0 = Off
1241 */
1242 public static final String TEXT_SHOW_PASSWORD = "show_password";
1243
1244 public static final String SHOW_GTALK_SERVICE_STATUS =
1245 "SHOW_GTALK_SERVICE_STATUS";
1246
1247 /**
1248 * Name of activity to use for wallpaper on the home screen.
1249 */
1250 public static final String WALLPAPER_ACTIVITY = "wallpaper_activity";
1251
1252 /**
1253 * Value to specify if the user prefers the date, time and time zone
1254 * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1255 */
1256 public static final String AUTO_TIME = "auto_time";
1257
1258 /**
1259 * Display times as 12 or 24 hours
1260 * 12
1261 * 24
1262 */
1263 public static final String TIME_12_24 = "time_12_24";
1264
1265 /**
1266 * Date format string
1267 * mm/dd/yyyy
1268 * dd/mm/yyyy
1269 * yyyy/mm/dd
1270 */
1271 public static final String DATE_FORMAT = "date_format";
1272
1273 /**
1274 * Whether the setup wizard has been run before (on first boot), or if
1275 * it still needs to be run.
1276 *
1277 * nonzero = it has been run in the past
1278 * 0 = it has not been run in the past
1279 */
1280 public static final String SETUP_WIZARD_HAS_RUN = "setup_wizard_has_run";
1281
1282 /**
1283 * Scaling factor for normal window animations. Setting to 0 will disable window
1284 * animations.
1285 */
1286 public static final String WINDOW_ANIMATION_SCALE = "window_animation_scale";
1287
1288 /**
1289 * Scaling factor for activity transition animations. Setting to 0 will disable window
1290 * animations.
1291 */
1292 public static final String TRANSITION_ANIMATION_SCALE = "transition_animation_scale";
1293
1294 /**
1295 * Scaling factor for normal window animations. Setting to 0 will disable window
1296 * animations.
1297 * @hide
1298 */
1299 public static final String FANCY_IME_ANIMATIONS = "fancy_ime_animations";
1300
1301 /**
1302 * Control whether the accelerometer will be used to change screen
1303 * orientation. If 0, it will not be used unless explicitly requested
1304 * by the application; if 1, it will be used by default unless explicitly
1305 * disabled by the application.
1306 */
1307 public static final String ACCELEROMETER_ROTATION = "accelerometer_rotation";
1308
1309 /**
1310 * Whether the audible DTMF tones are played by the dialer when dialing. The value is
1311 * boolean (1 or 0).
1312 */
1313 public static final String DTMF_TONE_WHEN_DIALING = "dtmf_tone";
1314
1315 /**
David Kraused0f67152009-06-13 18:01:13 -05001316 * CDMA only settings
1317 * DTMF tone type played by the dialer when dialing.
1318 * 0 = Normal
1319 * 1 = Long
1320 * @hide
1321 */
1322 public static final String DTMF_TONE_TYPE_WHEN_DIALING = "dtmf_tone_type";
1323
1324 /**
1325 * CDMA only settings
1326 * Emergency Tone 0 = Off
1327 * 1 = Alert
1328 * 2 = Vibrate
1329 * @hide
1330 */
1331 public static final String EMERGENCY_TONE = "emergency_tone";
1332
1333 /**
1334 * CDMA only settings
1335 * Whether the auto retry is enabled. The value is
1336 * boolean (1 or 0).
1337 * @hide
1338 */
1339 public static final String CALL_AUTO_RETRY = "call_auto_retry";
1340
1341 /**
1342 * Whether the hearing aid is enabled. The value is
1343 * boolean (1 or 0).
1344 * @hide
1345 */
1346 public static final String HEARING_AID = "hearing_aid";
1347
1348 /**
1349 * CDMA only settings
1350 * TTY Mode
1351 * 0 = OFF
1352 * 1 = FULL
1353 * 2 = VCO
1354 * 3 = HCO
1355 * @hide
1356 */
1357 public static final String TTY_MODE = "tty_mode";
1358
1359 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001360 * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1361 * boolean (1 or 0).
1362 */
1363 public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001364
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001365 /**
1366 * Whether the haptic feedback (long presses, ...) are enabled. The value is
1367 * boolean (1 or 0).
1368 */
1369 public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
Sanjay Jeyakumar21bf2412009-07-09 13:31:48 -07001370
Mike LeBeau48603e72009-06-05 00:27:00 +01001371 /**
1372 * Whether live web suggestions while the user types into search dialogs are
1373 * enabled. Browsers and other search UIs should respect this, as it allows
1374 * a user to avoid sending partial queries to a search engine, if it poses
1375 * any privacy concern. The value is boolean (1 or 0).
1376 */
1377 public static final String SHOW_WEB_SUGGESTIONS = "show_web_suggestions";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001378
-b master501eec92009-07-06 13:53:11 -07001379 /**
1380 * Settings to backup. This is here so that it's in the same place as the settings
1381 * keys and easy to update.
1382 * @hide
1383 */
1384 public static final String[] SETTINGS_TO_BACKUP = {
1385 STAY_ON_WHILE_PLUGGED_IN,
1386 END_BUTTON_BEHAVIOR,
1387 WIFI_SLEEP_POLICY,
1388 WIFI_USE_STATIC_IP,
1389 WIFI_STATIC_IP,
1390 WIFI_STATIC_GATEWAY,
1391 WIFI_STATIC_NETMASK,
1392 WIFI_STATIC_DNS1,
1393 WIFI_STATIC_DNS2,
1394 BLUETOOTH_DISCOVERABILITY,
1395 BLUETOOTH_DISCOVERABILITY_TIMEOUT,
1396 DIM_SCREEN,
1397 SCREEN_OFF_TIMEOUT,
1398 SCREEN_BRIGHTNESS,
1399 VIBRATE_ON,
1400 NOTIFICATIONS_USE_RING_VOLUME,
Amith Yamasani8823c0a82009-07-07 14:30:17 -07001401 MODE_RINGER,
1402 MODE_RINGER_STREAMS_AFFECTED,
1403 MUTE_STREAMS_AFFECTED,
1404 VOLUME_VOICE,
1405 VOLUME_SYSTEM,
1406 VOLUME_RING,
1407 VOLUME_MUSIC,
1408 VOLUME_ALARM,
1409 VOLUME_NOTIFICATION,
1410 VOLUME_VOICE + APPEND_FOR_LAST_AUDIBLE,
1411 VOLUME_SYSTEM + APPEND_FOR_LAST_AUDIBLE,
1412 VOLUME_RING + APPEND_FOR_LAST_AUDIBLE,
1413 VOLUME_MUSIC + APPEND_FOR_LAST_AUDIBLE,
1414 VOLUME_ALARM + APPEND_FOR_LAST_AUDIBLE,
1415 VOLUME_NOTIFICATION + APPEND_FOR_LAST_AUDIBLE,
-b master501eec92009-07-06 13:53:11 -07001416 TEXT_AUTO_REPLACE,
1417 TEXT_AUTO_CAPS,
1418 TEXT_AUTO_PUNCTUATE,
1419 TEXT_SHOW_PASSWORD,
1420 AUTO_TIME,
1421 TIME_12_24,
1422 DATE_FORMAT,
1423 ACCELEROMETER_ROTATION,
1424 DTMF_TONE_WHEN_DIALING,
1425 DTMF_TONE_TYPE_WHEN_DIALING,
1426 EMERGENCY_TONE,
1427 CALL_AUTO_RETRY,
1428 HEARING_AID,
1429 TTY_MODE,
1430 SOUND_EFFECTS_ENABLED,
1431 HAPTIC_FEEDBACK_ENABLED,
1432 SHOW_WEB_SUGGESTIONS
1433 };
1434
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001435 // Settings moved to Settings.Secure
1436
1437 /**
Mike Lockwood460ae0c2009-04-02 22:33:27 -07001438 * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001439 * instead
1440 */
1441 @Deprecated
1442 public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1443
1444 /**
1445 * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1446 */
1447 @Deprecated
1448 public static final String ANDROID_ID = Secure.ANDROID_ID;
1449
1450 /**
1451 * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1452 */
1453 @Deprecated
1454 public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1455
1456 /**
1457 * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1458 */
1459 @Deprecated
1460 public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1461
1462 /**
1463 * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1464 */
1465 @Deprecated
1466 public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1467
1468 /**
1469 * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1470 */
1471 @Deprecated
1472 public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1473
1474 /**
1475 * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1476 */
1477 @Deprecated
1478 public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001479
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001480 /**
1481 * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1482 * instead
1483 */
1484 @Deprecated
1485 public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1486
1487 /**
1488 * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1489 */
1490 @Deprecated
1491 public static final String LOGGING_ID = Secure.LOGGING_ID;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001492
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001493 /**
1494 * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1495 */
1496 @Deprecated
1497 public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1498
1499 /**
1500 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1501 * instead
1502 */
1503 @Deprecated
1504 public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1505
1506 /**
1507 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1508 * instead
1509 */
1510 @Deprecated
1511 public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1512
1513 /**
1514 * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1515 * instead
1516 */
1517 @Deprecated
1518 public static final String PARENTAL_CONTROL_REDIRECT_URL =
1519 Secure.PARENTAL_CONTROL_REDIRECT_URL;
1520
1521 /**
1522 * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1523 */
1524 @Deprecated
1525 public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1526
1527 /**
1528 * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1529 */
1530 @Deprecated
1531 public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001532
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001533 /**
1534 * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1535 */
1536 @Deprecated
1537 public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1538
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001539 /**
1540 * @deprecated Use
1541 * {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT} instead
1542 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001543 @Deprecated
1544 public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1545
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001546 /**
1547 * @deprecated Use
1548 * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS} instead
1549 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 @Deprecated
1551 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1552 Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1553
1554 /**
1555 * @deprecated Use
1556 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1557 */
1558 @Deprecated
1559 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1560 Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
1561
1562 /**
1563 * @deprecated Use
1564 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
1565 */
1566 @Deprecated
1567 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1568 Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001569
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001570 /**
1571 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
1572 * instead
1573 */
1574 @Deprecated
1575 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
1576
1577 /**
1578 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
1579 */
1580 @Deprecated
1581 public static final String WIFI_ON = Secure.WIFI_ON;
1582
1583 /**
1584 * @deprecated Use
1585 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
1586 * instead
1587 */
1588 @Deprecated
1589 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1590 Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
1591
1592 /**
1593 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
1594 */
1595 @Deprecated
1596 public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
1597
1598 /**
1599 * @deprecated Use
1600 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
1601 */
1602 @Deprecated
1603 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1604 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001605
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001606 /**
1607 * @deprecated Use
1608 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
1609 */
1610 @Deprecated
1611 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1612 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
1613
1614 /**
1615 * @deprecated Use
1616 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
1617 * instead
1618 */
1619 @Deprecated
1620 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1621 Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
1622
1623 /**
1624 * @deprecated Use
1625 * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
1626 */
1627 @Deprecated
1628 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
1629 Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
1630
1631 /**
1632 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
1633 * instead
1634 */
1635 @Deprecated
1636 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
1637
1638 /**
1639 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
1640 */
1641 @Deprecated
1642 public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
1643
1644 /**
1645 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
1646 */
1647 @Deprecated
1648 public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
1649
1650 /**
1651 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
1652 * instead
1653 */
1654 @Deprecated
1655 public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
1656
1657 /**
1658 * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
1659 * instead
1660 */
1661 @Deprecated
1662 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
1663 Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
1664 }
1665
1666 /**
1667 * Secure system settings, containing system preferences that applications
1668 * can read but are not allowed to write. These are for preferences that
1669 * the user must explicitly modify through the system UI or specialized
1670 * APIs for those values, not modified directly by applications.
1671 */
1672 public static final class Secure extends NameValueTable {
1673 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
1674
1675 private static volatile NameValueCache mNameValueCache = null;
1676
1677 /**
1678 * Look up a name in the database.
1679 * @param resolver to access the database with
1680 * @param name to look up in the table
1681 * @return the corresponding value, or null if not present
1682 */
1683 public synchronized static String getString(ContentResolver resolver, String name) {
1684 if (mNameValueCache == null) {
1685 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
1686 }
1687 return mNameValueCache.getString(resolver, name);
1688 }
1689
1690 /**
1691 * Store a name/value pair into the database.
1692 * @param resolver to access the database with
1693 * @param name to store
1694 * @param value to associate with the name
1695 * @return true if the value was set, false on database errors
1696 */
1697 public static boolean putString(ContentResolver resolver,
1698 String name, String value) {
1699 return putString(resolver, CONTENT_URI, name, value);
1700 }
1701
1702 /**
1703 * Construct the content URI for a particular name/value pair,
1704 * useful for monitoring changes with a ContentObserver.
1705 * @param name to look up in the table
1706 * @return the corresponding content URI, or null if not present
1707 */
1708 public static Uri getUriFor(String name) {
1709 return getUriFor(CONTENT_URI, name);
1710 }
1711
1712 /**
1713 * Convenience function for retrieving a single secure settings value
1714 * as an integer. Note that internally setting values are always
1715 * stored as strings; this function converts the string to an integer
1716 * for you. The default value will be returned if the setting is
1717 * not defined or not an integer.
1718 *
1719 * @param cr The ContentResolver to access.
1720 * @param name The name of the setting to retrieve.
1721 * @param def Value to return if the setting is not defined.
1722 *
1723 * @return The setting's current value, or 'def' if it is not defined
1724 * or not a valid integer.
1725 */
1726 public static int getInt(ContentResolver cr, String name, int def) {
1727 String v = getString(cr, name);
1728 try {
1729 return v != null ? Integer.parseInt(v) : def;
1730 } catch (NumberFormatException e) {
1731 return def;
1732 }
1733 }
1734
1735 /**
1736 * Convenience function for retrieving a single secure settings value
1737 * as an integer. Note that internally setting values are always
1738 * stored as strings; this function converts the string to an integer
1739 * for you.
1740 * <p>
1741 * This version does not take a default value. If the setting has not
1742 * been set, or the string value is not a number,
1743 * it throws {@link SettingNotFoundException}.
1744 *
1745 * @param cr The ContentResolver to access.
1746 * @param name The name of the setting to retrieve.
1747 *
1748 * @throws SettingNotFoundException Thrown if a setting by the given
1749 * name can't be found or the setting value is not an integer.
1750 *
1751 * @return The setting's current value.
1752 */
1753 public static int getInt(ContentResolver cr, String name)
1754 throws SettingNotFoundException {
1755 String v = getString(cr, name);
1756 try {
1757 return Integer.parseInt(v);
1758 } catch (NumberFormatException e) {
1759 throw new SettingNotFoundException(name);
1760 }
1761 }
1762
1763 /**
1764 * Convenience function for updating a single settings value as an
1765 * integer. This will either create a new entry in the table if the
1766 * given name does not exist, or modify the value of the existing row
1767 * with that name. Note that internally setting values are always
1768 * stored as strings, so this function converts the given value to a
1769 * string before storing it.
1770 *
1771 * @param cr The ContentResolver to access.
1772 * @param name The name of the setting to modify.
1773 * @param value The new value for the setting.
1774 * @return true if the value was set, false on database errors
1775 */
1776 public static boolean putInt(ContentResolver cr, String name, int value) {
1777 return putString(cr, name, Integer.toString(value));
1778 }
1779
1780 /**
1781 * Convenience function for retrieving a single secure settings value
1782 * as a {@code long}. Note that internally setting values are always
1783 * stored as strings; this function converts the string to a {@code long}
1784 * for you. The default value will be returned if the setting is
1785 * not defined or not a {@code long}.
1786 *
1787 * @param cr The ContentResolver to access.
1788 * @param name The name of the setting to retrieve.
1789 * @param def Value to return if the setting is not defined.
1790 *
1791 * @return The setting's current value, or 'def' if it is not defined
1792 * or not a valid {@code long}.
1793 */
1794 public static long getLong(ContentResolver cr, String name, long def) {
1795 String valString = getString(cr, name);
1796 long value;
1797 try {
1798 value = valString != null ? Long.parseLong(valString) : def;
1799 } catch (NumberFormatException e) {
1800 value = def;
1801 }
1802 return value;
1803 }
1804
1805 /**
1806 * Convenience function for retrieving a single secure settings value
1807 * as a {@code long}. Note that internally setting values are always
1808 * stored as strings; this function converts the string to a {@code long}
1809 * for you.
1810 * <p>
1811 * This version does not take a default value. If the setting has not
1812 * been set, or the string value is not a number,
1813 * it throws {@link SettingNotFoundException}.
1814 *
1815 * @param cr The ContentResolver to access.
1816 * @param name The name of the setting to retrieve.
1817 *
1818 * @return The setting's current value.
1819 * @throws SettingNotFoundException Thrown if a setting by the given
1820 * name can't be found or the setting value is not an integer.
1821 */
1822 public static long getLong(ContentResolver cr, String name)
1823 throws SettingNotFoundException {
1824 String valString = getString(cr, name);
1825 try {
1826 return Long.parseLong(valString);
1827 } catch (NumberFormatException e) {
1828 throw new SettingNotFoundException(name);
1829 }
1830 }
1831
1832 /**
1833 * Convenience function for updating a secure settings value as a long
1834 * integer. This will either create a new entry in the table if the
1835 * given name does not exist, or modify the value of the existing row
1836 * with that name. Note that internally setting values are always
1837 * stored as strings, so this function converts the given value to a
1838 * string before storing it.
1839 *
1840 * @param cr The ContentResolver to access.
1841 * @param name The name of the setting to modify.
1842 * @param value The new value for the setting.
1843 * @return true if the value was set, false on database errors
1844 */
1845 public static boolean putLong(ContentResolver cr, String name, long value) {
1846 return putString(cr, name, Long.toString(value));
1847 }
1848
1849 /**
1850 * Convenience function for retrieving a single secure settings value
1851 * as a floating point number. Note that internally setting values are
1852 * always stored as strings; this function converts the string to an
1853 * float for you. The default value will be returned if the setting
1854 * is not defined or not a valid float.
1855 *
1856 * @param cr The ContentResolver to access.
1857 * @param name The name of the setting to retrieve.
1858 * @param def Value to return if the setting is not defined.
1859 *
1860 * @return The setting's current value, or 'def' if it is not defined
1861 * or not a valid float.
1862 */
1863 public static float getFloat(ContentResolver cr, String name, float def) {
1864 String v = getString(cr, name);
1865 try {
1866 return v != null ? Float.parseFloat(v) : def;
1867 } catch (NumberFormatException e) {
1868 return def;
1869 }
1870 }
1871
1872 /**
1873 * Convenience function for retrieving a single secure settings value
1874 * as a float. Note that internally setting values are always
1875 * stored as strings; this function converts the string to a float
1876 * for you.
1877 * <p>
1878 * This version does not take a default value. If the setting has not
1879 * been set, or the string value is not a number,
1880 * it throws {@link SettingNotFoundException}.
1881 *
1882 * @param cr The ContentResolver to access.
1883 * @param name The name of the setting to retrieve.
1884 *
1885 * @throws SettingNotFoundException Thrown if a setting by the given
1886 * name can't be found or the setting value is not a float.
1887 *
1888 * @return The setting's current value.
1889 */
1890 public static float getFloat(ContentResolver cr, String name)
1891 throws SettingNotFoundException {
1892 String v = getString(cr, name);
1893 try {
1894 return Float.parseFloat(v);
1895 } catch (NumberFormatException e) {
1896 throw new SettingNotFoundException(name);
1897 }
1898 }
1899
1900 /**
1901 * Convenience function for updating a single settings value as a
1902 * floating point number. This will either create a new entry in the
1903 * table if the given name does not exist, or modify the value of the
1904 * existing row with that name. Note that internally setting values
1905 * are always stored as strings, so this function converts the given
1906 * value to a string before storing it.
1907 *
1908 * @param cr The ContentResolver to access.
1909 * @param name The name of the setting to modify.
1910 * @param value The new value for the setting.
1911 * @return true if the value was set, false on database errors
1912 */
1913 public static boolean putFloat(ContentResolver cr, String name, float value) {
1914 return putString(cr, name, Float.toString(value));
1915 }
1916
1917 /**
1918 * The content:// style URL for this table
1919 */
1920 public static final Uri CONTENT_URI =
1921 Uri.parse("content://" + AUTHORITY + "/secure");
1922
1923 /**
1924 * Whether ADB is enabled.
1925 */
1926 public static final String ADB_ENABLED = "adb_enabled";
1927
1928 /**
1929 * Setting to allow mock locations and location provider status to be injected into the
1930 * LocationManager service for testing purposes during application development. These
1931 * locations and status values override actual location and status information generated
1932 * by network, gps, or other location providers.
1933 */
1934 public static final String ALLOW_MOCK_LOCATION = "mock_location";
1935
1936 /**
1937 * The Android ID (a unique 64-bit value) as a hex string.
1938 * Identical to that obtained by calling
1939 * GoogleLoginService.getAndroidId(); it is also placed here
1940 * so you can get it without binding to a service.
1941 */
1942 public static final String ANDROID_ID = "android_id";
1943
1944 /**
1945 * Whether bluetooth is enabled/disabled
1946 * 0=disabled. 1=enabled.
1947 */
1948 public static final String BLUETOOTH_ON = "bluetooth_on";
1949
1950 /**
1951 * Get the key that retrieves a bluetooth headset's priority.
1952 * @hide
1953 */
1954 public static final String getBluetoothHeadsetPriorityKey(String address) {
1955 return ("bluetooth_headset_priority_" + address.toUpperCase());
1956 }
1957
1958 /**
1959 * Get the key that retrieves a bluetooth a2dp sink's priority.
1960 * @hide
1961 */
1962 public static final String getBluetoothA2dpSinkPriorityKey(String address) {
1963 return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
1964 }
1965
1966 /**
1967 * Whether or not data roaming is enabled. (0 = false, 1 = true)
1968 */
1969 public static final String DATA_ROAMING = "data_roaming";
1970
1971 /**
1972 * Setting to record the input method used by default, holding the ID
1973 * of the desired method.
1974 */
1975 public static final String DEFAULT_INPUT_METHOD = "default_input_method";
1976
1977 /**
1978 * Whether the device has been provisioned (0 = false, 1 = true)
1979 */
1980 public static final String DEVICE_PROVISIONED = "device_provisioned";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001981
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001982 /**
1983 * List of input methods that are currently enabled. This is a string
1984 * containing the IDs of all enabled input methods, each ID separated
1985 * by ':'.
1986 */
1987 public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001988
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001989 /**
1990 * Host name and port for a user-selected proxy.
1991 */
1992 public static final String HTTP_PROXY = "http_proxy";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07001993
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001994 /**
1995 * Whether the package installer should allow installation of apps downloaded from
1996 * sources other than the Android Market (vending machine).
1997 *
1998 * 1 = allow installing from other sources
1999 * 0 = only allow installing from the Android Market
2000 */
2001 public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002002
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002003 /**
2004 * Comma-separated list of location providers that activities may access.
2005 */
2006 public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002007
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002008 /**
Mike Lockwoodbcab8df2009-06-25 16:39:09 -04002009 * Whether assisted GPS should be enabled or not.
2010 * @hide
2011 */
2012 public static final String ASSISTED_GPS_ENABLED = "assisted_gps_enabled";
2013
2014 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002015 * The Logging ID (a unique 64-bit value) as a hex string.
2016 * Used as a pseudonymous identifier for logging.
2017 * @deprecated This identifier is poorly initialized and has
2018 * many collisions. It should not be used.
2019 */
2020 @Deprecated
2021 public static final String LOGGING_ID = "logging_id";
2022
2023 /**
2024 * The Logging ID (a unique 64-bit value) as a hex string.
2025 * Used as a pseudonymous identifier for logging.
2026 * @hide
2027 */
2028 public static final String LOGGING_ID2 = "logging_id2";
2029
2030 /**
2031 * User preference for which network(s) should be used. Only the
2032 * connectivity service should touch this.
2033 */
2034 public static final String NETWORK_PREFERENCE = "network_preference";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002035
2036 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002037 */
2038 public static final String PARENTAL_CONTROL_ENABLED = "parental_control_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002039
2040 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002041 */
2042 public static final String PARENTAL_CONTROL_LAST_UPDATE = "parental_control_last_update";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002043
2044 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002045 */
2046 public static final String PARENTAL_CONTROL_REDIRECT_URL = "parental_control_redirect_url";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002047
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002048 /**
2049 * Settings classname to launch when Settings is clicked from All
2050 * Applications. Needed because of user testing between the old
2051 * and new Settings apps.
2052 */
2053 // TODO: 881807
2054 public static final String SETTINGS_CLASSNAME = "settings_classname";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002055
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002056 /**
2057 * USB Mass Storage Enabled
2058 */
2059 public static final String USB_MASS_STORAGE_ENABLED = "usb_mass_storage_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002060
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 /**
2062 * If this setting is set (to anything), then all references
2063 * to Gmail on the device must change to Google Mail.
2064 */
2065 public static final String USE_GOOGLE_MAIL = "use_google_mail";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002066
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002067 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002068 * If accessibility is enabled.
2069 */
2070 public static final String ACCESSIBILITY_ENABLED = "accessibility_enabled";
2071
2072 /**
2073 * List of the enabled accessibility providers.
2074 */
2075 public static final String ENABLED_ACCESSIBILITY_SERVICES =
2076 "enabled_accessibility_services";
2077
2078 /**
Jean-Michel Trivif62ba452009-06-04 14:55:24 -07002079 * Setting to always use the default text-to-speech settings regardless
2080 * of the application settings.
2081 * 1 = override application settings,
2082 * 0 = use application settings (if specified).
2083 */
2084 public static final String TTS_USE_DEFAULTS = "tts_use_defaults";
2085
2086 /**
2087 * Default text-to-speech engine speech rate. 100 = 1x
2088 */
2089 public static final String TTS_DEFAULT_RATE = "tts_default_rate";
2090
2091 /**
2092 * Default text-to-speech engine pitch. 100 = 1x
2093 */
2094 public static final String TTS_DEFAULT_PITCH = "tts_default_pitch";
2095
2096 /**
2097 * Default text-to-speech engine.
2098 */
2099 public static final String TTS_DEFAULT_SYNTH = "tts_default_synth";
2100
2101 /**
Jean-Michel Trivif4782672009-06-09 16:22:48 -07002102 * Default text-to-speech language.
2103 */
2104 public static final String TTS_DEFAULT_LANG = "tts_default_lang";
2105
2106 /**
Jean-Michel Trivia6fcc952009-06-19 14:06:01 -07002107 * Default text-to-speech country.
2108 */
2109 public static final String TTS_DEFAULT_COUNTRY = "tts_default_country";
2110
2111 /**
2112 * Default text-to-speech locale variant.
2113 */
2114 public static final String TTS_DEFAULT_VARIANT = "tts_default_variant";
2115
2116 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002117 * Whether to notify the user of open networks.
2118 * <p>
2119 * If not connected and the scan results have an open network, we will
2120 * put this notification up. If we attempt to connect to a network or
2121 * the open network(s) disappear, we remove the notification. When we
2122 * show the notification, we will not show it again for
2123 * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} time.
2124 */
2125 public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
2126 "wifi_networks_available_notification_on";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002127
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002128 /**
2129 * Delay (in seconds) before repeating the Wi-Fi networks available notification.
2130 * Connecting to a network will reset the timer.
2131 */
2132 public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
2133 "wifi_networks_available_repeat_delay";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002134
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002135 /**
2136 * The number of radio channels that are allowed in the local
2137 * 802.11 regulatory domain.
2138 * @hide
2139 */
2140 public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002141
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002142 /**
2143 * When the number of open networks exceeds this number, the
2144 * least-recently-used excess networks will be removed.
2145 */
2146 public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = "wifi_num_open_networks_kept";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002147
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 /**
2149 * Whether the Wi-Fi should be on. Only the Wi-Fi service should touch this.
2150 */
2151 public static final String WIFI_ON = "wifi_on";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002152
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002153 /**
2154 * The acceptable packet loss percentage (range 0 - 100) before trying
2155 * another AP on the same network.
2156 */
2157 public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
2158 "wifi_watchdog_acceptable_packet_loss_percentage";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002159
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002160 /**
2161 * The number of access points required for a network in order for the
2162 * watchdog to monitor it.
2163 */
2164 public static final String WIFI_WATCHDOG_AP_COUNT = "wifi_watchdog_ap_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002165
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002166 /**
2167 * The delay between background checks.
2168 */
2169 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
2170 "wifi_watchdog_background_check_delay_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002171
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002172 /**
2173 * Whether the Wi-Fi watchdog is enabled for background checking even
2174 * after it thinks the user has connected to a good access point.
2175 */
2176 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
2177 "wifi_watchdog_background_check_enabled";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002178
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 /**
2180 * The timeout for a background ping
2181 */
2182 public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
2183 "wifi_watchdog_background_check_timeout_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002184
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002185 /**
2186 * The number of initial pings to perform that *may* be ignored if they
2187 * fail. Again, if these fail, they will *not* be used in packet loss
2188 * calculation. For example, one network always seemed to time out for
2189 * the first couple pings, so this is set to 3 by default.
2190 */
2191 public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2192 "wifi_watchdog_initial_ignored_ping_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002193
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002194 /**
2195 * The maximum number of access points (per network) to attempt to test.
2196 * If this number is reached, the watchdog will no longer monitor the
2197 * initial connection state for the network. This is a safeguard for
2198 * networks containing multiple APs whose DNS does not respond to pings.
2199 */
2200 public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = "wifi_watchdog_max_ap_checks";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002201
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002202 /**
2203 * Whether the Wi-Fi watchdog is enabled.
2204 */
2205 public static final String WIFI_WATCHDOG_ON = "wifi_watchdog_on";
2206
2207 /**
2208 * 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 -08002209 */
2210 public static final String WIFI_WATCHDOG_WATCH_LIST = "wifi_watchdog_watch_list";
2211
2212 /**
2213 * The number of pings to test if an access point is a good connection.
2214 */
2215 public static final String WIFI_WATCHDOG_PING_COUNT = "wifi_watchdog_ping_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002216
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002217 /**
2218 * The delay between pings.
2219 */
2220 public static final String WIFI_WATCHDOG_PING_DELAY_MS = "wifi_watchdog_ping_delay_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002221
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002222 /**
2223 * The timeout per ping.
2224 */
2225 public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS = "wifi_watchdog_ping_timeout_ms";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002226
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002227 /**
2228 * The maximum number of times we will retry a connection to an access
2229 * point for which we have failed in acquiring an IP address from DHCP.
2230 * 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 -08002231 */
2232 public static final String WIFI_MAX_DHCP_RETRY_COUNT = "wifi_max_dhcp_retry_count";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002233
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002234 /**
2235 * Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile
2236 * data connectivity to be established after a disconnect from Wi-Fi.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002237 */
2238 public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
2239 "wifi_mobile_data_transition_wakelock_timeout_ms";
2240
2241 /**
2242 * Whether background data usage is allowed by the user. See
2243 * ConnectivityManager for more info.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002244 */
2245 public static final String BACKGROUND_DATA = "background_data";
Wink Saville04e71b32009-04-02 11:00:54 -07002246
2247 /**
Christian Sonntag62d95ea2009-09-02 09:28:37 -07002248 * The time in msec, when the LAST_KMSG file was send to the checkin server.
2249 * We will only send the LAST_KMSG file if it was modified after this time.
2250 *
2251 * @hide
2252 */
2253 public static final String CHECKIN_SEND_LAST_KMSG_TIME = "checkin_kmsg_time";
2254
2255 /**
2256 * The time in msec, when the apanic_console file was send to the checkin server.
2257 * We will only send the apanic_console file if it was modified after this time.
2258 *
2259 * @hide
2260 */
2261 public static final String CHECKIN_SEND_APANIC_CONSOLE_TIME =
2262 "checkin_apanic_console_time";
2263
2264 /**
2265 * The time in msec, when the apanic_thread file was send to the checkin server.
2266 * We will only send the apanic_thread file if it was modified after this time.
2267 *
2268 * @hide
2269 */
2270 public static final String CHECKIN_SEND_APANIC_THREAD_TIME =
2271 "checkin_apanic_thread_time";
2272
2273 /**
Wink Saville04e71b32009-04-02 11:00:54 -07002274 * The CDMA roaming mode 0 = Home Networks, CDMA default
2275 * 1 = Roaming on Affiliated networks
2276 * 2 = Roaming on any networks
2277 * @hide
2278 */
2279 public static final String CDMA_ROAMING_MODE = "roaming_settings";
2280
2281 /**
2282 * The CDMA subscription mode 0 = RUIM/SIM (default)
2283 * 1 = NV
2284 * @hide
2285 */
2286 public static final String CDMA_SUBSCRIPTION_MODE = "subscription_mode";
2287
2288 /**
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002289 * The preferred network mode 7 = Global
2290 * 6 = EvDo only
2291 * 5 = CDMA w/o EvDo
2292 * 4 = CDMA / EvDo auto
2293 * 3 = GSM / WCDMA auto
2294 * 2 = WCDMA only
2295 * 1 = GSM only
2296 * 0 = GSM / WCDMA preferred
Wink Saville04e71b32009-04-02 11:00:54 -07002297 * @hide
2298 */
2299 public static final String PREFERRED_NETWORK_MODE =
2300 "preferred_network_mode";
2301
2302 /**
Wink Savillee9b06d72009-05-18 21:47:50 -07002303 * The preferred TTY mode 0 = TTy Off, CDMA default
2304 * 1 = TTY Full
2305 * 2 = TTY HCO
2306 * 3 = TTY VCO
2307 * @hide
2308 */
2309 public static final String PREFERRED_TTY_MODE =
2310 "preferred_tty_mode";
2311
2312
2313 /**
Wink Saville04e71b32009-04-02 11:00:54 -07002314 * CDMA Cell Broadcast SMS
2315 * 0 = CDMA Cell Broadcast SMS disabled
2316 * 1 = CDMA Cell Broadcast SMS enabled
2317 * @hide
2318 */
2319 public static final String CDMA_CELL_BROADCAST_SMS =
2320 "cdma_cell_broadcast_sms";
2321
2322 /**
2323 * The cdma subscription 0 = Subscription from RUIM, when available
2324 * 1 = Subscription from NV
2325 * @hide
2326 */
2327 public static final String PREFERRED_CDMA_SUBSCRIPTION =
2328 "preferred_cdma_subscription";
2329
2330 /**
2331 * Whether the enhanced voice privacy mode is enabled.
2332 * 0 = normal voice privacy
2333 * 1 = enhanced voice privacy
2334 * @hide
2335 */
2336 public static final String ENHANCED_VOICE_PRIVACY_ENABLED = "enhanced_voice_privacy_enabled";
2337
2338 /**
2339 * Whether the TTY mode mode is enabled.
2340 * 0 = disabled
2341 * 1 = enabled
2342 * @hide
2343 */
2344 public static final String TTY_MODE_ENABLED = "tty_mode_enabled";
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07002345
2346 /**
Amith Yamasani630cd062009-06-19 12:07:02 -07002347 * Flag for allowing service provider to use location information to improve products and
2348 * services.
2349 * Type: int ( 0 = disallow, 1 = allow )
2350 * @hide
2351 */
2352 public static final String USE_LOCATION_FOR_SERVICES = "use_location";
2353
2354 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07002355 * Controls whether settings backup is enabled.
Dianne Hackborncf098292009-07-01 19:55:20 -07002356 * Type: int ( 0 = disabled, 1 = enabled )
2357 * @hide
2358 */
2359 public static final String BACKUP_ENABLED = "backup_enabled";
2360
2361 /**
Christopher Tate8031a3d2009-07-06 16:36:05 -07002362 * Indicates whether settings backup has been fully provisioned.
2363 * Type: int ( 0 = unprovisioned, 1 = fully provisioned )
2364 * @hide
2365 */
2366 public static final String BACKUP_PROVISIONED = "backup_provisioned";
2367
2368 /**
Dianne Hackborncf098292009-07-01 19:55:20 -07002369 * Component of the transport to use for backup/restore.
2370 * @hide
2371 */
2372 public static final String BACKUP_TRANSPORT = "backup_transport";
Sanjay Jeyakumar21bf2412009-07-09 13:31:48 -07002373
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07002374 /**
2375 * Version for which the setup wizard was last shown. Bumped for
2376 * each release when there is new setup information to show.
2377 * @hide
2378 */
2379 public static final String LAST_SETUP_SHOWN = "last_setup_shown";
Dianne Hackborncf098292009-07-01 19:55:20 -07002380
2381 /**
-b master501eec92009-07-06 13:53:11 -07002382 * @hide
2383 */
2384 public static final String[] SETTINGS_TO_BACKUP = {
Amith Yamasani8823c0a82009-07-07 14:30:17 -07002385 ADB_ENABLED,
2386 ALLOW_MOCK_LOCATION,
-b master501eec92009-07-06 13:53:11 -07002387 INSTALL_NON_MARKET_APPS,
2388 PARENTAL_CONTROL_ENABLED,
2389 PARENTAL_CONTROL_REDIRECT_URL,
2390 USB_MASS_STORAGE_ENABLED,
2391 ACCESSIBILITY_ENABLED,
2392 ENABLED_ACCESSIBILITY_SERVICES,
2393 TTS_USE_DEFAULTS,
2394 TTS_DEFAULT_RATE,
2395 TTS_DEFAULT_PITCH,
2396 TTS_DEFAULT_SYNTH,
2397 TTS_DEFAULT_LANG,
2398 TTS_DEFAULT_COUNTRY,
2399 WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON,
2400 WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY,
2401 WIFI_NUM_ALLOWED_CHANNELS,
2402 WIFI_NUM_OPEN_NETWORKS_KEPT,
2403 BACKGROUND_DATA,
2404 PREFERRED_NETWORK_MODE,
2405 PREFERRED_TTY_MODE,
2406 CDMA_CELL_BROADCAST_SMS,
2407 PREFERRED_CDMA_SUBSCRIPTION,
2408 ENHANCED_VOICE_PRIVACY_ENABLED
2409 };
2410
2411 /**
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07002412 * Helper method for determining if a location provider is enabled.
2413 * @param cr the content resolver to use
2414 * @param provider the location provider to query
2415 * @return true if the provider is enabled
2416 *
2417 * @hide
2418 */
2419 public static final boolean isLocationProviderEnabled(ContentResolver cr, String provider) {
2420 String allowedProviders = Settings.Secure.getString(cr, LOCATION_PROVIDERS_ALLOWED);
2421 if (allowedProviders != null) {
2422 return (allowedProviders.equals(provider) ||
2423 allowedProviders.contains("," + provider + ",") ||
2424 allowedProviders.startsWith(provider + ",") ||
2425 allowedProviders.endsWith("," + provider));
2426 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002427 return false;
Mike Lockwoodbd2a7122009-04-02 23:41:33 -07002428 }
2429
2430 /**
2431 * Thread-safe method for enabling or disabling a single location provider.
2432 * @param cr the content resolver to use
2433 * @param provider the location provider to enable or disable
2434 * @param enabled true if the provider should be enabled
2435 *
2436 * @hide
2437 */
2438 public static final void setLocationProviderEnabled(ContentResolver cr,
2439 String provider, boolean enabled) {
2440 // to ensure thread safety, we write the provider name with a '+' or '-'
2441 // and let the SettingsProvider handle it rather than reading and modifying
2442 // the list of enabled providers.
2443 if (enabled) {
2444 provider = "+" + provider;
2445 } else {
2446 provider = "-" + provider;
2447 }
2448 putString(cr, Settings.Secure.LOCATION_PROVIDERS_ALLOWED, provider);
2449 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002450 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002451
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002452 /**
2453 * Gservices settings, containing the network names for Google's
2454 * various services. This table holds simple name/addr pairs.
2455 * Addresses can be accessed through the getString() method.
2456 *
2457 * TODO: This should move to partner/google/... somewhere.
2458 *
2459 * @hide
2460 */
2461 public static final class Gservices extends NameValueTable {
2462 public static final String SYS_PROP_SETTING_VERSION = "sys.settings_gservices_version";
2463
2464 /**
2465 * Intent action broadcast when the Gservices table is updated by the server.
2466 * This is broadcast once after settings change (so many values may have been updated).
2467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String CHANGED_ACTION =
2470 "com.google.gservices.intent.action.GSERVICES_CHANGED";
2471
Dan Egnorabc25e32009-05-13 19:22:08 -07002472 /**
2473 * Intent action to override Gservices for testing. (Requires WRITE_GSERVICES permission.)
2474 */
2475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2476 public static final String OVERRIDE_ACTION =
2477 "com.google.gservices.intent.action.GSERVICES_OVERRIDE";
2478
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002479 private static volatile NameValueCache mNameValueCache = null;
2480 private static final Object mNameValueCacheLock = new Object();
2481
2482 /**
2483 * Look up a name in the database.
2484 * @param resolver to access the database with
2485 * @param name to look up in the table
2486 * @return the corresponding value, or null if not present
2487 */
2488 public static String getString(ContentResolver resolver, String name) {
2489 synchronized (mNameValueCacheLock) {
2490 if (mNameValueCache == null) {
2491 mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
2492 }
2493 return mNameValueCache.getString(resolver, name);
2494 }
2495 }
2496
2497 /**
2498 * Store a name/value pair into the database.
2499 * @param resolver to access the database with
2500 * @param name to store
2501 * @param value to associate with the name
2502 * @return true if the value was set, false on database errors
2503 */
2504 public static boolean putString(ContentResolver resolver,
2505 String name, String value) {
2506 return putString(resolver, CONTENT_URI, name, value);
2507 }
2508
2509 /**
2510 * Look up the value for name in the database, convert it to an int using Integer.parseInt
2511 * and return it. If it is null or if a NumberFormatException is caught during the
2512 * conversion then return defValue.
2513 */
2514 public static int getInt(ContentResolver resolver, String name, int defValue) {
2515 String valString = getString(resolver, name);
2516 int value;
2517 try {
2518 value = valString != null ? Integer.parseInt(valString) : defValue;
2519 } catch (NumberFormatException e) {
2520 value = defValue;
2521 }
2522 return value;
2523 }
2524
2525 /**
2526 * Look up the value for name in the database, convert it to a long using Long.parseLong
2527 * and return it. If it is null or if a NumberFormatException is caught during the
2528 * conversion then return defValue.
2529 */
2530 public static long getLong(ContentResolver resolver, String name, long defValue) {
2531 String valString = getString(resolver, name);
2532 long value;
2533 try {
2534 value = valString != null ? Long.parseLong(valString) : defValue;
2535 } catch (NumberFormatException e) {
2536 value = defValue;
2537 }
2538 return value;
2539 }
2540
2541 /**
2542 * Construct the content URI for a particular name/value pair,
2543 * useful for monitoring changes with a ContentObserver.
2544 * @param name to look up in the table
2545 * @return the corresponding content URI, or null if not present
2546 */
2547 public static Uri getUriFor(String name) {
2548 return getUriFor(CONTENT_URI, name);
2549 }
2550
2551 /**
2552 * The content:// style URL for this table
2553 */
2554 public static final Uri CONTENT_URI =
2555 Uri.parse("content://" + AUTHORITY + "/gservices");
2556
2557 /**
2558 * MMS - URL to use for HTTP "x-wap-profile" header
2559 */
2560 public static final String MMS_X_WAP_PROFILE_URL
2561 = "mms_x_wap_profile_url";
2562
2563 /**
2564 * YouTube - the flag to indicate whether to use proxy
2565 */
2566 public static final String YOUTUBE_USE_PROXY
2567 = "youtube_use_proxy";
2568
2569 /**
2570 * MMS - maximum message size in bytes for a MMS message.
2571 */
2572 public static final String MMS_MAXIMUM_MESSAGE_SIZE
2573 = "mms_maximum_message_size";
2574
2575 /**
2576 * Event tags from the kernel event log to upload during checkin.
2577 */
2578 public static final String CHECKIN_EVENTS = "checkin_events";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07002579
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002580 /**
Dianne Hackborn9fdbf6a2009-07-19 14:18:51 -07002581 * Comma-separated list of service names to dump and upload during checkin.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002582 */
2583 public static final String CHECKIN_DUMPSYS_LIST = "checkin_dumpsys_list";
2584
2585 /**
Dianne Hackborn9fdbf6a2009-07-19 14:18:51 -07002586 * Comma-separated list of packages to specify for each service that is
2587 * dumped (currently only meaningful for user activity).
2588 */
2589 public static final String CHECKIN_PACKAGE_LIST = "checkin_package_list";
2590
2591 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002592 * The interval (in seconds) between periodic checkin attempts.
2593 */
2594 public static final String CHECKIN_INTERVAL = "checkin_interval";
2595
2596 /**
2597 * Boolean indicating if the market app should force market only checkins on
2598 * install/uninstall. Any non-0 value is considered true.
2599 */
2600 public static final String MARKET_FORCE_CHECKIN = "market_force_checkin";
2601
2602 /**
2603 * How frequently (in seconds) to check the memory status of the
2604 * device.
2605 */
2606 public static final String MEMCHECK_INTERVAL = "memcheck_interval";
2607
2608 /**
2609 * Max frequency (in seconds) to log memory check stats, in realtime
2610 * seconds. This allows for throttling of logs when the device is
2611 * running for large amounts of time.
2612 */
2613 public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
2614 "memcheck_log_realtime_interval";
2615
2616 /**
2617 * Boolean indicating whether rebooting due to system memory checks
2618 * is enabled.
2619 */
2620 public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
2621
2622 /**
2623 * How many bytes the system process must be below to avoid scheduling
2624 * a soft reboot. This reboot will happen when it is next determined
2625 * to be a good time.
2626 */
2627 public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
2628
2629 /**
2630 * How many bytes the system process must be below to avoid scheduling
2631 * a hard reboot. This reboot will happen immediately.
2632 */
2633 public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
2634
2635 /**
2636 * How many bytes the phone process must be below to avoid scheduling
2637 * a soft restart. This restart will happen when it is next determined
2638 * to be a good time.
2639 */
2640 public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
2641
2642 /**
2643 * How many bytes the phone process must be below to avoid scheduling
2644 * a hard restart. This restart will happen immediately.
2645 */
2646 public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
2647
2648 /**
2649 * Boolean indicating whether restarting the phone process due to
2650 * memory checks is enabled.
2651 */
2652 public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
2653
2654 /**
2655 * First time during the day it is okay to kill processes
2656 * or reboot the device due to low memory situations. This number is
2657 * in seconds since midnight.
2658 */
2659 public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
2660
2661 /**
2662 * Last time during the day it is okay to kill processes
2663 * or reboot the device due to low memory situations. This number is
2664 * in seconds since midnight.
2665 */
2666 public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
2667
2668 /**
2669 * How long the screen must have been off in order to kill processes
2670 * or reboot. This number is in seconds. A value of -1 means to
2671 * entirely disregard whether the screen is on.
2672 */
2673 public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
2674
2675 /**
2676 * How much time there must be until the next alarm in order to kill processes
2677 * or reboot. This number is in seconds. Note: this value must be
2678 * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
2679 * always see an alarm scheduled within its time.
2680 */
2681 public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
2682
2683 /**
2684 * How frequently to check whether it is a good time to restart things,
2685 * if the device is in a bad state. This number is in seconds. Note:
2686 * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
2687 * the alarm to schedule the recheck will always appear within the
2688 * minimum "do not execute now" time.
2689 */
2690 public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
2691
2692 /**
2693 * How frequently (in DAYS) to reboot the device. If 0, no reboots
2694 * will occur.
2695 */
2696 public static final String REBOOT_INTERVAL = "reboot_interval";
2697
2698 /**
2699 * First time during the day it is okay to force a reboot of the
2700 * device (if REBOOT_INTERVAL is set). This number is
2701 * in seconds since midnight.
2702 */
2703 public static final String REBOOT_START_TIME = "reboot_start_time";
2704
2705 /**
2706 * The window of time (in seconds) after each REBOOT_INTERVAL in which
2707 * a reboot can be executed. If 0, a reboot will always be executed at
2708 * exactly the given time. Otherwise, it will only be executed if
2709 * the device is idle within the window.
2710 */
2711 public static final String REBOOT_WINDOW = "reboot_window";
2712
2713 /**
2714 * The minimum version of the server that is required in order for the device to accept
2715 * the server's recommendations about the initial sync settings to use. When this is unset,
2716 * blank or can't be interpreted as an integer then we will not ask the server for a
2717 * recommendation.
2718 */
2719 public static final String GMAIL_CONFIG_INFO_MIN_SERVER_VERSION =
2720 "gmail_config_info_min_server_version";
2721
2722 /**
2723 * Controls whether Gmail offers a preview button for images.
2724 */
2725 public static final String GMAIL_DISALLOW_IMAGE_PREVIEWS = "gmail_disallow_image_previews";
2726
2727 /**
Cedric Beustafb6c8e2009-03-24 22:35:42 -07002728 * The maximal size in bytes allowed for attachments when composing messages in Gmail
2729 */
2730 public static final String GMAIL_MAX_ATTACHMENT_SIZE = "gmail_max_attachment_size_bytes";
2731
2732 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002733 * The timeout in milliseconds that Gmail uses when opening a connection and reading
2734 * from it. A missing value or a value of -1 instructs Gmail to use the defaults provided
2735 * by GoogleHttpClient.
2736 */
2737 public static final String GMAIL_TIMEOUT_MS = "gmail_timeout_ms";
2738
2739 /**
2740 * Controls whether Gmail will request an expedited sync when a message is sent. Value must
2741 * be an integer where non-zero means true. Defaults to 1.
2742 */
2743 public static final String GMAIL_SEND_IMMEDIATELY = "gmail_send_immediately";
2744
2745 /**
2746 * Controls whether gmail buffers server responses. Possible values are "memory", for a
2747 * memory-based buffer, or "file", for a temp-file-based buffer. All other values
2748 * (including not set) disable buffering.
2749 */
2750 public static final String GMAIL_BUFFER_SERVER_RESPONSE = "gmail_buffer_server_response";
2751
2752 /**
Cynthia Wong85427f712009-06-10 14:42:42 -07002753 * The maximum size in bytes allowed for the provider to gzip a protocol buffer uploaded to
2754 * the server.
2755 */
2756 public static final String GMAIL_MAX_GZIP_SIZE = "gmail_max_gzip_size_bytes";
2757
2758 /**
Cynthia Wong44e4aaf2009-04-08 13:32:09 -07002759 * Controls whether Gmail will discard uphill operations that repeatedly fail. Value must be
2760 * an integer where non-zero means true. Defaults to 1.
2761 */
2762 public static final String GMAIL_DISCARD_ERROR_UPHILL_OP = "gmail_discard_error_uphill_op";
2763
2764 /**
Cynthia Wong04f0b052009-07-07 11:14:21 -07002765 * Controls how many attempts Gmail will try to upload an uphill operations before it
2766 * abandons the operation. Defaults to 20.
2767 */
Cynthia Wong0d54b022009-08-10 16:39:36 -07002768 public static final String GMAIL_NUM_RETRY_UPHILL_OP = "gmail_num_retry_uphill_op";
2769
2770 /**
2771 * How much time in seconds Gmail will try to upload an uphill operations before it
2772 * abandons the operation. Defaults to 36400 (one day).
2773 */
2774 public static final String GMAIL_WAIT_TIME_RETRY_UPHILL_OP =
2775 "gmail_wait_time_retry_uphill_op";
Cynthia Wong04f0b052009-07-07 11:14:21 -07002776
2777 /**
Cynthia Wong278a8022009-07-10 13:27:03 -07002778 * Controls if the protocol buffer version of the protocol will use a multipart request for
2779 * attachment uploads. Value must be an integer where non-zero means true. Defaults to 0.
2780 */
2781 public static final String GMAIL_USE_MULTIPART_PROTOBUF = "gmail_use_multipart_protobuf";
2782
2783 /**
Wei Huangceca25f2009-06-19 13:08:39 -07002784 * the transcoder URL for mobile devices.
2785 */
2786 public static final String TRANSCODER_URL = "mobile_transcoder_url";
2787
2788 /**
2789 * URL that points to the privacy terms of the Google Talk service.
2790 */
Tom Taylor2c0a01a2009-06-22 15:17:59 -07002791 public static final String GTALK_TERMS_OF_SERVICE_URL = "gtalk_terms_of_service_url";
Wei Huangceca25f2009-06-19 13:08:39 -07002792
2793 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002794 * Hostname of the GTalk server.
2795 */
2796 public static final String GTALK_SERVICE_HOSTNAME = "gtalk_hostname";
2797
2798 /**
2799 * Secure port of the GTalk server.
2800 */
2801 public static final String GTALK_SERVICE_SECURE_PORT = "gtalk_secure_port";
2802
2803 /**
2804 * The server configurable RMQ acking interval
2805 */
2806 public static final String GTALK_SERVICE_RMQ_ACK_INTERVAL = "gtalk_rmq_ack_interval";
2807
2808 /**
2809 * The minimum reconnect delay for short network outages or when the network is suspended
2810 * due to phone use.
2811 */
2812 public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT =
2813 "gtalk_min_reconnect_delay_short";
2814
2815 /**
2816 * The reconnect variant range for short network outages or when the network is suspended
2817 * due to phone use. A random number between 0 and this constant is computed and
2818 * added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT} to form the initial reconnect
2819 * delay.
2820 */
2821 public static final String GTALK_SERVICE_RECONNECT_VARIANT_SHORT =
2822 "gtalk_reconnect_variant_short";
2823
2824 /**
2825 * The minimum reconnect delay for long network outages
2826 */
2827 public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG =
2828 "gtalk_min_reconnect_delay_long";
2829
2830 /**
2831 * The reconnect variant range for long network outages. A random number between 0 and this
2832 * constant is computed and added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG} to
2833 * form the initial reconnect delay.
2834 */
2835 public static final String GTALK_SERVICE_RECONNECT_VARIANT_LONG =
2836 "gtalk_reconnect_variant_long";
2837
2838 /**
2839 * The maximum reconnect delay time, in milliseconds.
2840 */
2841 public static final String GTALK_SERVICE_MAX_RECONNECT_DELAY =
2842 "gtalk_max_reconnect_delay";
2843
2844 /**
2845 * The network downtime that is considered "short" for the above calculations,
2846 * in milliseconds.
2847 */
2848 public static final String GTALK_SERVICE_SHORT_NETWORK_DOWNTIME =
2849 "gtalk_short_network_downtime";
2850
2851 /**
2852 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2853 * will reset the heartbeat timer. The away heartbeat should be used when the user is
2854 * logged into the GTalk app, but not actively using it.
2855 */
2856 public static final String GTALK_SERVICE_AWAY_HEARTBEAT_INTERVAL_MS =
2857 "gtalk_heartbeat_ping_interval_ms"; // keep the string backward compatible
2858
2859 /**
2860 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2861 * will reset the heartbeat timer. The active heartbeat should be used when the user is
2862 * actively using the GTalk app.
2863 */
2864 public static final String GTALK_SERVICE_ACTIVE_HEARTBEAT_INTERVAL_MS =
2865 "gtalk_active_heartbeat_ping_interval_ms";
2866
2867 /**
2868 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2869 * will reset the heartbeat timer. The sync heartbeat should be used when the user isn't
2870 * logged into the GTalk app, but auto-sync is enabled.
2871 */
2872 public static final String GTALK_SERVICE_SYNC_HEARTBEAT_INTERVAL_MS =
2873 "gtalk_sync_heartbeat_ping_interval_ms";
2874
2875 /**
2876 * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2877 * will reset the heartbeat timer. The no sync heartbeat should be used when the user isn't
2878 * logged into the GTalk app, and auto-sync is not enabled.
2879 */
2880 public static final String GTALK_SERVICE_NOSYNC_HEARTBEAT_INTERVAL_MS =
2881 "gtalk_nosync_heartbeat_ping_interval_ms";
2882
2883 /**
Tom Taylor2debd562009-07-14 11:27:20 -07002884 * The maximum heartbeat interval used while on the WIFI network.
Wei Huange87b2f02009-06-02 15:16:04 -07002885 */
2886 public static final String GTALK_SERVICE_WIFI_MAX_HEARTBEAT_INTERVAL_MS =
2887 "gtalk_wifi_max_heartbeat_ping_interval_ms";
2888
2889 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002890 * How long we wait to receive a heartbeat ping acknowledgement (or another packet)
2891 * from the GTalk server, before deeming the connection dead.
2892 */
2893 public static final String GTALK_SERVICE_HEARTBEAT_ACK_TIMEOUT_MS =
2894 "gtalk_heartbeat_ack_timeout_ms";
2895
2896 /**
2897 * How long after screen is turned off before we consider the user to be idle.
2898 */
2899 public static final String GTALK_SERVICE_IDLE_TIMEOUT_MS =
2900 "gtalk_idle_timeout_ms";
2901
2902 /**
2903 * By default, GTalkService will always connect to the server regardless of the auto-sync
2904 * setting. However, if this parameter is true, then GTalkService will only connect
2905 * if auto-sync is enabled. Using the GTalk app will trigger the connection too.
2906 */
2907 public static final String GTALK_SERVICE_CONNECT_ON_AUTO_SYNC =
2908 "gtalk_connect_on_auto_sync";
2909
2910 /**
2911 * GTalkService holds a wakelock while broadcasting the intent for data message received.
2912 * It then automatically release the wakelock after a timeout. This setting controls what
2913 * the timeout should be.
2914 */
2915 public static final String GTALK_DATA_MESSAGE_WAKELOCK_MS =
2916 "gtalk_data_message_wakelock_ms";
2917
2918 /**
2919 * The socket read timeout used to control how long ssl handshake wait for reads before
2920 * timing out. This is needed so the ssl handshake doesn't hang for a long time in some
2921 * circumstances.
2922 */
2923 public static final String GTALK_SSL_HANDSHAKE_TIMEOUT_MS =
2924 "gtalk_ssl_handshake_timeout_ms";
2925
2926 /**
Costin Manolachef967afd2009-04-17 17:37:29 -07002927 * Compress the gtalk stream.
2928 */
2929 public static final String GTALK_COMPRESS = "gtalk_compress";
2930
2931 /**
Wei Huang58eef7e2009-05-22 13:30:03 -07002932 * This is the timeout for which Google Talk will send the message using bareJID. In a
2933 * established chat between two XMPP endpoints, Google Talk uses fullJID in the format
2934 * of user@domain/resource in order to send the message to the specific client. However,
2935 * if Google Talk hasn't received a message from that client after some time, it would
2936 * fall back to use the bareJID, which would broadcast the message to all clients for
2937 * the other user.
2938 */
2939 public static final String GTALK_USE_BARE_JID_TIMEOUT_MS = "gtalk_use_barejid_timeout_ms";
2940
2941 /**
Ye Wen44c6e3e2009-06-19 12:48:16 -07002942 * This is the threshold of retry number when there is an authentication expired failure
2943 * for Google Talk. In some situation, e.g. when a Google Apps account is disabled chat
2944 * service, the connection keeps failing. This threshold controls when we should stop
2945 * the retrying.
2946 */
2947 public static final String GTALK_MAX_RETRIES_FOR_AUTH_EXPIRED =
Wei Huang1e4807a2009-07-29 18:50:00 -07002948 "gtalk_max_retries_for_auth_expired";
2949
2950 /**
2951 * a boolean setting indicating whether the GTalkService should use RMQ2 protocol or not.
2952 */
2953 public static final String GTALK_USE_RMQ2_PROTOCOL =
2954 "gtalk_use_rmq2";
2955
2956 /**
2957 * a boolean setting indicating whether the GTalkService should support both RMQ and
2958 * RMQ2 protocols. This setting is true for the transitional period when we need to
2959 * support both protocols.
2960 */
2961 public static final String GTALK_SUPPORT_RMQ_AND_RMQ2_PROTOCOLS =
2962 "gtalk_support_rmq_and_rmq2";
2963
2964 /**
2965 * a boolean setting controlling whether the rmq2 protocol will include stream ids in
2966 * the protobufs. This is used for debugging.
2967 */
2968 public static final String GTALK_RMQ2_INCLUDE_STREAM_ID =
2969 "gtalk_rmq2_include_stream_id";
2970
2971 /**
Wei Huang1abf4982009-08-21 07:56:36 -07002972 * when receiving a chat message from the server, the message could be an older message
2973 * whose "time sent" is x seconds from now. If x is significant enough, we want to flag
2974 * it so the UI can give it some special treatment when displaying the "time sent" for
2975 * it. This setting is to control what x is.
2976 */
Wei Huangcc6bd5a2009-08-24 14:29:44 -07002977 public static final String GTALK_OLD_CHAT_MESSAGE_THRESHOLD_IN_SEC =
2978 "gtalk_old_chat_msg_threshold_in_sec";
Wei Huang1abf4982009-08-21 07:56:36 -07002979
2980 /**
2981 * a setting to control the max connection history record GTalkService stores.
2982 */
2983 public static final String GTALK_MAX_CONNECTION_HISTORY_RECORDS =
2984 "gtalk_max_conn_history_records";
2985
2986 /**
Ye Wen0b98c942009-09-04 23:43:47 -07002987 * This is gdata url to lookup album and picture info from picasa web. It also controls
2988 * whether url scraping for picasa is enabled (NULL to disable).
Wei Huang1e4807a2009-07-29 18:50:00 -07002989 */
2990 public static final String GTALK_PICASA_ALBUM_URL =
2991 "gtalk_picasa_album_url";
2992
2993 /**
Ye Wen0b98c942009-09-04 23:43:47 -07002994 * This is the url to lookup picture info from flickr. It also controls
2995 * whether url scraping for flickr is enabled (NULL to disable).
Wei Huang1e4807a2009-07-29 18:50:00 -07002996 */
2997 public static final String GTALK_FLICKR_PHOTO_INFO_URL =
2998 "gtalk_flickr_photo_info_url";
2999
3000 /**
3001 * This is the url to lookup an actual picture from flickr.
3002 */
3003 public static final String GTALK_FLICKR_PHOTO_URL =
3004 "gtalk_flickr_photo_url";
3005
3006 /**
Ye Wen0b98c942009-09-04 23:43:47 -07003007 * This is the gdata url to lookup info on a youtube video. It also controls
3008 * whether url scraping for youtube is enabled (NULL to disable).
Wei Huang1e4807a2009-07-29 18:50:00 -07003009 */
3010 public static final String GTALK_YOUTUBE_VIDEO_URL =
3011 "gtalk_youtube_video_url";
Ye Wen44c6e3e2009-06-19 12:48:16 -07003012
3013 /**
Ye Wen0b98c942009-09-04 23:43:47 -07003014 * Enable/disable GTalk URL scraping for JPG images ("true" to enable).
3015 */
3016 public static final String GTALK_URL_SCRAPING_FOR_JPG =
3017 "gtalk_url_scraping_for_jpg";
3018
3019 /**
Ye Wen48f886e2009-08-26 12:21:08 -07003020 * Chat message lifetime (for pruning old chat messages).
3021 */
3022 public static final String GTALK_CHAT_MESSAGE_LIFETIME =
3023 "gtalk_chat_message_lifetime";
3024
3025 /**
3026 * OTR message lifetime (for pruning old otr messages).
3027 */
3028 public static final String GTALK_OTR_MESSAGE_LIFETIME =
3029 "gtalk_otr_message_lifetime";
3030
3031 /**
3032 * Chat expiration time, i.e., time since last message in the chat (for pruning old chats).
3033 */
3034 public static final String GTALK_CHAT_EXPIRATION_TIME =
3035 "gtalk_chat_expiration_time";
3036
3037 /**
Wei Huang1c5e4032009-07-09 10:39:12 -07003038 * This is the url for getting the app token for server-to-device push messaging.
Wei Huang8ad22462009-06-24 18:32:45 -07003039 */
Wei Huang1c5e4032009-07-09 10:39:12 -07003040 public static final String PUSH_MESSAGING_REGISTRATION_URL =
3041 "push_messaging_registration_url";
Tom Taylor2debd562009-07-14 11:27:20 -07003042
Ye Wen48f886e2009-08-26 12:21:08 -07003043 /**
3044 * Use android://&lt;it&gt; routing infos for Google Sync Server subcriptions.
3045 */
3046 public static final String GSYNC_USE_RMQ2_ROUTING_INFO = "gsync_use_rmq2_routing_info";
Debajit Ghoshc030a482009-08-10 21:59:25 -07003047
Wei Huang8ad22462009-06-24 18:32:45 -07003048 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003049 * Enable use of ssl session caching.
3050 * 'db' - save each session in a (per process) database
3051 * 'file' - save each session in a (per process) file
3052 * not set or any other value - normal java in-memory caching
3053 */
3054 public static final String SSL_SESSION_CACHE = "ssl_session_cache";
3055
3056 /**
3057 * How many bytes long a message has to be, in order to be gzipped.
3058 */
3059 public static final String SYNC_MIN_GZIP_BYTES =
3060 "sync_min_gzip_bytes";
3061
3062 /**
3063 * The hash value of the current provisioning settings
3064 */
3065 public static final String PROVISIONING_DIGEST = "digest";
3066
3067 /**
3068 * Provisioning keys to block from server update
3069 */
3070 public static final String PROVISIONING_OVERRIDE = "override";
3071
3072 /**
3073 * "Generic" service name for authentication requests.
3074 */
3075 public static final String GOOGLE_LOGIN_GENERIC_AUTH_SERVICE
3076 = "google_login_generic_auth_service";
3077
3078 /**
3079 * Frequency in milliseconds at which we should sync the locally installed Vending Machine
3080 * content with the server.
3081 */
3082 public static final String VENDING_SYNC_FREQUENCY_MS = "vending_sync_frequency_ms";
3083
3084 /**
3085 * Support URL that is opened in a browser when user clicks on 'Help and Info' in Vending
3086 * Machine.
3087 */
3088 public static final String VENDING_SUPPORT_URL = "vending_support_url";
3089
3090 /**
3091 * Indicates if Vending Machine requires a SIM to be in the phone to allow a purchase.
3092 *
3093 * true = SIM is required
3094 * false = SIM is not required
3095 */
3096 public static final String VENDING_REQUIRE_SIM_FOR_PURCHASE =
3097 "vending_require_sim_for_purchase";
3098
3099 /**
Christian Sonntag058779c2009-08-07 10:50:06 -07003100 * Indicates the Vending Machine backup state. It is set if the
3101 * Vending application has been backed up at least once.
3102 */
3103 public static final String VENDING_BACKUP_STATE = "vending_backup_state";
3104
3105 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003106 * The current version id of the Vending Machine terms of service.
3107 */
3108 public static final String VENDING_TOS_VERSION = "vending_tos_version";
3109
3110 /**
3111 * URL that points to the terms of service for Vending Machine.
3112 */
3113 public static final String VENDING_TOS_URL = "vending_tos_url";
3114
3115 /**
lknguyenf965d162009-07-22 18:12:56 -07003116 * URL to navigate to in browser (not Market) when the terms of service
3117 * for Vending Machine could not be accessed due to bad network
3118 * connection.
3119 */
3120 public static final String VENDING_TOS_MISSING_URL = "vending_tos_missing_url";
3121
3122 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003123 * Whether to use sierraqa instead of sierra tokens for the purchase flow in
3124 * Vending Machine.
3125 *
3126 * true = use sierraqa
3127 * false = use sierra (default)
3128 */
3129 public static final String VENDING_USE_CHECKOUT_QA_SERVICE =
3130 "vending_use_checkout_qa_service";
3131
3132 /**
Mark Womack78ef4562009-03-25 16:10:13 -07003133 * Default value to use for all/free/priced filter in Market.
3134 * Valid values: ALL, FREE, PAID (case insensitive)
3135 */
3136 public static final String VENDING_DEFAULT_FILTER = "vending_default_filter";
3137 /**
3138 * Ranking type value to use for the first category tab (currently popular)
3139 */
3140 public static final String VENDING_TAB_1_RANKING_TYPE = "vending_tab_1_ranking_type";
3141
3142 /**
3143 * Title string to use for first category tab.
3144 */
3145 public static final String VENDING_TAB_1_TITLE = "vending_tab_1_title";
3146
3147 /**
3148 * Ranking type value to use for the second category tab (currently newest)
3149 */
3150 public static final String VENDING_TAB_2_RANKING_TYPE = "vending_tab_2_ranking_type";
3151
3152 /**
3153 * Title string to use for second category tab.
3154 */
3155 public static final String VENDING_TAB_2_TITLE = "vending_tab_2_title";
3156
3157 /**
Linda Nguyenabd7eba2009-06-18 18:52:59 -07003158 * Frequency in milliseconds at which we should request MCS heartbeats
3159 * from the Vending Machine client.
3160 */
3161 public static final String VENDING_HEARTBEAT_FREQUENCY_MS =
3162 "vending_heartbeat_frequency_ms";
3163
3164 /**
lknguyenb0cba432009-06-29 20:50:25 -07003165 * Frequency in milliseconds at which we should resend pending download
3166 * requests to the API Server from the Vending Machine client.
3167 */
3168 public static final String VENDING_PENDING_DOWNLOAD_RESEND_FREQUENCY_MS =
lknguyen09b33732009-06-30 13:52:45 -07003169 "vending_pd_resend_frequency_ms";
lknguyenb0cba432009-06-29 20:50:25 -07003170
3171 /**
Jasperlnb95277e2009-08-17 13:29:11 -07003172 * Size of buffer in bytes for Vending to use when reading cache files.
3173 */
3174 public static final String VENDING_DISK_INPUT_BUFFER_BYTES =
3175 "vending_disk_input_buffer_bytes";
3176
3177 /**
3178 * Size of buffer in bytes for Vending to use when writing cache files.
3179 */
3180 public static final String VENDING_DISK_OUTPUT_BUFFER_BYTES =
3181 "vending_disk_output_buffer_bytes";
3182
3183 /**
Sanjay Jeyakumar21bf2412009-07-09 13:31:48 -07003184 * Frequency in milliseconds at which we should cycle through the promoted applications
3185 * on the home screen or the categories page.
3186 */
3187 public static final String VENDING_PROMO_REFRESH_FREQUENCY_MS =
3188 "vending_promo_refresh_freq_ms";
3189
3190 /**
Sanjay Jeyakumarebd84162009-08-26 16:01:08 -07003191 * Frequency in milliseconds when we should refresh the provisioning information from
3192 * the carrier backend.
3193 */
3194 public static final String VENDING_CARRIER_PROVISIONING_REFRESH_FREQUENCY_MS =
3195 "vending_carrier_ref_freq_ms";
3196
3197 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003198 * URL that points to the legal terms of service to display in Settings.
3199 * <p>
3200 * This should be a https URL. For a pretty user-friendly URL, use
3201 * {@link #SETTINGS_TOS_PRETTY_URL}.
3202 */
3203 public static final String SETTINGS_TOS_URL = "settings_tos_url";
3204
3205 /**
3206 * URL that points to the legal terms of service to display in Settings.
3207 * <p>
3208 * This should be a pretty http URL. For the URL the device will access
3209 * via Settings, use {@link #SETTINGS_TOS_URL}.
3210 */
3211 public static final String SETTINGS_TOS_PRETTY_URL = "settings_tos_pretty_url";
3212
3213 /**
3214 * URL that points to the contributors to display in Settings.
3215 * <p>
3216 * This should be a https URL. For a pretty user-friendly URL, use
3217 * {@link #SETTINGS_CONTRIBUTORS_PRETTY_URL}.
3218 */
3219 public static final String SETTINGS_CONTRIBUTORS_URL = "settings_contributors_url";
3220
3221 /**
3222 * URL that points to the contributors to display in Settings.
3223 * <p>
3224 * This should be a pretty http URL. For the URL the device will access
3225 * via Settings, use {@link #SETTINGS_CONTRIBUTORS_URL}.
3226 */
3227 public static final String SETTINGS_CONTRIBUTORS_PRETTY_URL =
3228 "settings_contributors_pretty_url";
3229
3230 /**
3231 * URL that points to the Terms Of Service for the device.
3232 * <p>
3233 * This should be a pretty http URL.
3234 */
3235 public static final String SETUP_GOOGLE_TOS_URL = "setup_google_tos_url";
3236
3237 /**
3238 * URL that points to the Android privacy policy for the device.
3239 * <p>
3240 * This should be a pretty http URL.
3241 */
3242 public static final String SETUP_ANDROID_PRIVACY_URL = "setup_android_privacy_url";
3243
3244 /**
3245 * URL that points to the Google privacy policy for the device.
3246 * <p>
3247 * This should be a pretty http URL.
3248 */
3249 public static final String SETUP_GOOGLE_PRIVACY_URL = "setup_google_privacy_url";
3250
3251 /**
3252 * Request an MSISDN token for various Google services.
3253 */
3254 public static final String USE_MSISDN_TOKEN = "use_msisdn_token";
3255
3256 /**
3257 * RSA public key used to encrypt passwords stored in the database.
3258 */
3259 public static final String GLS_PUBLIC_KEY = "google_login_public_key";
3260
3261 /**
3262 * Only check parental control status if this is set to "true".
3263 */
3264 public static final String PARENTAL_CONTROL_CHECK_ENABLED =
3265 "parental_control_check_enabled";
3266
3267 /**
3268 * The list of applications we need to block if parental control is
3269 * enabled.
3270 */
3271 public static final String PARENTAL_CONTROL_APPS_LIST =
3272 "parental_control_apps_list";
3273
3274 /**
3275 * Duration in which parental control status is valid.
3276 */
3277 public static final String PARENTAL_CONTROL_TIMEOUT_IN_MS =
3278 "parental_control_timeout_in_ms";
3279
3280 /**
3281 * When parental control is off, we expect to get this string from the
3282 * litmus url.
3283 */
3284 public static final String PARENTAL_CONTROL_EXPECTED_RESPONSE =
3285 "parental_control_expected_response";
3286
3287 /**
3288 * When the litmus url returns a 302, declare parental control to be on
3289 * only if the redirect url matches this regular expression.
3290 */
3291 public static final String PARENTAL_CONTROL_REDIRECT_REGEX =
3292 "parental_control_redirect_regex";
3293
3294 /**
3295 * Threshold for the amount of change in disk free space required to report the amount of
3296 * free space. Used to prevent spamming the logs when the disk free space isn't changing
3297 * frequently.
3298 */
3299 public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
3300 "disk_free_change_reporting_threshold";
3301
3302 /**
3303 * Prefix for new Google services published by the checkin
3304 * server.
3305 */
3306 public static final String GOOGLE_SERVICES_PREFIX
3307 = "google_services:";
3308
3309 /**
3310 * The maximum reconnect delay for short network outages or when the network is suspended
3311 * due to phone use.
3312 */
3313 public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
3314 "sync_max_retry_delay_in_seconds";
3315
3316 /**
3317 * Minimum percentage of free storage on the device that is used to determine if
3318 * the device is running low on storage.
3319 * Say this value is set to 10, the device is considered running low on storage
3320 * if 90% or more of the device storage is filled up.
3321 */
3322 public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
3323 "sys_storage_threshold_percentage";
3324
3325 /**
3326 * The interval in minutes after which the amount of free storage left on the
3327 * device is logged to the event log
3328 */
3329 public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
3330 "sys_free_storage_log_interval";
3331
3332 /**
3333 * The interval in milliseconds at which to check the number of SMS sent
3334 * out without asking for use permit, to limit the un-authorized SMS
3335 * usage.
3336 */
jsh867641e2009-05-27 17:32:50 -07003337 public static final String SMS_OUTGOING_CHECK_INTERVAL_MS =
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003338 "sms_outgoing_check_interval_ms";
3339
3340 /**
3341 * The number of outgoing SMS sent without asking for user permit
jsh867641e2009-05-27 17:32:50 -07003342 * (of {@link #SMS_OUTGOING_CHECK_INTERVAL_MS}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003343 */
3344 public static final String SMS_OUTGOING_CEHCK_MAX_COUNT =
3345 "sms_outgoing_check_max_count";
3346
3347 /**
3348 * The interval in milliseconds at which to check packet counts on the
3349 * mobile data interface when screen is on, to detect possible data
3350 * connection problems.
3351 */
3352 public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
3353 "pdp_watchdog_poll_interval_ms";
3354
3355 /**
3356 * The interval in milliseconds at which to check packet counts on the
3357 * mobile data interface when screen is off, to detect possible data
3358 * connection problems.
3359 */
3360 public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
3361 "pdp_watchdog_long_poll_interval_ms";
3362
3363 /**
3364 * The interval in milliseconds at which to check packet counts on the
3365 * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
3366 * outgoing packets has been reached without incoming packets.
3367 */
3368 public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
3369 "pdp_watchdog_error_poll_interval_ms";
3370
3371 /**
3372 * The number of outgoing packets sent without seeing an incoming packet
3373 * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
3374 * device is logged to the event log
3375 */
3376 public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
3377 "pdp_watchdog_trigger_packet_count";
3378
3379 /**
3380 * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
3381 * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
3382 * attempting data connection recovery.
3383 */
3384 public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
3385 "pdp_watchdog_error_poll_count";
3386
3387 /**
3388 * The number of failed PDP reset attempts before moving to something more
3389 * drastic: re-registering to the network.
3390 */
3391 public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
3392 "pdp_watchdog_max_pdp_reset_fail_count";
3393
3394 /**
3395 * Address to ping as a last sanity check before attempting any recovery.
3396 * Unset or set to "0.0.0.0" to skip this check.
3397 */
3398 public static final String PDP_WATCHDOG_PING_ADDRESS = "pdp_watchdog_ping_address";
3399
3400 /**
3401 * The "-w deadline" parameter for the ping, ie, the max time in
3402 * seconds to spend pinging.
3403 */
3404 public static final String PDP_WATCHDOG_PING_DEADLINE = "pdp_watchdog_ping_deadline";
3405
3406 /**
3407 * The interval in milliseconds at which to check gprs registration
3408 * after the first registration mismatch of gprs and voice service,
3409 * to detect possible data network registration problems.
3410 *
3411 */
3412 public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
3413 "gprs_register_check_period_ms";
3414
3415 /**
3416 * The interval in milliseconds after which Wi-Fi is considered idle.
3417 * When idle, it is possible for the device to be switched from Wi-Fi to
3418 * the mobile data network.
3419 */
3420 public static final String WIFI_IDLE_MS = "wifi_idle_ms";
3421
3422 /**
3423 * Screen timeout in milliseconds corresponding to the
3424 * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
3425 * possible screen timeout behavior.)
3426 */
3427 public static final String SHORT_KEYLIGHT_DELAY_MS =
3428 "short_keylight_delay_ms";
3429
3430 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003431 * List of test suites (local disk filename) for the automatic instrumentation test runner.
3432 * The file format is similar to automated_suites.xml, see AutoTesterService.
3433 * If this setting is missing or empty, the automatic test runner will not start.
3434 */
3435 public static final String AUTOTEST_SUITES_FILE = "autotest_suites_file";
3436
3437 /**
3438 * Interval between synchronous checkins forced by the automatic test runner.
3439 * If you set this to a value smaller than CHECKIN_INTERVAL, then the test runner's
3440 * frequent checkins will prevent asynchronous background checkins from interfering
3441 * with any performance measurements.
3442 */
3443 public static final String AUTOTEST_CHECKIN_SECONDS = "autotest_checkin_seconds";
3444
3445 /**
3446 * Interval between reboots forced by the automatic test runner.
3447 */
3448 public static final String AUTOTEST_REBOOT_SECONDS = "autotest_reboot_seconds";
3449
3450
3451 /**
3452 * Threshold values for the duration and level of a discharge cycle, under
3453 * which we log discharge cycle info.
3454 */
3455 public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
3456 "battery_discharge_duration_threshold";
3457 public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003458
The Android Open Source Project4df24232009-03-05 14:34:35 -08003459 /**
3460 * An email address that anr bugreports should be sent to.
3461 */
3462 public static final String ANR_BUGREPORT_RECIPIENT = "anr_bugreport_recipient";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003463
3464 /**
Amith Yamasani430555ac2009-06-11 22:35:39 -07003465 * Flag for allowing service provider to use location information to improve products and
3466 * services.
3467 * Type: int ( 0 = disallow, 1 = allow )
Amith Yamasani630cd062009-06-19 12:07:02 -07003468 * @deprecated
Amith Yamasani430555ac2009-06-11 22:35:39 -07003469 */
3470 public static final String USE_LOCATION_FOR_SERVICES = "use_location";
3471
3472 /**
Ken Shirriff326580d2009-08-10 14:21:46 -07003473 * The length of the calendar sync window into the future.
3474 * This specifies the number of days into the future for the sliding window sync.
3475 * Setting this to zero will disable sliding sync.
3476 */
3477 public static final String GOOGLE_CALENDAR_SYNC_WINDOW_DAYS =
3478 "google_calendar_sync_window_days";
3479
3480 /**
Ken Shirrifff0f13ae2009-08-20 13:19:14 -07003481 * How often to update the calendar sync window.
3482 * The window will be advanced every n days.
3483 */
3484 public static final String GOOGLE_CALENDAR_SYNC_WINDOW_UPDATE_DAYS =
3485 "google_calendar_sync_window_update_days";
3486
3487 /**
Bjorn Bringert96f86132009-09-04 12:01:53 +01003488 * The number of promoted sources in GlobalSearch.
3489 */
3490 public static final String SEARCH_NUM_PROMOTED_SOURCES = "search_num_promoted_sources";
3491 /**
3492 * The maximum number of suggestions returned by GlobalSearch.
3493 */
3494 public static final String SEARCH_MAX_RESULTS_TO_DISPLAY = "search_max_results_to_display";
3495 /**
3496 * The number of suggestions GlobalSearch will ask each non-web search source for.
3497 */
3498 public static final String SEARCH_MAX_RESULTS_PER_SOURCE = "search_max_results_per_source";
3499 /**
3500 * The number of suggestions the GlobalSearch will ask the web search source for.
3501 */
3502 public static final String SEARCH_WEB_RESULTS_OVERRIDE_LIMIT =
3503 "search_web_results_override_limit";
3504 /**
3505 * The number of milliseconds that GlobalSearch will wait for suggestions from
3506 * promoted sources before continuing with all other sources.
3507 */
3508 public static final String SEARCH_PROMOTED_SOURCE_DEADLINE_MILLIS =
3509 "search_promoted_source_deadline_millis";
3510 /**
3511 * The number of milliseconds before GlobalSearch aborts search suggesiton queries.
3512 */
3513 public static final String SEARCH_SOURCE_TIMEOUT_MILLIS = "search_source_timeout_millis";
3514 /**
3515 * The maximum number of milliseconds that GlobalSearch shows the previous results
3516 * after receiving a new query.
3517 */
3518 public static final String SEARCH_PREFILL_MILLIS = "search_prefill_millis";
3519 /**
3520 * The maximum age of log data used for shortcuts in GlobalSearch.
3521 */
3522 public static final String SEARCH_MAX_STAT_AGE_MILLIS = "search_max_stat_age_millis";
3523 /**
3524 * The maximum age of log data used for source ranking in GlobalSearch.
3525 */
3526 public static final String SEARCH_MAX_SOURCE_EVENT_AGE_MILLIS =
3527 "search_max_source_event_age_millis";
3528 /**
3529 * The minimum number of impressions needed to rank a source in GlobalSearch.
3530 */
3531 public static final String SEARCH_MIN_IMPRESSIONS_FOR_SOURCE_RANKING =
3532 "search_min_impressions_for_source_ranking";
3533 /**
3534 * The minimum number of clicks needed to rank a source in GlobalSearch.
3535 */
3536 public static final String SEARCH_MIN_CLICKS_FOR_SOURCE_RANKING =
3537 "search_min_clicks_for_source_ranking";
3538 /**
3539 * The maximum number of shortcuts shown by GlobalSearch.
3540 */
3541 public static final String SEARCH_MAX_SHORTCUTS_RETURNED = "search_max_shortcuts_returned";
3542 /**
3543 * The size of the core thread pool for suggestion queries in GlobalSearch.
3544 */
3545 public static final String SEARCH_QUERY_THREAD_CORE_POOL_SIZE =
3546 "search_query_thread_core_pool_size";
3547 /**
3548 * The maximum size of the thread pool for suggestion queries in GlobalSearch.
3549 */
3550 public static final String SEARCH_QUERY_THREAD_MAX_POOL_SIZE =
3551 "search_query_thread_max_pool_size";
3552 /**
3553 * The size of the core thread pool for shortcut refreshing in GlobalSearch.
3554 */
3555 public static final String SEARCH_SHORTCUT_REFRESH_CORE_POOL_SIZE =
3556 "search_shortcut_refresh_core_pool_size";
3557 /**
3558 * The maximum size of the thread pool for shortcut refreshing in GlobalSearch.
3559 */
3560 public static final String SEARCH_SHORTCUT_REFRESH_MAX_POOL_SIZE =
3561 "search_shortcut_refresh_max_pool_size";
3562 /**
3563 * The maximun time that excess threads in the GlobalSeach thread pools will
3564 * wait before terminating.
3565 */
3566 public static final String SEARCH_THREAD_KEEPALIVE_SECONDS =
3567 "search_thread_keepalive_seconds";
3568 /**
3569 * The maximum number of concurrent suggestion queries to each source.
3570 */
3571 public static final String SEARCH_PER_SOURCE_CONCURRENT_QUERY_LIMIT =
3572 "search_per_source_concurrent_query_limit";
3573
3574 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003575 * @deprecated
3576 * @hide
3577 */
3578 @Deprecated // Obviated by NameValueCache: just fetch the value directly.
3579 public static class QueryMap extends ContentQueryMap {
3580
3581 public QueryMap(ContentResolver contentResolver, Cursor cursor, boolean keepUpdated,
3582 Handler handlerForUpdateNotifications) {
3583 super(cursor, NAME, keepUpdated, handlerForUpdateNotifications);
3584 }
3585
3586 public QueryMap(ContentResolver contentResolver, boolean keepUpdated,
3587 Handler handlerForUpdateNotifications) {
3588 this(contentResolver,
3589 contentResolver.query(CONTENT_URI, null, null, null, null),
3590 keepUpdated, handlerForUpdateNotifications);
3591 }
3592
3593 public String getString(String name) {
3594 ContentValues cv = getValues(name);
3595 if (cv == null) return null;
3596 return cv.getAsString(VALUE);
3597 }
3598 }
3599
3600 }
3601
3602 /**
3603 * User-defined bookmarks and shortcuts. The target of each bookmark is an
3604 * Intent URL, allowing it to be either a web page or a particular
3605 * application activity.
3606 *
3607 * @hide
3608 */
3609 public static final class Bookmarks implements BaseColumns
3610 {
3611 private static final String TAG = "Bookmarks";
3612
3613 /**
3614 * The content:// style URL for this table
3615 */
3616 public static final Uri CONTENT_URI =
3617 Uri.parse("content://" + AUTHORITY + "/bookmarks");
3618
3619 /**
3620 * The row ID.
3621 * <p>Type: INTEGER</p>
3622 */
3623 public static final String ID = "_id";
3624
3625 /**
3626 * Descriptive name of the bookmark that can be displayed to the user.
3627 * If this is empty, the title should be resolved at display time (use
3628 * {@link #getTitle(Context, Cursor)} any time you want to display the
3629 * title of a bookmark.)
3630 * <P>
3631 * Type: TEXT
3632 * </P>
3633 */
3634 public static final String TITLE = "title";
3635
3636 /**
3637 * Arbitrary string (displayed to the user) that allows bookmarks to be
3638 * organized into categories. There are some special names for
3639 * standard folders, which all start with '@'. The label displayed for
3640 * the folder changes with the locale (via {@link #getLabelForFolder}) but
3641 * the folder name does not change so you can consistently query for
3642 * the folder regardless of the current locale.
3643 *
3644 * <P>Type: TEXT</P>
3645 *
3646 */
3647 public static final String FOLDER = "folder";
3648
3649 /**
3650 * The Intent URL of the bookmark, describing what it points to. This
3651 * value is given to {@link android.content.Intent#getIntent} to create
3652 * an Intent that can be launched.
3653 * <P>Type: TEXT</P>
3654 */
3655 public static final String INTENT = "intent";
3656
3657 /**
3658 * Optional shortcut character associated with this bookmark.
3659 * <P>Type: INTEGER</P>
3660 */
3661 public static final String SHORTCUT = "shortcut";
3662
3663 /**
3664 * The order in which the bookmark should be displayed
3665 * <P>Type: INTEGER</P>
3666 */
3667 public static final String ORDERING = "ordering";
3668
3669 private static final String[] sIntentProjection = { INTENT };
3670 private static final String[] sShortcutProjection = { ID, SHORTCUT };
3671 private static final String sShortcutSelection = SHORTCUT + "=?";
3672
3673 /**
3674 * Convenience function to retrieve the bookmarked Intent for a
3675 * particular shortcut key.
3676 *
3677 * @param cr The ContentResolver to query.
3678 * @param shortcut The shortcut key.
3679 *
3680 * @return Intent The bookmarked URL, or null if there is no bookmark
3681 * matching the given shortcut.
3682 */
3683 public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3684 {
3685 Intent intent = null;
3686
3687 Cursor c = cr.query(CONTENT_URI,
3688 sIntentProjection, sShortcutSelection,
3689 new String[] { String.valueOf((int) shortcut) }, ORDERING);
3690 // Keep trying until we find a valid shortcut
3691 try {
3692 while (intent == null && c.moveToNext()) {
3693 try {
3694 String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
3695 intent = Intent.getIntent(intentURI);
3696 } catch (java.net.URISyntaxException e) {
3697 // The stored URL is bad... ignore it.
3698 } catch (IllegalArgumentException e) {
3699 // Column not found
3700 Log.e(TAG, "Intent column not found", e);
3701 }
3702 }
3703 } finally {
3704 if (c != null) c.close();
3705 }
3706
3707 return intent;
3708 }
3709
3710 /**
3711 * Add a new bookmark to the system.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003712 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003713 * @param cr The ContentResolver to query.
3714 * @param intent The desired target of the bookmark.
3715 * @param title Bookmark title that is shown to the user; null if none
3716 * or it should be resolved to the intent's title.
3717 * @param folder Folder in which to place the bookmark; null if none.
3718 * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3719 * this is non-zero and there is an existing bookmark entry
3720 * with this same shortcut, then that existing shortcut is
3721 * cleared (the bookmark is not removed).
3722 * @return The unique content URL for the new bookmark entry.
3723 */
3724 public static Uri add(ContentResolver cr,
3725 Intent intent,
3726 String title,
3727 String folder,
3728 char shortcut,
3729 int ordering)
3730 {
3731 // If a shortcut is supplied, and it is already defined for
3732 // another bookmark, then remove the old definition.
3733 if (shortcut != 0) {
3734 Cursor c = cr.query(CONTENT_URI,
3735 sShortcutProjection, sShortcutSelection,
3736 new String[] { String.valueOf((int) shortcut) }, null);
3737 try {
3738 if (c.moveToFirst()) {
3739 while (c.getCount() > 0) {
3740 if (!c.deleteRow()) {
3741 Log.w(TAG, "Could not delete existing shortcut row");
3742 }
3743 }
3744 }
3745 } finally {
3746 if (c != null) c.close();
3747 }
3748 }
3749
3750 ContentValues values = new ContentValues();
3751 if (title != null) values.put(TITLE, title);
3752 if (folder != null) values.put(FOLDER, folder);
3753 values.put(INTENT, intent.toURI());
3754 if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3755 values.put(ORDERING, ordering);
3756 return cr.insert(CONTENT_URI, values);
3757 }
3758
3759 /**
3760 * Return the folder name as it should be displayed to the user. This
3761 * takes care of localizing special folders.
3762 *
3763 * @param r Resources object for current locale; only need access to
3764 * system resources.
3765 * @param folder The value found in the {@link #FOLDER} column.
3766 *
3767 * @return CharSequence The label for this folder that should be shown
3768 * to the user.
3769 */
3770 public static CharSequence getLabelForFolder(Resources r, String folder) {
3771 return folder;
3772 }
3773
3774 /**
3775 * Return the title as it should be displayed to the user. This takes
3776 * care of localizing bookmarks that point to activities.
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003777 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003778 * @param context A context.
3779 * @param cursor A cursor pointing to the row whose title should be
3780 * returned. The cursor must contain at least the {@link #TITLE}
3781 * and {@link #INTENT} columns.
3782 * @return A title that is localized and can be displayed to the user,
3783 * or the empty string if one could not be found.
3784 */
3785 public static CharSequence getTitle(Context context, Cursor cursor) {
3786 int titleColumn = cursor.getColumnIndex(TITLE);
3787 int intentColumn = cursor.getColumnIndex(INTENT);
3788 if (titleColumn == -1 || intentColumn == -1) {
3789 throw new IllegalArgumentException(
3790 "The cursor must contain the TITLE and INTENT columns.");
3791 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003792
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003793 String title = cursor.getString(titleColumn);
3794 if (!TextUtils.isEmpty(title)) {
3795 return title;
3796 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003797
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003798 String intentUri = cursor.getString(intentColumn);
3799 if (TextUtils.isEmpty(intentUri)) {
3800 return "";
3801 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003802
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003803 Intent intent;
3804 try {
3805 intent = Intent.getIntent(intentUri);
3806 } catch (URISyntaxException e) {
3807 return "";
3808 }
Jaikumar Ganesh9bfbfbd2009-05-15 12:05:56 -07003809
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003810 PackageManager packageManager = context.getPackageManager();
3811 ResolveInfo info = packageManager.resolveActivity(intent, 0);
3812 return info != null ? info.loadLabel(packageManager) : "";
3813 }
3814 }
3815
3816 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003817 * Returns the device ID that we should use when connecting to the mobile gtalk server.
3818 * This is a string like "android-0x1242", where the hex string is the Android ID obtained
3819 * from the GoogleLoginService.
3820 *
3821 * @param androidId The Android ID for this device.
3822 * @return The device ID that should be used when connecting to the mobile gtalk server.
3823 * @hide
3824 */
3825 public static String getGTalkDeviceId(long androidId) {
3826 return "android-" + Long.toHexString(androidId);
3827 }
3828}