1 /* 2 * Copyright (C) 2015 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 17 package com.android.systemui; 18 19 import android.annotation.StringDef; 20 import android.content.Context; 21 import android.content.SharedPreferences; 22 import android.content.SharedPreferences.OnSharedPreferenceChangeListener; 23 24 import com.android.systemui.settings.UserContextProvider; 25 26 import java.lang.annotation.Retention; 27 import java.lang.annotation.RetentionPolicy; 28 import java.util.Map; 29 import java.util.Set; 30 31 /** 32 * A helper class to store simple preferences for SystemUI. Its main use case is things such as 33 * feature education, e.g. "has the user seen this tooltip". 34 * 35 * As of this writing, feature education settings are *intentionally exempted* from backup and 36 * restore because there is not a great way to know which subset of features the user _should_ see 37 * again if, for instance, they are coming from multiple OSes back or switching OEMs. 38 * 39 * NOTE: Clients of this class should take care to pass in the correct user context when querying 40 * settings, otherwise you will always read/write for user 0 which is almost never what you want. 41 * See {@link UserContextProvider} for a simple way to get the current context 42 */ 43 public final class Prefs { Prefs()44 private Prefs() {} // no instantation 45 46 @Retention(RetentionPolicy.SOURCE) 47 @StringDef({ 48 Key.OVERVIEW_LAST_STACK_TASK_ACTIVE_TIME, 49 Key.DEBUG_MODE_ENABLED, 50 Key.HOTSPOT_TILE_LAST_USED, 51 Key.COLOR_INVERSION_TILE_LAST_USED, 52 Key.DND_TILE_VISIBLE, 53 Key.DND_TILE_COMBINED_ICON, 54 Key.DND_CONFIRMED_PRIORITY_INTRODUCTION, 55 Key.DND_CONFIRMED_SILENCE_INTRODUCTION, 56 Key.DND_FAVORITE_BUCKET_INDEX, 57 Key.DND_NONE_SELECTED, 58 Key.DND_FAVORITE_ZEN, 59 Key.QS_HOTSPOT_ADDED, 60 Key.QS_DATA_SAVER_ADDED, 61 Key.QS_DATA_SAVER_DIALOG_SHOWN, 62 Key.QS_INVERT_COLORS_ADDED, 63 Key.QS_WORK_ADDED, 64 Key.QS_NIGHTDISPLAY_ADDED, 65 Key.QS_LONG_PRESS_TOOLTIP_SHOWN_COUNT, 66 Key.SEEN_MULTI_USER, 67 Key.SEEN_RINGER_GUIDANCE_COUNT, 68 Key.QS_HAS_TURNED_OFF_MOBILE_DATA, 69 Key.TOUCHED_RINGER_TOGGLE, 70 Key.HAS_SEEN_ODI_CAPTIONS_TOOLTIP, 71 Key.HAS_SEEN_REVERSE_BOTTOM_SHEET, 72 Key.CONTROLS_STRUCTURE_SWIPE_TOOLTIP_COUNT, 73 Key.HAS_SEEN_ACCESSIBILITY_FLOATING_MENU_DOCK_TOOLTIP, 74 Key.ACCESSIBILITY_FLOATING_MENU_POSITION 75 }) 76 // TODO: annotate these with their types so {@link PrefsCommandLine} can know how to set them 77 public @interface Key { 78 @Deprecated 79 String OVERVIEW_LAST_STACK_TASK_ACTIVE_TIME = "OverviewLastStackTaskActiveTime"; 80 String DEBUG_MODE_ENABLED = "debugModeEnabled"; 81 String HOTSPOT_TILE_LAST_USED = "HotspotTileLastUsed"; 82 String COLOR_INVERSION_TILE_LAST_USED = "ColorInversionTileLastUsed"; 83 String DND_TILE_VISIBLE = "DndTileVisible"; 84 String DND_TILE_COMBINED_ICON = "DndTileCombinedIcon"; 85 String DND_CONFIRMED_PRIORITY_INTRODUCTION = "DndConfirmedPriorityIntroduction"; 86 String DND_CONFIRMED_SILENCE_INTRODUCTION = "DndConfirmedSilenceIntroduction"; 87 String DND_CONFIRMED_ALARM_INTRODUCTION = "DndConfirmedAlarmIntroduction"; 88 String DND_FAVORITE_BUCKET_INDEX = "DndCountdownMinuteIndex"; 89 String DND_NONE_SELECTED = "DndNoneSelected"; 90 String DND_FAVORITE_ZEN = "DndFavoriteZen"; 91 String QS_DATA_SAVER_DIALOG_SHOWN = "QsDataSaverDialogShown"; 92 @Deprecated 93 String QS_HOTSPOT_ADDED = "QsHotspotAdded"; 94 @Deprecated 95 String QS_DATA_SAVER_ADDED = "QsDataSaverAdded"; 96 @Deprecated 97 String QS_INVERT_COLORS_ADDED = "QsInvertColorsAdded"; 98 @Deprecated 99 String QS_WORK_ADDED = "QsWorkAdded"; 100 @Deprecated 101 String QS_NIGHTDISPLAY_ADDED = "QsNightDisplayAdded"; 102 /** 103 * Used for tracking how many times the user has seen the long press tooltip in the Quick 104 * Settings panel. 105 */ 106 String QS_LONG_PRESS_TOOLTIP_SHOWN_COUNT = "QsLongPressTooltipShownCount"; 107 String SEEN_MULTI_USER = "HasSeenMultiUser"; 108 String SEEN_RINGER_GUIDANCE_COUNT = "RingerGuidanceCount"; 109 String QS_TILE_SPECS_REVEALED = "QsTileSpecsRevealed"; 110 String QS_HAS_TURNED_OFF_MOBILE_DATA = "QsHasTurnedOffMobileData"; 111 String TOUCHED_RINGER_TOGGLE = "TouchedRingerToggle"; 112 String HAS_SEEN_ODI_CAPTIONS_TOOLTIP = "HasSeenODICaptionsTooltip"; 113 String HAS_SEEN_REVERSE_BOTTOM_SHEET = "HasSeenReverseBottomSheet"; 114 String CONTROLS_STRUCTURE_SWIPE_TOOLTIP_COUNT = "ControlsStructureSwipeTooltipCount"; 115 String HAS_SEEN_ACCESSIBILITY_FLOATING_MENU_DOCK_TOOLTIP = 116 "HasSeenAccessibilityFloatingMenuDockTooltip"; 117 String ACCESSIBILITY_FLOATING_MENU_POSITION = "AccessibilityFloatingMenuPosition"; 118 } 119 getBoolean(Context context, @Key String key, boolean defaultValue)120 public static boolean getBoolean(Context context, @Key String key, boolean defaultValue) { 121 return get(context).getBoolean(key, defaultValue); 122 } 123 putBoolean(Context context, @Key String key, boolean value)124 public static void putBoolean(Context context, @Key String key, boolean value) { 125 get(context).edit().putBoolean(key, value).apply(); 126 } 127 getInt(Context context, @Key String key, int defaultValue)128 public static int getInt(Context context, @Key String key, int defaultValue) { 129 return get(context).getInt(key, defaultValue); 130 } 131 putInt(Context context, @Key String key, int value)132 public static void putInt(Context context, @Key String key, int value) { 133 get(context).edit().putInt(key, value).apply(); 134 } 135 getLong(Context context, @Key String key, long defaultValue)136 public static long getLong(Context context, @Key String key, long defaultValue) { 137 return get(context).getLong(key, defaultValue); 138 } 139 putLong(Context context, @Key String key, long value)140 public static void putLong(Context context, @Key String key, long value) { 141 get(context).edit().putLong(key, value).apply(); 142 } 143 getString(Context context, @Key String key, String defaultValue)144 public static String getString(Context context, @Key String key, String defaultValue) { 145 return get(context).getString(key, defaultValue); 146 } 147 putString(Context context, @Key String key, String value)148 public static void putString(Context context, @Key String key, String value) { 149 get(context).edit().putString(key, value).apply(); 150 } 151 putStringSet(Context context, @Key String key, Set<String> value)152 public static void putStringSet(Context context, @Key String key, Set<String> value) { 153 get(context).edit().putStringSet(key, value).apply(); 154 } 155 getStringSet( Context context, @Key String key, Set<String> defaultValue)156 public static Set<String> getStringSet( 157 Context context, @Key String key, Set<String> defaultValue) { 158 return get(context).getStringSet(key, defaultValue); 159 } 160 getAll(Context context)161 public static Map<String, ?> getAll(Context context) { 162 return get(context).getAll(); 163 } 164 remove(Context context, @Key String key)165 public static void remove(Context context, @Key String key) { 166 get(context).edit().remove(key).apply(); 167 } 168 registerListener(Context context, OnSharedPreferenceChangeListener listener)169 public static void registerListener(Context context, 170 OnSharedPreferenceChangeListener listener) { 171 get(context).registerOnSharedPreferenceChangeListener(listener); 172 } 173 unregisterListener(Context context, OnSharedPreferenceChangeListener listener)174 public static void unregisterListener(Context context, 175 OnSharedPreferenceChangeListener listener) { 176 get(context).unregisterOnSharedPreferenceChangeListener(listener); 177 } 178 get(Context context)179 public static SharedPreferences get(Context context) { 180 return context.getSharedPreferences(context.getPackageName(), Context.MODE_PRIVATE); 181 } 182 } 183