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