सेटिंग खोज आपको तेज़ी और आसानी से किसी खास चीज़ को खोजने और बदलने की सुविधा देती है Automotive Settings ऐप्लिकेशन की सेटिंग उसे ढूंढें. खोज, कोई खास सेटिंग ढूंढने का सबसे असरदार तरीका है. डिफ़ॉल्ट रूप से, खोज में सिर्फ़ एओएसपी सेटिंग दिखती हैं. अतिरिक्त सेटिंग, चाहे इंजेक्ट की गई हो या नहीं, इंडेक्स किए जाने के लिए, कुछ और बदलाव करने की ज़रूरत होती है.
ज़रूरी शर्तें
किसी सेटिंग को 'सेटिंग' के खोज नतीजों में इंडेक्स करने के लिए, डेटा इनमें से होना चाहिए:
CarSettings
मेंSearchIndexable
फ़्रैगमेंट.- सिस्टम-लेवल का ऐप्लिकेशन.
डेटा तय करना
सामान्य फ़ील्ड:
Key
. (ज़रूरी है) नतीजे की पहचान करने के लिए, ऐसी स्ट्रिंग कुंजी होनी चाहिए जिसे कोई भी व्यक्ति आसानी से पढ़ सके.IconResId
. ज़रूरी नहीं अगर आपके ऐप्लिकेशन में इसके आगे कोई आइकॉन दिखता है नतीजा खोजें, फिर संसाधन आईडी जोड़ें, नहीं तो इसे अनदेखा करें.IntentAction
. ज़रूरी है अगरIntentTargetPackage
याIntentTargetClass
के बारे में नहीं बताया गया है. इससे पता चलता है कि खोज के नतीजे में क्या कार्रवाई होगी लेने का इरादा है.IntentTargetPackage
. अगरIntentAction
नहीं है, तो ज़रूरी है तय किया गया है. उस पैकेज के बारे में बताता है जिसे खोज के नतीजे में दिखाने का मकसद हल करना है.IntentTargetClass
. अगरIntentAction
नहीं है, तो ज़रूरी है तय किया गया है. इससे उस क्लास (गतिविधि) के बारे में पता चलता है जिसका इस्तेमाल खोज नतीजों में किया जाना है.
सिर्फ़ SearchIndexableResource
:
XmlResId
. (ज़रूरी है) यह शामिल करने वाले पेज के एक्सएमएल रिसॉर्स आईडी के बारे में बताता है इंडेक्स किए जाने वाले नतीजे दिखते हैं.
सिर्फ़ SearchIndexableRaw
:
Title
. (ज़रूरी है) खोज के नतीजे का टाइटल.SummaryOn
. (ज़रूरी नहीं) खोज के नतीजे के बारे में खास जानकारी.Keywords
. (ज़रूरी नहीं) खोज के नतीजे से जुड़े शब्दों की सूची. आपके नतीजे से क्वेरी का मिलान करता है.ScreenTitle
. (ज़रूरी नहीं) खोज के नतीजे वाले पेज का टाइटल.
डेटा छिपाएं
खोज के हर नतीजे को Search में तब तक दिखाया जाता है, जब तक उसे किसी दूसरे तरीके से मार्क न किया गया हो. स्टैटिक होने पर खोज के नतीजों को कैश मेमोरी में सेव किया जाता है और हर बार इंडेक्स न की जा सकने वाली कुंजियों की नई सूची को वापस लाया जाता है खोज बार खुलता है. नतीजे छिपाने की वजहें ये हो सकती हैं:
- डुप्लीकेट. उदाहरण के लिए, एक से ज़्यादा पेजों पर दिखता है.
- सिर्फ़ शर्तों के साथ दिखाया जाता है. उदाहरण के लिए, यह सिर्फ़ मोबाइल डेटा की सेटिंग दिखाता है सिम कार्ड मौजूद होता है).
- टेंप्लेट किया गया पेज. उदाहरण के लिए, किसी ऐप्लिकेशन की ज़्यादा जानकारी वाला पेज.
- टाइटल और सबटाइटल के मुकाबले, सेटिंग में ज़्यादा जानकारी चाहिए. इसके लिए उदाहरण के लिए, "सेटिंग" सेटिंग की जा सकती है, जो सिर्फ़ स्क्रीन के शीर्षक से जुड़ी होती है.
किसी सेटिंग को छिपाने के लिए, आपकी सेवा देने वाली कंपनी या SEARCH_INDEX_DATA_PROVIDER
को यह करना चाहिए
getNonIndexableKeys
से खोज के नतीजे की कुंजी दिखाना. कुंजी ये काम कर सकती है
हमेशा लौटाए जाएंगे (डुप्लीकेट, टेंप्लेट वाले पेज केस) या कुछ शर्तों के साथ जोड़े जाएंगे (मोबाइल डिवाइस का इस्तेमाल नहीं करना चाहिए)
डेटा केस).
स्टैटिक इंडेक्स
अगर आपका इंडेक्स डेटा हमेशा एक जैसा रहता है, तो स्टैटिक इंडेक्स का इस्तेमाल करें. उदाहरण के लिए, और हार्ड कोड रॉ डेटा का सारांश देखें. स्टैटिक डेटा इंडेक्स हो जाता है सेटिंग खोज के लॉन्च होने पर, सिर्फ़ एक बार.
सेटिंग में इंडेक्स किए जा सकने वाले एलिमेंट के लिए, getXmlResourcesToIndex
लागू करें
और/या getRawDataToIndex
. इंजेक्ट की गई सेटिंग के लिए,
queryXmlResources
और/या queryRawData
तरीके.
डाइनैमिक इंडेक्स
अगर इंडेक्स किए जा सकने वाले डेटा को ज़रूरत के मुताबिक अपडेट किया जा सकता है, तो डाइनैमिक तरीके का इस्तेमाल करके अपना डेटा इंडेक्स करें. इस डाइनैमिक सूची के लॉन्च होने पर, सेटिंग खोज की सुविधा उसे अपडेट कर देती है.
सेटिंग में इंडेक्स किए जा सकने वाले एलिमेंट के लिए, getDynamicRawDataToIndex
लागू करें.
इंजेक्ट की गई सेटिंग के लिए, queryDynamicRawData methods
को लागू करें.
कार की सेटिंग में इंडेक्स
खोज सुविधा में शामिल करने के लिए अलग-अलग सेटिंग को इंडेक्स करने के लिए, देखें
कॉन्टेंट
सेवा देने वाली कंपनियां. SettingsLib
और android.provider
पैकेज में पहले से ही तय इंटरफ़ेस और ऐब्स्ट्रैक्ट क्लास होती हैं.
नई लिस्टिंग उपलब्ध कराती हैं. एओएसपी सेटिंग में, इन
क्लास का इस्तेमाल, नतीजों को इंडेक्स करने के लिए किया जाता है. मुख्य इंटरफ़ेस को पूरा करना है
SearchIndexablesProvider
, जिसका इस्तेमाल करता है
डेटा इंडेक्स करने के लिए SettingsIntelligence
.
public abstract class SearchIndexablesProvider extends ContentProvider { public abstract Cursor queryXmlResources(String[] projection); public abstract Cursor queryRawData(String[] projection); public abstract Cursor queryNonIndexableKeys(String[] projection); }
सिद्धांत के तौर पर, हर फ़्रैगमेंट को नतीजों में जोड़ा जा सकता है
SearchIndexablesProvider
, इस मामले में SettingsIntelligence
कॉन्टेंट होता है. नए फ़्रैगमेंट जोड़ने और इस प्रोसेस को आसानी से मैनेज करने के लिए,
SearchIndexableResources
में से SettingsLib
कोड जनरेशन का इस्तेमाल करें.
कार की सेटिंग के लिए, इंडेक्स किए जा सकने वाले हर फ़्रैगमेंट के साथ एनोटेट किया जाता है
@SearchIndexable
और उसके बाद एक स्टैटिक SearchIndexProvider
है
फ़ील्ड शामिल करें, जो उस फ़्रैगमेंट के लिए काम का डेटा उपलब्ध कराता है. फ़्रैगमेंट जिसमें
एनोटेशन लेकिन कंपाइलेशन में SearchIndexProvider
नतीजा मौजूद नहीं है
गड़बड़ी.
interface SearchIndexProvider { List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled); List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled); List<SearchIndexableRaw> getDynamicRawDataToIndex(Context context, boolean enabled); List<String> getNonIndexableKeys(Context context); }
इसके बाद, ये सभी फ़्रैगमेंट अपने-आप जनरेट हुए रिपोर्ट में जोड़ दिए जाते हैं
SearchIndexableResourcesAuto
क्लास, जो एक थिन रैपर है
सभी फ़्रैगमेंट के लिए, SearchIndexProvider
फ़ील्ड की सूची के आस-पास मौजूद होगा.
किसी एनोटेशन के लिए कोई खास टारगेट तय करने पर सहायता दी जाती है (जैसे कि
Auto, TV, और Wear. हालांकि, ज़्यादातर एनोटेशन को डिफ़ॉल्ट तौर पर (All
) पर ही छोड़ दिया जाता है.
इस्तेमाल के इस मामले में, ऑटो टारगेट (अपने-आप होने वाली टारगेटिंग) की जानकारी देने के लिए कोई खास ज़रूरत मौजूद नहीं है, इसलिए यह ज़रूरत बनी रहती है
All
के तौर पर. SearchIndexProvider
को लागू करने का बुनियादी तरीका
ज़्यादातर फ़्रैगमेंट के लिए काफ़ी हो.
public class CarBaseSearchIndexProvider implements Indexable.SearchIndexProvider { private static final Logger LOG = new Logger(CarBaseSearchIndexProvider.class); private final int mXmlRes; private final String mIntentAction; private final String mIntentClass; public CarBaseSearchIndexProvider(@XmlRes int xmlRes, String intentAction) { mXmlRes = xmlRes; mIntentAction = intentAction; mIntentClass = null; } public CarBaseSearchIndexProvider(@XmlRes int xmlRes, @NonNull Class intentClass) { mXmlRes = xmlRes; mIntentAction = null; mIntentClass = intentClass.getName(); } @Override public List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled) { SearchIndexableResource sir = new SearchIndexableResource(context); sir.xmlResId = mXmlRes; sir.intentAction = mIntentAction; sir.intentTargetPackage = context.getPackageName(); sir.intentTargetClass = mIntentClass; return Collections.singletonList(sir); } @Override public List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled) { return null; } @Override public List<SearchIndexableRaw> getDynamicRawDataToIndex(Context context, boolean enabled) { return null; } @Override public List<String> getNonIndexableKeys(Context context) { if (!isPageSearchEnabled(context)) { try { return PreferenceXmlParser.extractMetadata(context, mXmlRes, FLAG_NEED_KEY) .stream() .map(bundle -> bundle.getString(METADATA_KEY)) .collect(Collectors.toList()); } catch (IOException | XmlPullParserException e) { LOG.w("Error parsing non-indexable XML - " + mXmlRes); } } return null; } /** * Returns true if the page should be considered in search query. If return false, entire page is suppressed during search query. */ protected boolean isPageSearchEnabled(Context context) { return true; } }
नए फ़्रैगमेंट को इंडेक्स करें
इस डिज़ाइन के साथ, नया SettingsFragment
जोड़ना ज़्यादा आसान है
आम तौर पर, दो लाइन वाला अपडेट होता है, जो फ़्रैगमेंट और
का पालन किया जाना चाहिए. उदाहरण के तौर पर WifiSettingsFragment
:
@SearchIndexable public class WifiSettingsFragment extends SettingsFragment { [...] public static final CarBaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER = new CarBaseSearchIndexProvider(R.xml.wifi_list_fragment, Settings.ACTION_WIFI_SETTINGS); }
SearchIndexablesProvider
का AAOS लागू करना, जो
SearchIndexableResources
का इस्तेमाल करता है और इससे अनुवाद करता है
SearchIndexProviders
के लिए डेटाबेस स्कीमा में
SettingsIntelligence
, लेकिन यह इस बात पर ध्यान नहीं देता कि फ़्रैगमेंट क्या होते हैं
इंडेक्स किया जा रहा है. SettingsIntelligence
इतने सारे डिवाइसों पर काम करता है
उपलब्ध कराने वाली कंपनियां, ताकि खास तौर पर इस्तेमाल के लिए
मामलों में, हर एक को विशेषज्ञ बनने और एक जैसे नतीजों पर फ़ोकस करने में मदद मिलती है
स्ट्रक्चर. PreferenceScreen
में तय की गई प्राथमिकताएं
हर एक के लिए एक खास कुंजी होनी चाहिए, ताकि फ़्रैगमेंट
इंडेक्स किया गया. इसके अलावा, PreferenceScreen
में एक कुंजी होनी चाहिए
स्क्रीन के टाइटल को इंडेक्स करने के लिए असाइन किया गया है.
इंडेक्स के उदाहरण
कुछ मामलों में, हो सकता है कि फ़्रैगमेंट से कोई खास इंटेंट कार्रवाई न जुड़ी हो
उसके साथ. ऐसे मामलों में, गतिविधि क्लास में
CarBaseSearchIndexProvider
इंटेंट के बजाय कॉम्पोनेंट का इस्तेमाल किया जा रहा है
कोई कार्रवाई. ऐसा करने पर भी, मेनिफ़ेस्ट फ़ाइल में गतिविधि का होना ज़रूरी है
और उसे एक्सपोर्ट करने के लिए.
@SearchIndexable public class LanguagesAndInputFragment extends SettingsFragment { [...] public static final CarBaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER = new CarBaseSearchIndexProvider(R.xml.languages_and_input_fragment, LanguagesAndInputActivity.class); }
कुछ खास मामलों में, CarBaseSearchIndexProvider
के कुछ तरीके
मनमुताबिक नतीजों को इंडेक्स करने के लिए, उनमें बदलाव करना पड़ सकता है. उदाहरण के लिए,
NetworkAndInternetFragment
, मोबाइल नेटवर्क से जुड़ी प्राथमिकताएं ये थीं
जिसे मोबाइल नेटवर्क के बिना डिवाइस पर इंडेक्स नहीं किया जाना चाहिए. इस स्थिति में,
getNonIndexableKeys
तरीका अपनाएं और सही कुंजियों को इस तौर पर मार्क करें
मोबाइल नेटवर्क न होने पर, इंडेक्स नहीं किया जा सकता.
@SearchIndexable public class NetworkAndInternetFragment extends SettingsFragment { [...] public static final CarBaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER = new CarBaseSearchIndexProvider(R.xml.network_and_internet_fragment, Settings.Panel.ACTION_INTERNET_CONNECTIVITY) { @Override public List<String> getNonIndexableKeys(Context context) { if (!NetworkUtils.hasMobileNetwork( context.getSystemService(ConnectivityManager.class))) { List<String> nonIndexableKeys = new ArrayList<>(); nonIndexableKeys.add(context.getString( R.string.pk_mobile_network_settings_entry)); nonIndexableKeys.add(context.getString( R.string.pk_data_usage_settings_entry)); return nonIndexableKeys; } return null; } }; }
किसी खास फ़्रैगमेंट की ज़रूरतों के आधार पर,
CarBaseSearchIndexProvider
को बदलकर, दूसरे सर्वर को शामिल किया जा सकता है
इंडेक्स करने लायक डेटा, जैसे कि स्टैटिक और डाइनैमिक रॉ डेटा.
@SearchIndexable public class RawIndexDemoFragment extends SettingsFragment { public static final String KEY_CUSTOM_RESULT = "custom_result_key"; [...] public static final CarBaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER = new CarBaseSearchIndexProvider(R.xml.raw_index_demo_fragment, RawIndexDemoActivity.class) { @Override public List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled) { List<SearchIndexableRaw> rawData = new ArrayList<>(); SearchIndexableRaw customResult = new SearchIndexableRaw(context); customResult.key = KEY_CUSTOM_RESULT; customResult.title = context.getString(R.string.my_title); customResult.screenTitle = context.getString(R.string.my_screen_title); rawData.add(customResult); return rawData; } @Override public List<SearchIndexableRaw> getDynamicRawDataToIndex(Context context, boolean enabled) { List<SearchIndexableRaw> rawData = new ArrayList<>(); SearchIndexableRaw customResult = new SearchIndexableRaw(context); if (hasIndexData()) { customResult.key = KEY_CUSTOM_RESULT; customResult.title = context.getString(R.string.my_title); customResult.screenTitle = context.getString(R.string.my_screen_title); } rawData.add(customResult); return rawData; } }; }
इंडेक्स इंजेक्ट करने की सेटिंग
इंडेक्स करने के लिए सेटिंग इंजेक्ट करने के लिए:
- इस अवधि को बढ़ाकर, अपने ऐप्लिकेशन के लिए
SearchIndexablesProvider
तय करेंandroid.provider.SearchIndexablesProvider
क्लास. - पहले चरण में, सेवा देने वाली कंपनी की मदद से ऐप्लिकेशन के
AndroidManifest.xml
को अपडेट करें. फ़ॉर्मैट:<provider android:name="PROVIDER_CLASS_NAME" android:authorities="PROVIDER_AUTHORITY" android:multiprocess="false" android:grantUriPermissions="true" android:permission="android.permission.READ_SEARCH_INDEXABLES" android:exported="true"> <intent-filter> <action android:name="android.content.action.SEARCH_INDEXABLES_PROVIDER" /> </intent-filter> </provider>
-
सेवा देने वाली कंपनी के लिए, इंडेक्स किया जा सकने वाला डेटा जोड़ें. लागू करने का तरीका, इन ज़रूरतों पर निर्भर करता है
ऐप खोलें. दो अलग-अलग तरह के डेटा को इंडेक्स किया जा सकता है:
SearchIndexableResource
औरSearchIndexableRaw
.
SearchIndexablesProvider का उदाहरण
public class SearchDemoProvider extends SearchIndexablesProvider { /** * Key for Auto brightness setting. */ public static final String KEY_AUTO_BRIGHTNESS = "auto_brightness"; /** * Key for my magic preference. */ public static final String KEY_MY_PREFERENCE = "my_preference_key"; /** * Key for my custom search result. */ public static final String KEY_CUSTOM_RESULT = "custom_result_key"; private String mPackageName; @Override public boolean onCreate() { mPackageName = getContext().getPackageName(); return true; } @Override public Cursor queryXmlResources(String[] projection) { MatrixCursor cursor = new MatrixCursor(INDEXABLES_XML_RES_COLUMNS); cursor.addRow(getResourceRow(R.xml.demo_xml)); return cursor; } @Override public Cursor queryRawData(String[] projection) { MatrixCursor cursor = new MatrixCursor(INDEXABLES_RAW_COLUMNS); Context context = getContext(); Object[] raw = new Object[INDEXABLES_RAW_COLUMNS.length]; raw[COLUMN_INDEX_RAW_TITLE] = context.getString(R.string.my_title); raw[COLUMN_INDEX_RAW_SUMMARY_ON] = context.getString(R.string.my_summary); raw[COLUMN_INDEX_RAW_KEYWORDS] = context.getString(R.string.my_keywords); raw[COLUMN_INDEX_RAW_SCREEN_TITLE] = context.getString(R.string.my_screen_title); raw[COLUMN_INDEX_RAW_KEY] = KEY_CUSTOM_RESULT; raw[COLUMN_INDEX_RAW_INTENT_ACTION] = Intent.ACTION_MAIN; raw[COLUMN_INDEX_RAW_INTENT_TARGET_PACKAGE] = mPackageName; raw[COLUMN_INDEX_RAW_INTENT_TARGET_CLASS] = MyDemoFragment.class.getName(); cursor.addRow(raw); return cursor; } @Override public Cursor queryDynamicRawData(String[] projection) { MatrixCursor cursor = new MatrixCursor(INDEXABLES_RAW_COLUMNS); DemoObject object = getDynamicIndexData(); Object[] raw = new Object[INDEXABLES_RAW_COLUMNS.length]; raw[COLUMN_INDEX_RAW_KEY] = object.key; raw[COLUMN_INDEX_RAW_TITLE] = object.title; raw[COLUMN_INDEX_RAW_KEYWORDS] = object.keywords; raw[COLUMN_INDEX_RAW_INTENT_ACTION] = object.intentAction; raw[COLUMN_INDEX_RAW_INTENT_TARGET_PACKAGE] = object.mPackageName; raw[COLUMN_INDEX_RAW_INTENT_TARGET_CLASS] = object.className; cursor.addRow(raw); return cursor; } @Override public Cursor queryNonIndexableKeys(String[] projection) { MatrixCursor cursor = new MatrixCursor(NON_INDEXABLES_KEYS_COLUMNS); cursor.addRow(getNonIndexableRow(KEY_AUTO_BRIGHTNESS)); if (!Utils.isMyPreferenceAvailable) { cursor.addRow(getNonIndexableRow(KEY_MY_PREFERENCE)); } return cursor; } private Object[] getResourceRow(int xmlResId) { Object[] row = new Object[INDEXABLES_XML_RES_COLUMNS.length]; row[COLUMN_INDEX_XML_RES_RESID] = xmlResId; row[COLUMN_INDEX_XML_RES_ICON_RESID] = 0; row[COLUMN_INDEX_XML_RES_INTENT_ACTION] = Intent.ACTION_MAIN; row[COLUMN_INDEX_XML_RES_INTENT_TARGET_PACKAGE] = mPackageName; row[COLUMN_INDEX_XML_RES_INTENT_TARGET_CLASS] = SearchResult.class.getName(); return row; } private Object[] getNonIndexableRow(String key) { final Object[] ref = new Object[NON_INDEXABLES_KEYS_COLUMNS.length]; ref[COLUMN_INDEX_NON_INDEXABLE_KEYS_KEY_VALUE] = key; return ref; } private DemoObject getDynamicIndexData() { if (hasIndexData) { DemoObject object = new DemoObject(); object.key = "demo key"; object.title = "demo title"; object.keywords = "demo, keywords"; object.intentAction = "com.demo.DYNAMIC_INDEX"; object.packageName = "com.demo"; object.className = "DemoClass"; return object; } } }