SearchManager.java revision 8c91dd7ec8b3d277a42bccab075241468c9f980d
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.app; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.ComponentName; 20875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaenimport android.content.ContentResolver; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Context; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.DialogInterface; 23875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaenimport android.database.Cursor; 24875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaenimport android.net.Uri; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Bundle; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Handler; 27875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaenimport android.os.RemoteException; 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.ServiceManager; 29875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaenimport android.server.search.SearchableInfo; 308d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringertimport android.util.Log; 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.KeyEvent; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 336d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringertimport java.util.List; 346d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class provides access to the system search services. 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>In practice, you won't interact with this class directly, as search 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * services are provided through methods in {@link android.app.Activity Activity} 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * methods and the the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent}. This class does provide a basic 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * overview of search services and how to integrate them with your activities. 438c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * If you do require direct access to the SearchManager, do not instantiate 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this class directly; instead, retrieve it through 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Context#getSystemService 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * context.getSystemService(Context.SEARCH_SERVICE)}. 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Topics covered here: 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ol> 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#DeveloperGuide">Developer Guide</a> 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#HowSearchIsInvoked">How Search Is Invoked</a> 528c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <li><a href="#ImplementingSearchForYourApp">Implementing Search for Your App</a> 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#Suggestions">Search Suggestions</a> 548c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <li><a href="#ExposingSearchSuggestionsToQuickSearchBox">Exposing Search Suggestions to 558c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * Quick Search Box</a></li> 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#ActionKeys">Action Keys</a> 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#SearchabilityMetadata">Searchability Metadata</a> 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#PassingSearchContext">Passing Search Context</a> 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#ProtectingUserPrivacy">Protecting User Privacy</a> 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ol> 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="DeveloperGuide"></a> 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Developer Guide</h3> 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The ability to search for user, system, or network based data is considered to be 668c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * a core user-level feature of the Android platform. At any time, the user should be 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * able to use a familiar command, button, or keystroke to invoke search, and the user 688c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * should be able to search any data which is available to them. 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 708c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p>To make search appear to the user as a seamless system-wide feature, the application 718c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * framework centrally controls it, offering APIs to individual applications to control how they 728c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * are searched. Applications can customize how search is invoked, how the search dialog looks, 738c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * and what type of search results are available, including suggestions that are available as the 748c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * user types. 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 768c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p>Even applications which are not searchable will by default support the invocation of 778c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * search to trigger Quick Search Box, the system's 'global search'. 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="HowSearchIsInvoked"></a> 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>How Search Is Invoked</h3> 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Unless impossible or inapplicable, all applications should support 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * invoking the search UI. This means that when the user invokes the search command, 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a search UI will be presented to them. The search command is currently defined as a menu 858c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * item called "Search" (with an alphabetic shortcut key of "S"), or on many devices, a dedicated 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * search button key. 878c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p>If your application is not inherently searchable, the default implementation will cause 888c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * the search UI to be invoked in a "global search" mode known as Quick Search Box. As the user 898c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * types, search suggestions from across the device and the web will be surfaced, and if they 908c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * click the "Search" button, this will bring the browser to the front and will launch a web-based 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * search. The user will be able to click the "Back" button and return to your application. 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>In general this is implemented by your activity, or the {@link android.app.Activity Activity} 938c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * base class, which captures the search command and invokes the SearchManager to 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * display and operate the search UI. You can also cause the search UI to be presented in response 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to user keystrokes in your activity (for example, to instantly start filter searching while 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * viewing a list and typing any key). 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The search UI is presented as a floating 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * window and does not cause any change in the activity stack. If the user 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * cancels search, the previous activity re-emerges. If the user launches a 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * search, this will be done by sending a search {@link android.content.Intent Intent} (see below), 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and the normal intent-handling sequence will take place (your activity will pause, 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * etc.) 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>What you need to do:</b> First, you should consider the way in which you want to 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * handle invoking search. There are four broad (and partially overlapping) categories for 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you to choose from. 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>You can capture the search command yourself, by including a <i>search</i> 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * button or menu item - and invoking the search UI directly.</li> 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>You can provide a <i>type-to-search</i> feature, in which search is invoked automatically 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when the user enters any characters.</li> 1108c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <li>Even if your application is not inherently searchable, you can allow global search, 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * via the search key (or even via a search menu item). 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>You can disable search entirely. This should only be used in very rare circumstances, 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as search is a system-wide feature and users will expect it to be available in all contexts.</li> 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>How to define a search menu.</b> The system provides the following resources which may 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be useful when adding a search item to your menu: 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>android.R.drawable.ic_search_category_default is an icon you can use in your menu.</li> 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>{@link #MENU_KEY SearchManager.MENU_KEY} is the recommended alphabetic shortcut.</li> 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>How to invoke search directly.</b> In order to invoke search directly, from a button 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or menu item, you can launch a generic search by calling 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onSearchRequested onSearchRequested} as shown: 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * onSearchRequested();</pre> 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>How to implement type-to-search.</b> While setting up your activity, call 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#setDefaultKeyMode setDefaultKeyMode}: 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * setDefaultKeyMode(DEFAULT_KEYS_SEARCH_LOCAL); // search within your activity 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * setDefaultKeyMode(DEFAULT_KEYS_SEARCH_GLOBAL); // search using platform global search</pre> 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1348c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p><b>How to enable global search with Quick Search Box.</b> In addition to searching within 1358c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * your activity or application, you can also use the Search Manager to invoke a platform-global 1368c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * search, which uses Quick Search Box to search across the device and the web. There are two ways 1378c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * to do this: 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>You can simply define "search" within your application or activity to mean global search. 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is described in more detail in the 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="#SearchabilityMetadata">Searchability Metadata</a> section. Briefly, you will 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * add a single meta-data entry to your manifest, declaring that the default search 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for your application is "*". This indicates to the system that no application-specific 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * search activity is provided, and that it should launch web-based search instead.</li> 1448c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <li>Simply do nothing and the default implementation of 1458c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * {@link android.app.Activity#onSearchRequested} will cause global search to be triggered. 1468c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * (You can also always trigger search via a direct call to {@link android.app.Activity#startSearch}. 1478c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * This is most useful if you wish to provide local searchability <i>and</i> access to global 1488c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * search.)</li></ul> 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1508c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p><b>How to disable search from your activity.</b> Search is a system-wide feature and users 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will expect it to be available in all contexts. If your UI design absolutely precludes 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * launching search, override {@link android.app.Activity#onSearchRequested onSearchRequested} 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as shown: 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @Override 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * public boolean onSearchRequested() { 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return false; 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * }</pre> 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1608c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p><b>Managing focus and knowing if search is active.</b> The search UI is not a separate 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * activity, and when the UI is invoked or dismissed, your activity will not typically be paused, 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * resumed, or otherwise notified by the methods defined in 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="{@docRoot}guide/topics/fundamentals.html#actlife">Application Fundamentals: 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Activity Lifecycle</a>. The search UI is 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * handled in the same way as other system UI elements which may appear from time to time, such as 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * notifications, screen locks, or other system alerts: 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>When the search UI appears, your activity will lose input focus. 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>When the search activity is dismissed, there are three possible outcomes: 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>If the user simply canceled the search UI, your activity will regain input focus and 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * proceed as before. See {@link #setOnDismissListener} and {@link #setOnCancelListener} if you 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * required direct notification of search dialog dismissals.</li> 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the user launched a search, and this required switching to another activity to receive 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and process the search {@link android.content.Intent Intent}, your activity will receive the 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * normal sequence of activity pause or stop notifications.</li> 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the user launched a search, and the current activity is the recipient of the search 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent}, you will receive notification via the 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onNewIntent onNewIntent()} method.</li></ul> 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This list is provided in order to clarify the ways in which your activities will interact with 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the search UI. More details on searchable activities and search intents are provided in the 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * sections below. 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1828c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <a name="ImplementingSearchForYourApp"></a> 1838c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <h3>Implementing Search for Your App</h3> 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1858c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p>The following steps are necessary in order to implement search. 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Implement search invocation as described above. (Strictly speaking, 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * these are decoupled, but it would make little sense to be "searchable" but not 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * "search-invoking".)</li> 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Your application should have an activity that takes a search string and 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * converts it to a list of results. This could be your primary display activity 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or it could be a dedicated search results activity. This is your <i>searchable</i> 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * activity and every query-search application must have one.</li> 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>In the searchable activity, in onCreate(), you must receive and handle the 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent}. The text to search (query string) for is provided by 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * calling 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #QUERY getStringExtra(SearchManager.QUERY)}.</li> 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>To identify and support your searchable activity, you'll need to 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provide an XML file providing searchability configuration parameters, a reference to that 2018c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * in your searchable activity's 2028c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> entry, and an 2038c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * intent-filter declaring that you can receive ACTION_SEARCH intents. This is described in more 2048c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * detail in the <a href="#SearchabilityMetadata">Searchability Metadata</a> section.</li> 2058c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <li>Your <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> also needs a 2068c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * metadata entry providing a global reference to the searchable activity. This is the "glue" 2078c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * directing the search UI, when invoked from any of your <i>other</i> activities, to use your 2088c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * application as the default search context. This is also described in more detail in the 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="#SearchabilityMetadata">Searchability Metadata</a> section.</li> 2108c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <li>Finally, you may want to define your search results activity as single-top with the 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.attr#launchMode singleTop} launchMode flag. This allows the system 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to launch searches from/to the same activity without creating a pile of them on the 2139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * activity stack. If you do this, be sure to also override 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onNewIntent onNewIntent} to handle the 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * updated intents (with new queries) as they arrive.</li> 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Code snippet showing handling of intents in your search activity: 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @Override 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * protected void onCreate(Bundle icicle) { 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * super.onCreate(icicle); 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * final Intent queryIntent = getIntent(); 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * final String queryAction = queryIntent.getAction(); 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if (Intent.ACTION_SEARCH.equals(queryAction)) { 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * doSearchWithIntent(queryIntent); 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * } 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * } 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * private void doSearchWithIntent(final Intent queryIntent) { 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * final String queryString = queryIntent.getStringExtra(SearchManager.QUERY); 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * doSearchWithQuery(queryString); 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * }</pre> 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="Suggestions"></a> 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Search Suggestions</h3> 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2398c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p>A powerful feature of the search system is the ability of any application to easily provide 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * live "suggestions" in order to prompt the user. Each application implements suggestions in a 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * different, unique, and appropriate way. Suggestions be drawn from many sources, including but 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not limited to: 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Actual searchable results (e.g. names in the address book)</li> 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Recently entered queries</li> 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Recently viewed data or results</li> 2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Contextually appropriate queries or results</li> 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Summaries of possible results</li> 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2518c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p>Once an application is configured to provide search suggestions, those same suggestions can 2528c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * easily be made available to the system-wide Quick Search Box, providing faster access to its 2538c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * content from on central prominent place. See 2548c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <a href="#ExposingSearchSuggestionsToQuickSearchBox">Exposing Search Suggestions to Quick Search 2558c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * Box</a> for more details. 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The primary form of suggestions is known as <i>queried suggestions</i> and is based on query 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * text that the user has already typed. This would generally be based on partial matches in 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the available data. In certain situations - for example, when no query text has been typed yet - 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * an application may also opt to provide <i>zero-query suggestions</i>. 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * These would typically be drawn from the same data source, but because no partial query text is 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * available, they should be weighted based on other factors - for example, most recent queries 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or most recent results. 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2658c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p><b>Overview of how suggestions are provided.</b> Suggestions are accessed via a 2668c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * {@link android.content.ContentProvider Content Provider}. When the search manager identifies a 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * particular activity as searchable, it will check for certain metadata which indicates that 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * there is also a source of suggestions. If suggestions are provided, the following steps are 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * taken. 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>Using formatting information found in the metadata, the user's query text (whatever 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * has been typed so far) will be formatted into a query and sent to the suggestions 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.ContentProvider Content Provider}.</li> 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>The suggestions {@link android.content.ContentProvider Content Provider} will create a 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.database.Cursor Cursor} which can iterate over the possible suggestions.</li> 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>The search manager will populate a list using display data found in each row of the cursor, 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and display these suggestions to the user.</li> 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the user types another key, or changes the query in any way, the above steps are repeated 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and the suggestions list is updated or repopulated.</li> 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the user clicks or touches the "GO" button, the suggestions are ignored and the search is 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * launched using the normal {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} type of 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent}.</li> 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the user uses the directional controls to navigate the focus into the suggestions list, 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the query text will be updated while the user navigates from suggestion to suggestion. The user 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can then click or touch the updated query and edit it further. If the user navigates back to 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the edit field, the original typed query is restored.</li> 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the user clicks or touches a particular suggestion, then a combination of data from the 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * cursor and 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * values found in the metadata are used to synthesize an Intent and send it to the application. 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Depending on the design of the activity and the way it implements search, this might be a 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} (in order to launch a query), or it 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * might be a {@link android.content.Intent#ACTION_VIEW ACTION_VIEW}, in order to proceed directly 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to display of specific data.</li> 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Simple Recent-Query-Based Suggestions.</b> The Android framework provides a simple Search 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Suggestions provider, which simply records and replays recent queries. For many applications, 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this will be sufficient. The basic steps you will need to 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * do, in order to use the built-in recent queries suggestions provider, are as follows: 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Implement and test query search, as described in the previous sections.</li> 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Create a Provider within your application by extending 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.SearchRecentSuggestionsProvider}.</li> 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Create a manifest entry describing your provider.</li> 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Update your searchable activity's XML configuration file with information about your 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provider.</li> 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>In your searchable activities, capture any user-generated queries and record them 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for future searches by calling {@link android.provider.SearchRecentSuggestions#saveRecentQuery}. 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </li> 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>For complete implementation details, please refer to 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.SearchRecentSuggestionsProvider}. The rest of the information in this 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * section should not be necessary, as it refers to custom suggestions providers. 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Creating a Customized Suggestions Provider:</b> In order to create more sophisticated 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * suggestion providers, you'll need to take the following steps: 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Implement and test query search, as described in the previous sections.</li> 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Decide how you wish to <i>receive</i> suggestions. Just like queries that the user enters, 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * suggestions will be delivered to your searchable activity as 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent} messages; Unlike simple queries, you have quite a bit of 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * flexibility in forming those intents. A query search application will probably 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * wish to continue receiving the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent}, which will launch a query search using query text as 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provided by the suggestion. A filter search application will probably wish to 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * receive the {@link android.content.Intent#ACTION_VIEW ACTION_VIEW} 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent}, which will take the user directly to a selected entry. 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Other interesting suggestions, including hybrids, are possible, and the suggestion provider 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can easily mix-and-match results to provide a richer set of suggestions for the user. Finally, 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you'll need to update your searchable activity (or other activities) to receive the intents 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as you've defined them.</li> 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Implement a Content Provider that provides suggestions. If you already have one, and it 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * has access to your suggestions data. If not, you'll have to create one. 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You'll also provide information about your Content Provider in your 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * package's <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a>.</li> 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Update your searchable activity's XML configuration file. There are two categories of 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information used for suggestions: 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>The first is (required) data that the search manager will 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * use to format the queries which are sent to the Content Provider.</li> 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>The second is (optional) parameters to configure structure 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if intents generated by suggestions.</li></li> 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Configuring your Content Provider to Receive Suggestion Queries.</b> The basic job of 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a search suggestions {@link android.content.ContentProvider Content Provider} is to provide 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * "live" (while-you-type) conversion of the user's query text into a set of zero or more 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * suggestions. Each application is free to define the conversion, and as described above there are 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * many possible solutions. This section simply defines how to communicate with the suggestion 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provider. 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The Search Manager must first determine if your package provides suggestions. This is done 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * by examination of your searchable meta-data XML file. The android:searchSuggestAuthority 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attribute, if provided, is the signal to obtain & display suggestions. 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Every query includes a Uri, and the Search Manager will format the Uri as shown: 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><pre class="prettyprint"> 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * content:// your.suggest.authority / your.suggest.path / SearchManager.SUGGEST_URI_PATH_QUERY</pre> 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Your Content Provider can receive the query text in one of two ways. 3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Query provided as a selection argument.</b> If you define the attribute value 3629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:searchSuggestSelection and include a string, this string will be passed as the 3639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <i>selection</i> parameter to your Content Provider's query function. You must define a single 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * selection argument, using the '?' character. The user's query text will be passed to you 3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as the first element of the selection arguments array.</li> 3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Query provided with Data Uri.</b> If you <i>do not</i> define the attribute value 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:searchSuggestSelection, then the Search Manager will append another "/" followed by 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the user's query to the query Uri. The query will be encoding using Uri encoding rules - don't 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * forget to decode it. (See {@link android.net.Uri#getPathSegments} and 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.net.Uri#getLastPathSegment} for helpful utilities you can use here.)</li> 3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Handling empty queries.</b> Your application should handle the "empty query" 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (no user text entered) case properly, and generate useful suggestions in this case. There are a 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * number of ways to do this; Two are outlined here: 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>For a simple filter search of local data, you could simply present the entire dataset, 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * unfiltered. (example: People)</li> 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>For a query search, you could simply present the most recent queries. This allows the user 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to quickly repeat a recent search.</li></ul> 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>The Format of Individual Suggestions.</b> Your suggestions are communicated back to the 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Search Manager by way of a {@link android.database.Cursor Cursor}. The Search Manager will 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * usually pass a null Projection, which means that your provider can simply return all appropriate 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * columns for each suggestion. The columns currently defined are: 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <thead> 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>Column Name</th> <th>Description</th> <th>Required?</th></tr> 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </thead> 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tbody> 3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_FORMAT}</th> 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td><i>Unused - can be null.</i></td> 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_TEXT_1}</th> 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>This is the line of text that will be presented to the user as the suggestion.</td> 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">Yes</td> 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_TEXT_2}</th> 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If your cursor includes this column, then all suggestions will be provided in a 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * two-line format. The data in this column will be displayed as a second, smaller 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * line of text below the primary suggestion, or it can be null or empty to indicate no 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * text in this row's suggestion.</td> 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_ICON_1}</th> 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If your cursor includes this column, then all suggestions will be provided in an 413875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * icons+text format. This value should be a reference to the icon to 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * draw on the left side, or it can be null or zero to indicate no icon in this row. 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 416875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <td align="center">No.</td> 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_ICON_2}</th> 4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If your cursor includes this column, then all suggestions will be provided in an 421875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * icons+text format. This value should be a reference to the icon to 4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * draw on the right side, or it can be null or zero to indicate no icon in this row. 4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 424875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <td align="center">No.</td> 4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_INTENT_ACTION}</th> 4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If this column exists <i>and</i> this element exists at the given row, this is the 4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * action that will be used when forming the suggestion's intent. If the element is 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not provided, the action will be taken from the android:searchSuggestIntentAction 4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * field in your XML metadata. <i>At least one of these must be present for the 4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * suggestion to generate an intent.</i> Note: If your action is the same for all 4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * suggestions, it is more efficient to specify it using XML metadata and omit it from 4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the cursor.</td> 4359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_INTENT_DATA}</th> 4399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If this column exists <i>and</i> this element exists at the given row, this is the 4409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * data that will be used when forming the suggestion's intent. If the element is not 4419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provided, the data will be taken from the android:searchSuggestIntentData field in 4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your XML metadata. If neither source is provided, the Intent's data field will be 4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * null. Note: If your data is the same for all suggestions, or can be described 4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a constant part and a specific ID, it is more efficient to specify it using 4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * XML metadata and omit it from the cursor.</td> 4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_INTENT_DATA_ID}</th> 4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If this column exists <i>and</i> this element exists at the given row, then "/" and 4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this value will be appended to the data field in the Intent. This should only be 4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * used if the data field has already been set to an appropriate base string.</td> 4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>{@link #SUGGEST_COLUMN_QUERY}</th> 4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If this column exists <i>and</i> this element exists at the given row, this is the 4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * data that will be used when forming the suggestion's query.</td> 4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">Required if suggestion's action is 4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH}, optional otherwise.</td> 4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th><i>Other Columns</i></th> 4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>Finally, if you have defined any <a href="#ActionKeys">Action Keys</a> and you wish 4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for them to have suggestion-specific definitions, you'll need to define one 4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * additional column per action key. The action key will only trigger if the 4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * currently-selection suggestion has a non-empty string in the corresponding column. 4689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the section on <a href="#ActionKeys">Action Keys</a> for additional details and 4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * implementation steps.</td> 4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tbody> 4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </table> 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Clearly there are quite a few permutations of your suggestion data, but in the next section 4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * we'll look at a few simple combinations that you'll select from. 4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>The Format Of Intents Sent By Search Suggestions.</b> Although there are many ways to 4809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * configure these intents, this document will provide specific information on just a few of them. 4819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li><b>Launch a query.</b> In this model, each suggestion represents a query that your 4829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * searchable activity can perform, and the {@link android.content.Intent Intent} will be formatted 4839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * exactly like those sent when the user enters query text and clicks the "GO" button: 4849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 4859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Action:</b> {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} provided 4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using your XML metadata (android:searchSuggestIntentAction).</li> 4879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Data:</b> empty (not used).</li> 4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Query:</b> query text supplied by the cursor.</li> 4899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </li> 4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Go directly to a result, using a complete Data Uri.</b> In this model, the user will be 4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * taken directly to a specific result. 4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 4949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Action:</b> {@link android.content.Intent#ACTION_VIEW ACTION_VIEW}</li> 4959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Data:</b> a complete Uri, supplied by the cursor, that identifies the desired data.</li> 4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Query:</b> query text supplied with the suggestion (probably ignored)</li> 4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </li> 4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Go directly to a result, using a synthesized Data Uri.</b> This has the same result 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as the previous suggestion, but provides the Data Uri in a different way. 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Action:</b> {@link android.content.Intent#ACTION_VIEW ACTION_VIEW}</li> 5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Data:</b> The search manager will assemble a Data Uri using the following elements: 5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a Uri fragment provided in your XML metadata (android:searchSuggestIntentData), followed by 5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a single "/", followed by the value found in the {@link #SUGGEST_COLUMN_INTENT_DATA_ID} 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * entry in your cursor.</li> 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Query:</b> query text supplied with the suggestion (probably ignored)</li> 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </li> 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This list is not meant to be exhaustive. Applications should feel free to define other types 5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of suggestions. For example, you could reduce long lists of results to summaries, and use one 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of the above intents (or one of your own) with specially formatted Data Uri's to display more 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * detailed results. Or you could display textual shortcuts as suggestions, but launch a display 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in a more data-appropriate format such as media artwork. 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Suggestion Rewriting.</b> If the user navigates through the suggestions list, the UI 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * may temporarily rewrite the user's query with a query that matches the currently selected 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * suggestion. This enables the user to see what query is being suggested, and also allows the user 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to click or touch in the entry EditText element and make further edits to the query before 5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * dispatching it. In order to perform this correctly, the Search UI needs to know exactly what 5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * text to rewrite the query with. 5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>For each suggestion, the following logic is used to select a new query string: 5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>If the suggestion provides an explicit value in the {@link #SUGGEST_COLUMN_QUERY} 5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * column, this value will be used.</li> 5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the metadata includes the queryRewriteFromData flag, and the suggestion provides an 5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * explicit value for the intent Data field, this Uri will be used. Note that this should only be 5299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * used with Uri's that are intended to be user-visible, such as HTTP. Internal Uri schemes should 5309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not be used in this way.</li> 5319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>If the metadata includes the queryRewriteFromText flag, the text in 5329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #SUGGEST_COLUMN_TEXT_1} will be used. This should be used for suggestions in which no 5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * query text is provided and the SUGGEST_COLUMN_INTENT_DATA values are not suitable for user 5349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * inspection and editing.</li></ul> 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5368c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <a name="ExposingSearchSuggestionsToQuickSearchBox"></a> 5378c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <h3>Exposing Search Suggestions to Quick Search Box</h3> 5388c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * 5398c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * <p> 5408c91dd7ec8b3d277a42bccab075241468c9f980dMike LeBeau * 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="ActionKeys"></a> 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Action Keys</h3> 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Searchable activities may also wish to provide shortcuts based on the various action keys 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * available on the device. The most basic example of this is the contacts app, which enables the 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * green "dial" key for quick access during searching. Not all action keys are available on 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * every device, and not all are allowed to be overriden in this way. (For example, the "Home" 5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * key must always return to the home screen, with no exceptions.) 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>In order to define action keys for your searchable application, you must do two things. 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>You'll add one or more <i>actionkey</i> elements to your searchable metadata configuration 5549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * file. Each element defines one of the keycodes you are interested in, 5559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * defines the conditions under which they are sent, and provides details 5569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * on how to communicate the action key event back to your searchable activity.</li> 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>In your broadcast receiver, if you wish, you can check for action keys by checking the 5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * extras field of the {@link android.content.Intent Intent}.</li> 5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Updating metadata.</b> For each keycode of interest, you must add an <actionkey> 5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * element. Within this element you must define two or three attributes. The first attribute, 5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <android:keycode>, is required; It is the key code of the action key event, as defined in 5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.view.KeyEvent}. The remaining two attributes define the value of the actionkey's 5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <i>message</i>, which will be passed to your searchable activity in the 5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent} (see below for more details). Although each of these 5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attributes is optional, you must define one or both for the action key to have any effect. 5689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <android:queryActionMsg> provides the message that will be sent if the action key is 5699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * pressed while the user is simply entering query text. <android:suggestActionMsgColumn> 5709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is used when action keys are tied to specific suggestions. This attribute provides the name 5719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of a <i>column</i> in your suggestion cursor; The individual suggestion, in that column, 5729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provides the message. (If the cell is empty or null, that suggestion will not work with that 5739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * action key.) 5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>See the <a href="#SearchabilityMetadata">Searchability Metadata</a> section for more details 5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and examples. 5769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Receiving Action Keys</b> Intents launched by action keys will be specially marked 5789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a combination of values. This enables your searchable application to examine the intent, 5799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if necessary, and perform special processing. For example, clicking a suggested contact might 5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * simply display them; Selecting a suggested contact and clicking the dial button might 5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * immediately call them. 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>When a search {@link android.content.Intent Intent} is launched by an action key, two values 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be added to the extras field. 5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>To examine the key code, use {@link android.content.Intent#getIntExtra 5879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * getIntExtra(SearchManager.ACTION_KEY)}.</li> 5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>To examine the message string, use {@link android.content.Intent#getStringExtra 5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * getStringExtra(SearchManager.ACTION_MSG)}</li> 5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 5919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="SearchabilityMetadata"></a> 5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Searchability Metadata</h3> 5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Every activity that is searchable must provide a small amount of additional information 5969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in order to properly configure the search system. This controls the way that your search 5979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is presented to the user, and controls for the various modalities described previously. 5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>If your application is not searchable, 6009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * then you do not need to provide any search metadata, and you can skip the rest of this section. 6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * When this search metadata cannot be found, the search manager will assume that the activity 6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * does not implement search. (Note: to implement web-based search, you will need to add 6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the android.app.default_searchable metadata to your manifest, as shown below.) 6049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Values you supply in metadata apply only to each local searchable activity. Each 6069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * searchable activity can define a completely unique search experience relevant to its own 6079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * capabilities and user experience requirements, and a single application can even define multiple 6089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * searchable activities. 6099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Metadata for searchable activity.</b> As with your search implementations described 6119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * above, you must first identify which of your activities is searchable. In the 6129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> entry for this activity, you must 6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provide two elements: 6149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>An intent-filter specifying that you can receive and process the 6159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} {@link android.content.Intent Intent}. 6169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </li> 6179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>A reference to a small XML file (typically called "searchable.xml") which contains the 6189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * remaining configuration information for how your application implements search.</li></ul> 6199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Here is a snippet showing the necessary elements in the 6219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> entry for your searchable activity. 6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <!-- Search Activity - searchable --> 6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <activity android:name="MySearchActivity" 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:label="Search" 6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:launchMode="singleTop"> 6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <intent-filter> 6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <action android:name="android.intent.action.SEARCH" /> 6299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <category android:name="android.intent.category.DEFAULT" /> 6309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </intent-filter> 6319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <meta-data android:name="android.app.searchable" 6329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:resource="@xml/searchable" /> 6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </activity></pre> 6349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Next, you must provide the rest of the searchability configuration in 6369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the small XML file, stored in the ../xml/ folder in your build. The XML file is a 6379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * simple enumeration of the search configuration parameters for searching within this activity, 6389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * application, or package. Here is a sample XML file (named searchable.xml, for use with 6399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the above manifest) for a query-search activity. 6409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 6429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <searchable xmlns:android="http://schemas.android.com/apk/res/android" 6439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:label="@string/search_label" 6449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:hint="@string/search_hint" > 6459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </searchable></pre> 6469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Note that all user-visible strings <i>must</i> be provided in the form of "@string" 6489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * references. Hard-coded strings, which cannot be localized, will not work properly in search 6499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * metadata. 6509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Attributes you can set in search metadata: 6529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 6539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <thead> 6559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 6569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </thead> 6579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tbody> 6599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:label</th> 6609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>This is the name for your application that will be presented to the user in a 6619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * list of search targets, or in the search box as a label.</td> 6629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">Yes</td> 6639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 6649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:icon</th> 6669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, this icon will be used <i>in place</i> of the label string. This 6679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is provided in order to present logos or other non-textual banners.</td> 6689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 6699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 6709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:hint</th> 6729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>This is the text to display in the search text field when no user text has been 6739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * entered.</td> 6749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 6759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 6769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:searchButtonText</th> 6789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, this text will replace the default text in the "Search" button.</td> 6799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 6809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 6819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:searchMode</th> 6839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided and non-zero, sets additional modes for control of the search 6849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * presentation. The following mode bits are defined: 6859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <table border="2" align="center" frame="hsides" rules="rows"> 6869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tbody> 6879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>showSearchLabelAsBadge</th> 6889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If set, this flag enables the display of the search target (label) 6899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * within the search bar. If this flag and showSearchIconAsBadge 6909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (see below) are both not set, no badge will be shown.</td> 6919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 6929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>showSearchIconAsBadge</th> 6939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If set, this flag enables the display of the search target (icon) within 6949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the search bar. If this flag and showSearchLabelAsBadge 6959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (see above) are both not set, no badge will be shown. If both flags 6969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * are set, showSearchIconAsBadge has precedence and the icon will be 6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shown.</td> 6989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>queryRewriteFromData</th> 7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If set, this flag causes the suggestion column SUGGEST_COLUMN_INTENT_DATA 7019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to be considered as the text for suggestion query rewriting. This should 7029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * only be used when the values in SUGGEST_COLUMN_INTENT_DATA are suitable 7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for user inspection and editing - typically, HTTP/HTTPS Uri's.</td> 7049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>queryRewriteFromText</th> 7069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If set, this flag causes the suggestion column SUGGEST_COLUMN_TEXT_1 to 7079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be considered as the text for suggestion query rewriting. This should 7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be used for suggestions in which no query text is provided and the 7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SUGGEST_COLUMN_INTENT_DATA values are not suitable for user inspection 7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and editing.</td> 7119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tbody> 7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </table></td> 7149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 7159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 7169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:inputType</th> 7189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, supplies a hint about the type of search text the user will be 7199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * entering. For most searches, in which free form text is expected, this attribute 7209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * need not be provided. Suitable values for this attribute are described in the 7219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="../R.attr.html#inputType">inputType</a> attribute.</td> 7229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 7239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 7249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:imeOptions</th> 7259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, supplies additional options for the input method. 7269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For most searches, in which free form text is expected, this attribute 7279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * need not be provided, and will default to "actionSearch". 7289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Suitable values for this attribute are described in the 7299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="../R.attr.html#imeOptions">imeOptions</a> attribute.</td> 7309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 7319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 7329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tbody> 7349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </table> 7359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Styleable Resources in your Metadata.</b> It's possible to provide alternate strings 7379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for your searchable application, in order to provide localization and/or to better visual 7389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * presentation on different device configurations. Each searchable activity has a single XML 7399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * metadata file, but any resource references can be replaced at runtime based on device 7409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * configuration, language setting, and other system inputs. 7419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>A concrete example is the "hint" text you supply using the android:searchHint attribute. 7439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * In portrait mode you'll have less screen space and may need to provide a shorter string, but 7449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in landscape mode you can provide a longer, more descriptive hint. To do this, you'll need to 7459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * define two or more strings.xml files, in the following directories: 7469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>.../res/values-land/strings.xml</li> 7479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>.../res/values-port/strings.xml</li> 7489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>.../res/values/strings.xml</li></ul> 7499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>For more complete documentation on this capability, see 7519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="{@docRoot}guide/topics/resources/resources-i18n.html#AlternateResources">Resources and 7529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Internationalization: Alternate Resources</a>. 7539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Metadata for non-searchable activities.</b> Activities which are part of a searchable 7559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * application, but don't implement search itself, require a bit of "glue" in order to cause 7569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * them to invoke search using your searchable activity as their primary context. If this is not 7579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provided, then searches from these activities will use the system default search context. 7589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The simplest way to specify this is to add a <i>search reference</i> element to the 7609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * application entry in the <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> file. 7619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The value of this reference can be either of: 7629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul><li>The name of your searchable activity. 7639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * It is typically prefixed by '.' to indicate that it's in the same package.</li> 7649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>A "*" indicates that the system may select a default searchable activity, in which 7659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * case it will typically select web-based search.</li> 7669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 7679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Here is a snippet showing the necessary addition to the manifest entry for your 7699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * non-searchable activities. 7709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 7719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <application> 7729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <meta-data android:name="android.app.default_searchable" 7739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:value=".MySearchActivity" /> 7749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <!-- followed by activities, providers, etc... --> 7769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </application></pre> 7779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>You can also specify android.app.default_searchable on a per-activity basis, by including 7799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the meta-data element (as shown above) in one or more activity sections. If found, these will 7809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * override the reference in the application section. The only reason to configure your application 7819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this way would be if you wish to partition it into separate sections with different search 7829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * behaviors; Otherwise this configuration is not recommended. 7839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7844c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <p><b>Additional metadata for search suggestions.</b> If you have defined a content provider 7859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to generate search suggestions, you'll need to publish it to the system, and you'll need to 7869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provide a bit of additional XML metadata in order to configure communications with it. 7879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>First, in your <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a>, you'll add the 7899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * following lines. 7909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 7919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <!-- Content provider for search suggestions --> 7929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <provider android:name="YourSuggestionProviderClass" 7939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:authorities="your.suggestion.authority" /></pre> 7949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Next, you'll add a few lines to your XML metadata file, as shown: 7969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 7979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <!-- Required attribute for any suggestions provider --> 7989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:searchSuggestAuthority="your.suggestion.authority" 7999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <!-- Optional attribute for configuring queries --> 8019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:searchSuggestSelection="field =?" 8029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <!-- Optional attributes for configuring intent construction --> 8049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:searchSuggestIntentAction="intent action string" 8059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:searchSuggestIntentData="intent data Uri" /></pre> 8069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Elements of search metadata that support suggestions: 8089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 8099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <thead> 8119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 8129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </thead> 8139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tbody> 8159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:searchSuggestAuthority</th> 8169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>This value must match the authority string provided in the <i>provider</i> section 8179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of your <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a>.</td> 8189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">Yes</td> 8199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 8209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:searchSuggestPath</th> 8229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, this will be inserted in the suggestions query Uri, after the authority 8239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you have provide but before the standard suggestions path. This is only required if 8249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you have a single content provider issuing different types of suggestions (e.g. for 8259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * different data types) and you need a way to disambiguate the suggestions queries 8269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when they are received.</td> 8279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 8289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 8299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:searchSuggestSelection</th> 8319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, this value will be passed into your query function as the 8329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <i>selection</i> parameter. Typically this will be a WHERE clause for your database, 8339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and will contain a single question mark, which represents the actual query string 8349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that has been typed by the user. However, you can also use any non-null value 8359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to simply trigger the delivery of the query text (via selection arguments), and then 8369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * use the query text in any way appropriate for your provider (ignoring the actual 8379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * text of the selection parameter.)</td> 8389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 8399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 8409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:searchSuggestIntentAction</th> 8429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, and not overridden by the selected suggestion, this value will be 8439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * placed in the action field of the {@link android.content.Intent Intent} when the 8449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user clicks a suggestion.</td> 8459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 8469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:searchSuggestIntentData</th> 8489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If provided, and not overridden by the selected suggestion, this value will be 8499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * placed in the data field of the {@link android.content.Intent Intent} when the user 8509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clicks a suggestion.</td> 8519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 8529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 8539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tbody> 8559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </table> 8569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8574c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <p><b>Additional metadata for search action keys.</b> For each action key that you would like to 8589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * define, you'll need to add an additional element defining that key, and using the attributes 8599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * discussed in <a href="#ActionKeys">Action Keys</a>. A simple example is shown here: 8609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"><actionkey 8629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:keycode="KEYCODE_CALL" 8639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:queryActionMsg="call" 8649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:suggestActionMsg="call" 8659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:suggestActionMsgColumn="call_column" /></pre> 8669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Elements of search metadata that support search action keys. Note that although each of the 8689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * action message elements are marked as <i>optional</i>, at least one must be present for the 8699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * action key to have any effect. 8709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 8729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <thead> 8749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 8759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </thead> 8769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tbody> 8789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:keycode</th> 8799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>This attribute denotes the action key you wish to respond to. Note that not 8809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * all action keys are actually supported using this mechanism, as many of them are 8819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * used for typing, navigation, or system functions. This will be added to the 8829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to 8839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your searchable activity. To examine the key code, use 8849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getIntExtra getIntExtra(SearchManager.ACTION_KEY)}. 8859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Note, in addition to the keycode, you must also provide one or more of the action 8869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * specifier attributes.</td> 8879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">Yes</td> 8889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 8899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:queryActionMsg</th> 8919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If you wish to handle an action key during normal search query entry, you 8929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * must define an action string here. This will be added to the 8939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to your 8949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * searchable activity. To examine the string, use 8959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getStringExtra 8969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * getStringExtra(SearchManager.ACTION_MSG)}.</td> 8979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 8989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 8999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:suggestActionMsg</th> 9019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If you wish to handle an action key while a suggestion is being displayed <i>and 9029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * selected</i>, there are two ways to handle this. If <i>all</i> of your suggestions 9039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can handle the action key, you can simply define the action message using this 9049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attribute. This will be added to the 9059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to 9069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your searchable activity. To examine the string, use 9079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getStringExtra 9089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * getStringExtra(SearchManager.ACTION_MSG)}.</td> 9099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 9109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 9119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>android:suggestActionMsgColumn</th> 9139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td>If you wish to handle an action key while a suggestion is being displayed <i>and 9149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * selected</i>, but you do not wish to enable this action key for every suggestion, 9159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * then you can use this attribute to control it on a suggestion-by-suggestion basis. 9169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * First, you must define a column (and name it here) where your suggestions will 9179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * include the action string. Then, in your content provider, you must provide this 9189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * column, and when desired, provide data in this column. 9199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The search manager will look at your suggestion cursor, using the string 9209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * provided here in order to select a column, and will use that to select a string from 9219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the cursor. That string will be added to the 9229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to 9239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your searchable activity. To examine the string, use 9249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getStringExtra 9259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * getStringExtra(SearchManager.ACTION_MSG)}. <i>If the data does not exist for the 9269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * selection suggestion, the action key will be ignored.</i></td> 9279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td align="center">No</td> 9289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 9299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tbody> 9319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </table> 9329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9334c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <p><b>Additional metadata for enabling voice search.</b> To enable voice search for your 9344c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * activity, you can add fields to the metadata that enable and configure voice search. When 9354c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * enabled (and available on the device), a voice search button will be displayed in the 9364c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * Search UI. Clicking this button will launch a voice search activity. When the user has 9374c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * finished speaking, the voice search phrase will be transcribed into text and presented to the 9384c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * searchable activity as if it were a typed query. 9394c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 9404c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <p>Elements of search metadata that support voice search: 9414c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 9424c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 9434c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <thead> 9444c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 9454c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </thead> 9464c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 9474c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>android:voiceSearchMode</th> 9484c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If provided and non-zero, enables voice search. (Voice search may not be 9494c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * provided by the device, in which case these flags will have no effect.) The 9504c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * following mode bits are defined: 9514c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <table border="2" align="center" frame="hsides" rules="rows"> 9524c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tbody> 9534c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>showVoiceSearchButton</th> 9544c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If set, display a voice search button. This only takes effect if voice 9554c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * search is available on the device. If set, then launchWebSearch or 9564c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * launchRecognizer must also be set.</td> 9574c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 9584c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>launchWebSearch</th> 9594c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If set, the voice search button will take the user directly to a 9604c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * built-in voice web search activity. Most applications will not use this 9614c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * flag, as it will take the user away from the activity in which search 9624c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * was invoked.</td> 9634c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 9644c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>launchRecognizer</th> 9654c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If set, the voice search button will take the user directly to a 9664c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * built-in voice recording activity. This activity will prompt the user 9674c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * to speak, transcribe the spoken text, and forward the resulting query 9684c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * text to the searchable activity, just as if the user had typed it into 9694c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * the search UI and clicked the search button.</td> 9704c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 9714c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tbody> 9724c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </table></td> 9734c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td align="center">No</td> 9744c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 9754c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 9764c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>android:voiceLanguageModel</th> 9774c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If provided, this specifies the language model that should be used by the voice 9784c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * recognition system. 9794c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * See {@link android.speech.RecognizerIntent#EXTRA_LANGUAGE_MODEL} 9804c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * for more information. If not provided, the default value 9814c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * {@link android.speech.RecognizerIntent#LANGUAGE_MODEL_FREE_FORM} will be used.</td> 9824c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td align="center">No</td> 9834c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 9844c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 9854c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>android:voicePromptText</th> 9864c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If provided, this specifies a prompt that will be displayed during voice input. 9874c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * (If not provided, a default prompt will be displayed.)</td> 9884c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td align="center">No</td> 9894c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 9904c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 9914c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>android:voiceLanguage</th> 9924c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If provided, this specifies the spoken language to be expected. This is only 9934c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * needed if it is different from the current value of 9944c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * {@link java.util.Locale#getDefault()}. 9954c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </td> 9964c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td align="center">No</td> 9974c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 9984c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 9994c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <tr><th>android:voiceMaxResults</th> 10004c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td>If provided, enforces the maximum number of results to return, including the "best" 10014c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * result which will always be provided as the SEARCH intent's primary query. Must be 10024c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * one or greater. Use {@link android.speech.RecognizerIntent#EXTRA_RESULTS} 10034c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * to get the results from the intent. If not provided, the recognizer will choose 10044c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * how many results to return.</td> 10054c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * <td align="center">No</td> 10064c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tr> 10074c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 10084c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </tbody> 10094c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * </table> 10104c156ec6ec9adcb407189ee57e0c205039b60148Andy Stadler * 10119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="PassingSearchContext"></a> 10129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Passing Search Context</h3> 10139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>In order to improve search experience, an application may wish to specify 10159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * additional data along with the search, such as local history or context. For 10169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * example, a maps search would be improved by including the current location. 10179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * In order to simplify the structure of your activities, this can be done using 10189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the search manager. 10199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Any data can be provided at the time the search is launched, as long as it 10219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can be stored in a {@link android.os.Bundle Bundle} object. 10229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>To pass application data into the Search Manager, you'll need to override 10249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onSearchRequested onSearchRequested} as follows: 10259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 10279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @Override 10289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * public boolean onSearchRequested() { 10299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Bundle appData = new Bundle(); 10309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appData.put...(); 10319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appData.put...(); 10329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * startSearch(null, false, appData); 10339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return true; 10349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * }</pre> 10359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>To receive application data from the Search Manager, you'll extract it from 10379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 10389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent Intent} as follows: 10399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre class="prettyprint"> 10419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * final Bundle appData = queryIntent.getBundleExtra(SearchManager.APP_DATA); 10429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if (appData != null) { 10439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appData.get...(); 10449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appData.get...(); 10459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * }</pre> 10469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="ProtectingUserPrivacy"></a> 10489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Protecting User Privacy</h3> 10499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Many users consider their activities on the phone, including searches, to be private 10519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information. Applications that implement search should take steps to protect users' privacy 10529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * wherever possible. This section covers two areas of concern, but you should consider your search 10539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * design carefully and take any additional steps necessary. 10549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Don't send personal information to servers, and if you do, don't log it.</b> 10569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * "Personal information" is information that can personally identify your users, such as name, 10579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * email address or billing information, or other data which can be reasonably linked to such 10589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information. If your application implements search with the assistance of a server, try to 10599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * avoid sending personal information with your searches. For example, if you are searching for 10609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * businesses near a zip code, you don't need to send the user ID as well - just send the zip code 10619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to the server. If you do need to send personal information, you should take steps to avoid 10629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * logging it. If you must log it, you should protect that data very carefully, and erase it as 10639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * soon as possible. 10649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Provide the user with a way to clear their search history.</b> The Search Manager helps 10669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your application provide context-specific suggestions. Sometimes these suggestions are based 10679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * on previous searches, or other actions taken by the user in an earlier session. A user may not 10689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * wish for previous searches to be revealed to other users, for instance if they share their phone 10699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with a friend. If your application provides suggestions that can reveal previous activities, 10709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you should implement a "Clear History" menu, preference, or button. If you are using 10719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.provider.SearchRecentSuggestions}, you can simply call its 10729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.provider.SearchRecentSuggestions#clearHistory() clearHistory()} method from 10739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your "Clear History" UI. If you are implementing your own form of recent suggestions, you'll 10749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * need to provide a similar a "clear history" API in your provider, and call it from your 10759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * "Clear History" UI. 10769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class SearchManager 10789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project implements DialogInterface.OnDismissListener, DialogInterface.OnCancelListener 10799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project{ 10808d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 10818d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert private static final boolean DBG = false; 10828d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert private static final String TAG = "SearchManager"; 10838d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 10849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is a shortcut definition for the default menu key to use for invoking search. 10869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See Menu.Item.setAlphabeticShortcut() for more information. 10889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static char MENU_KEY = 's'; 10909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is a shortcut definition for the default menu key to use for invoking search. 10939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See Menu.Item.setAlphabeticShortcut() for more information. 10959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static int MENU_KEYCODE = KeyEvent.KEYCODE_S; 10979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent extra data key: Use this key with 11009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getStringExtra 11019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * content.Intent.getStringExtra()} 11029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to obtain the query string from Intent.ACTION_SEARCH. 11039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String QUERY = "query"; 11059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11075f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * Intent extra data key: Use this key with 11085f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * {@link android.content.Intent#getStringExtra 11095f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * content.Intent.getStringExtra()} 11105f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * to obtain the query string typed in by the user. 11115f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * This may be different from the value of {@link #QUERY} 11125f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * if the intent is the result of selecting a suggestion. 11135f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * In that case, {@link #QUERY} will contain the value of 11145f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * {@link #SUGGEST_COLUMN_QUERY} for the suggestion, and 11155f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * {@link #USER_QUERY} will contain the string typed by the 11165f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert * user. 11175f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert */ 11185f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert public final static String USER_QUERY = "user_query"; 11195f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert 11205f80605a0b866f34c74955e190909bd6ab5d992eBjorn Bringert /** 11219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 11229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getBundleExtra 11239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * content.Intent.getBundleExtra()} 11249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to obtain any additional app-specific data that was inserted by the 11259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * activity that launched the search. 11269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String APP_DATA = "app_data"; 11289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent app_data bundle key: Use this key with the bundle from 11319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getBundleExtra 11329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * content.Intent.getBundleExtra(APP_DATA)} to obtain the source identifier 11339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * set by the activity that launched the search. 11349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @hide 11369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SOURCE = "source"; 1138a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen 11399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 11419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getIntExtra content.Intent.getIntExtra()} 11429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to obtain the keycode that the user used to trigger this query. It will be zero if the 11439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user simply pressed the "GO" button on the search UI. This is primarily used in conjunction 11449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with the keycode attribute in the actionkey element of your searchable.xml configuration 11459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * file. 11469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String ACTION_KEY = "action_key"; 11489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1150bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * Intent component name key: This key will be used for the extra populated by the 1151bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * {@link #SUGGEST_COLUMN_INTENT_COMPONENT_NAME} column. 1152bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * 1153bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * {@hide} 1154bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath */ 1155bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath public final static String COMPONENT_NAME_KEY = "intent_component_name_key"; 1156bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath 1157bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath /** 1158875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * Intent extra data key: This key will be used for the extra populated by the 1159875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * {@link #SUGGEST_COLUMN_INTENT_EXTRA_DATA} column. 1160875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen */ 1161875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen public final static String EXTRA_DATA_KEY = "intent_extra_data_key"; 1162a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen 1163a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen /** 11641c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * Defines the constants used in the communication between {@link android.app.SearchDialog} and 11651c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * the global search provider via {@link Cursor#respond(android.os.Bundle)}. 1166a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * 11671c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * @hide 1168a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen */ 11691c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public static class DialogCursorProtocol { 1170a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen 11711c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen /** 11721c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * The sent bundle will contain this integer key, with a value set to one of the events 11731c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * below. 11741c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen */ 11751c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static String METHOD = "DialogCursorProtocol.method"; 1176a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen 11771c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen /** 11781c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * After data has been refreshed. 11791c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen */ 11801c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static int POST_REFRESH = 0; 11811c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static String POST_REFRESH_RECEIVE_ISPENDING 11821c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen = "DialogCursorProtocol.POST_REFRESH.isPending"; 11831c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static String POST_REFRESH_RECEIVE_DISPLAY_NOTIFY 11841c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen = "DialogCursorProtocol.POST_REFRESH.displayNotify"; 11851c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen 11861c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen /** 11871c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * When a position has been clicked. 11881c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen */ 11891c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static int CLICK = 2; 11901c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static String CLICK_SEND_POSITION 11911c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen = "DialogCursorProtocol.CLICK.sendPosition"; 11926ddaa3497ce7af2c303771365449501e2be52511Bjorn Bringert public final static String CLICK_SEND_MAX_DISPLAY_POS 11936ddaa3497ce7af2c303771365449501e2be52511Bjorn Bringert = "DialogCursorProtocol.CLICK.sendDisplayPosition"; 11941c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static String CLICK_RECEIVE_SELECTED_POS 11951c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen = "DialogCursorProtocol.CLICK.receiveSelectedPosition"; 11961c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen 11971c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen /** 11981c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen * When the threshold received in {@link #POST_REFRESH_RECEIVE_DISPLAY_NOTIFY} is displayed. 11991c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen */ 12001c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen public final static int THRESH_HIT = 3; 12011c54cf0903cd81467ca41ec6733c459e10b22763Karl Rosaen } 1202a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen 1203875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen /** 12049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 12059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#getStringExtra content.Intent.getStringExtra()} 12069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to obtain the action message that was defined for a particular search action key and/or 12079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * suggestion. It will be null if the search was launched by typing "enter", touched the the 12089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * "GO" button, or other means not involving any action key. 12099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String ACTION_MSG = "action_msg"; 12119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Uri path for queried suggestions data. This is the path that the search manager 12149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will use when querying your content provider for suggestions data based on user input 12159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (e.g. looking for partial matches). 12169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Typically you'll use this with a URI matcher. 12179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_URI_PATH_QUERY = "search_suggest_query"; 1219b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen 1220b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen /** 1221b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen * MIME type for suggestions data. You'll use this in your suggestions content provider 1222b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen * in the getType() function. 1223b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen */ 1224b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen public final static String SUGGEST_MIME_TYPE = 1225b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen "vnd.android.cursor.dir/vnd.android.search.suggest"; 1226b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen 1227b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen /** 1228b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * Uri path for shortcut validation. This is the path that the search manager will use when 1229b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * querying your content provider to refresh a shortcutted suggestion result and to check if it 1230b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * is still valid. When asked, a source may return an up to date result, or no result. No 1231b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * result indicates the shortcut refers to a no longer valid sugggestion. 1232b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * 1233b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * @see #SUGGEST_COLUMN_SHORTCUT_ID 1234b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen */ 1235b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen public final static String SUGGEST_URI_PATH_SHORTCUT = "search_suggest_shortcut"; 12369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1238b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen * MIME type for shortcut validation. You'll use this in your suggestions content provider 12399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in the getType() function. 12409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1241b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen public final static String SHORTCUT_MIME_TYPE = 1242b619c9198efa0108a692d352b0e7eaa534f922f3Karl Rosaen "vnd.android.cursor.item/vnd.android.search.suggest"; 1243d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen 1244d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen 1245d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen /** 1246d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * The authority of the provider to report clicks to when a click is detected after pivoting 1247d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * into a specific app's search from global search. 1248d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * 1249d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * In addition to the columns below, the suggestion columns are used to pass along the full 1250d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * suggestion so it can be shortcutted. 1251d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * 1252d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * @hide 1253d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen */ 1254d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen public final static String SEARCH_CLICK_REPORT_AUTHORITY = 1255d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen "com.android.globalsearch.stats"; 1256d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen 1257d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen /** 1258d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * The path the write goes to. 1259d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * 1260d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * @hide 1261d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen */ 1262d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen public final static String SEARCH_CLICK_REPORT_URI_PATH = "click"; 1263d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen 1264d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen /** 1265d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * The column storing the query for the click. 1266d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * 1267d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * @hide 1268d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen */ 1269d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen public final static String SEARCH_CLICK_REPORT_COLUMN_QUERY = "query"; 1270d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen 1271d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen /** 1272d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * The column storing the component name of the application that was pivoted into. 1273d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * 1274d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen * @hide 1275d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen */ 1276d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen public final static String SEARCH_CLICK_REPORT_COLUMN_COMPONENT = "component"; 1277d4c98c4c450a95b67fe9746675984333b7653713Karl Rosaen 12789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Unused - can be null or column can be omitted.</i> 12809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_FORMAT = "suggest_format"; 12829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Required.</i> This is the primary line of text that 12849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be presented to the user as the suggestion. 12859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_TEXT_1 = "suggest_text_1"; 12879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 12899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * then all suggestions will be provided in a two-line format. The second line of text is in 12909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a much smaller appearance. 12919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_TEXT_2 = "suggest_text_2"; 12939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 1295875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * then all suggestions will be provided in a format that includes space for two small icons, 12969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * one at the left and one at the right of each suggestion. The data in the column must 1297875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * be a resource ID of a drawable, or a URI in one of the following formats: 1298875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1299875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <ul> 1300875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 1301875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 1302875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> 1303875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * </ul> 1304875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1305875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} 1306875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * for more information on these schemes. 13079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_ICON_1 = "suggest_icon_1"; 13099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 1311875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * then all suggestions will be provided in a format that includes space for two small icons, 13129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * one at the left and one at the right of each suggestion. The data in the column must 1313875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * be a resource ID of a drawable, or a URI in one of the following formats: 1314875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1315875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <ul> 1316875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 1317875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 1318875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> 1319875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * </ul> 1320875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1321875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} 1322875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * for more information on these schemes. 13239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_ICON_2 = "suggest_icon_2"; 13259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 13279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this element exists at the given row, this is the action that will be used when 13289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * forming the suggestion's intent. If the element is not provided, the action will be taken 13299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * from the android:searchSuggestIntentAction field in your XML metadata. <i>At least one of 13309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * these must be present for the suggestion to generate an intent.</i> Note: If your action is 13319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the same for all suggestions, it is more efficient to specify it using XML metadata and omit 13329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it from the cursor. 13339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_INTENT_ACTION = "suggest_intent_action"; 13359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 13379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this element exists at the given row, this is the data that will be used when 13389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * forming the suggestion's intent. If the element is not provided, the data will be taken 13399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * from the android:searchSuggestIntentData field in your XML metadata. If neither source 13409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is provided, the Intent's data field will be null. Note: If your data is 13419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the same for all suggestions, or can be described using a constant part and a specific ID, 13429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it is more efficient to specify it using XML metadata and omit it from the cursor. 13439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_INTENT_DATA = "suggest_intent_data"; 13459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1346bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 1347bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * this element exists at the given row, this is the data that will be used when 1348bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * forming the suggestion's intent. If not provided, the Intent's extra data field will be null. 1349bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * This column allows suggestions to provide additional arbitrary data which will be included as 1350131234c6f134c586208ec94bfe4ae021b057cf66Mike LeBeau * an extra under the key {@link #EXTRA_DATA_KEY}. 1351bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath */ 1352bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath public final static String SUGGEST_COLUMN_INTENT_EXTRA_DATA = "suggest_intent_extra_data"; 1353bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath /** 1354875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * Column name for suggestions cursor. <i>Optional.</i> This column allows suggestions 1355875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * to provide additional arbitrary data which will be included as an extra under the key 1356bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath * {@link #COMPONENT_NAME_KEY}. For use by the global search system only - if other providers 135721fd5f144a3e6919ff6b4e8a1a733c940d5dd6dfMike LeBeau * attempt to use this column, the value will be overwritten by global search. 1358a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * 135921fd5f144a3e6919ff6b4e8a1a733c940d5dd6dfMike LeBeau * @hide 1360875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen */ 1361bf23fe062ab4321143717c21827d329e087cc72fSatish Sampath public final static String SUGGEST_COLUMN_INTENT_COMPONENT_NAME = "suggest_intent_component"; 1362875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen /** 13639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 13649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this element exists at the given row, then "/" and this value will be appended to the data 13659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * field in the Intent. This should only be used if the data field has already been set to an 13669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appropriate base string. 13679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_INTENT_DATA_ID = "suggest_intent_data_id"; 13699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Column name for suggestions cursor. <i>Required if action is 13719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH}, optional otherwise.</i> If this 13729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * column exists <i>and</i> this element exists at the given row, this is the data that will be 13739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * used when forming the suggestion's query. 13749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final static String SUGGEST_COLUMN_QUERY = "suggest_intent_query"; 13769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1377875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen /** 1378b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * Column name for suggestions cursor. <i>Optional.</i> This column is used to indicate whether 1379b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * a search suggestion should be stored as a shortcut, and whether it should be validated. If 1380b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * missing, the result will be stored as a shortcut and never validated. If set to 1381b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * {@link #SUGGEST_NEVER_MAKE_SHORTCUT}, the result will not be stored as a shortcut. 1382b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * Otherwise, the shortcut id will be used to check back for validation via 1383b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * {@link #SUGGEST_URI_PATH_SHORTCUT}. 1384b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen */ 1385b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen public final static String SUGGEST_COLUMN_SHORTCUT_ID = "suggest_shortcut_id"; 1386b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen 1387b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen /** 13881c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify the 13891c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath * cursor item's background color if it needs a non-default background color. A non-zero value 13901c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath * indicates a valid background color to override the default. 13911c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath * 13921c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath * @hide For internal use, not part of the public API. 13931c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath */ 13941c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath public final static String SUGGEST_COLUMN_BACKGROUND_COLOR = "suggest_background_color"; 1395ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau 1396ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau /** 1397ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify 1398ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau * that a spinner should be shown in lieu of an icon2 while the shortcut of this suggestion 1399ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau * is being refreshed. 1400ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau */ 1401ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau public final static String SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING = 1402ce0959df5ca49cf8f726adddb65978da83e42544Mike LeBeau "suggest_spinner_while_refreshing"; 14031c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath 14041c5fa0f31009502c539c65de99010b63cb617aacSatish Sampath /** 1405b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * Column value for suggestion column {@link #SUGGEST_COLUMN_SHORTCUT_ID} when a suggestion 1406b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen * should not be stored as a shortcut in global search. 1407b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen */ 1408b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen public final static String SUGGEST_NEVER_MAKE_SHORTCUT = "_-1"; 1409b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen 1410b2a5011578d4a64df2f39bdeeedfe9f37e7aecc4Karl Rosaen /** 1411875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * If a suggestion has this value in {@link #SUGGEST_COLUMN_INTENT_ACTION}, 1412875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * the search dialog will switch to a different suggestion source when the 1413875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * suggestion is clicked. 1414875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1415875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * {@link #SUGGEST_COLUMN_INTENT_DATA} must contain 1416875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * the flattened {@link ComponentName} of the activity which is to be searched. 1417875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1418875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * TODO: Should {@link #SUGGEST_COLUMN_INTENT_DATA} instead contain a URI in the format 1419875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * used by {@link android.provider.Applications}? 1420875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1421875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * TODO: This intent should be protected by the same permission that we use 1422875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * for replacing the global search provider. 1423875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1424875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * The query text field will be set to the value of {@link #SUGGEST_COLUMN_QUERY}. 1425875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1426875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * @hide Pending API council approval. 1427875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen */ 1428875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen public final static String INTENT_ACTION_CHANGE_SEARCH_SOURCE 1429875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen = "android.search.action.CHANGE_SEARCH_SOURCE"; 1430a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen 1431875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen /** 143274708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert * Intent action for finding the global search activity. 143374708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert * The global search provider should handle this intent. 143474708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert * 143574708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert * @hide Pending API council approval. 143674708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert */ 143774708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert public final static String INTENT_ACTION_GLOBAL_SEARCH 143874708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert = "android.search.action.GLOBAL_SEARCH"; 143974708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert 144074708bbdf8d6f172b08343bdc578a20aa4b39148Bjorn Bringert /** 1441875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * Intent action for starting the global search settings activity. 1442875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * The global search provider should handle this intent. 1443875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1444875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * @hide Pending API council approval. 1445875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen */ 1446875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen public final static String INTENT_ACTION_SEARCH_SETTINGS 1447875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen = "android.search.action.SEARCH_SETTINGS"; 14483a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau 14493a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau /** 14503a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau * Intent action for starting a web search provider's settings activity. 14513a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau * Web search providers should handle this intent if they have provider-specific 14523a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau * settings to implement. 14533a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau */ 14543a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau public final static String INTENT_ACTION_WEB_SEARCH_SETTINGS 14553a27803b29dc739685e1e2465a0ca697e4b60d14Mike LeBeau = "android.search.action.WEB_SEARCH_SETTINGS"; 1456a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen 1457a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen /** 1458f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * Intent action broadcasted to inform that the searchables list or default have changed. 1459f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * Components should handle this intent if they cache any searchable data and wish to stay 1460f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * up to date on changes. 1461f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath */ 1462f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath public final static String INTENT_ACTION_SEARCHABLES_CHANGED 1463f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath = "android.search.action.SEARCHABLES_CHANGED"; 1464d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau 1465d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau /** 1466d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau * Intent action broadcasted to inform that the search settings have changed in some way. 1467d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau * Either searchables have been enabled or disabled, or a different web search provider 1468d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau * has been chosen. 1469d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau */ 1470d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau public final static String INTENT_ACTION_SEARCH_SETTINGS_CHANGED 1471d4fb7a0d90b16e360b7a7b64cb7a6fd94f084c27Mike LeBeau = "android.search.action.SETTINGS_CHANGED"; 1472f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath 1473f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath /** 1474a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * If a suggestion has this value in {@link #SUGGEST_COLUMN_INTENT_ACTION}, 1475a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * the search dialog will take no action. 1476a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * 1477a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * @hide 1478a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen */ 1479a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen public final static String INTENT_ACTION_NONE = "android.search.action.ZILCH"; 1480875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1481875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen /** 1482875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * Reference to the shared system search service. 1483875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen */ 14848d1538237847baf381787b881141f8c0478bef5bBjorn Bringert private static ISearchManager mService; 14859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final Context mContext; 14878d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 1488b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn private int mIdent; 1489b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn 14908d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert // package private since they are used by the inner class SearchManagerCallback 14918d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert /* package */ final Handler mHandler; 14928d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert /* package */ OnDismissListener mDismissListener = null; 14938d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert /* package */ OnCancelListener mCancelListener = null; 14948d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 14958d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert private final SearchManagerCallback mSearchManagerCallback = new SearchManagerCallback(); 14969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /*package*/ SearchManager(Context context, Handler handler) { 14989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mContext = context; 14999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mHandler = handler; 15008d1538237847baf381787b881141f8c0478bef5bBjorn Bringert mService = ISearchManager.Stub.asInterface( 15018d1538237847baf381787b881141f8c0478bef5bBjorn Bringert ServiceManager.getService(Context.SEARCH_SERVICE)); 15029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1503ec0a12cf199659a749ff1fe7b788626eddc095ebKarl Rosaen 1504ec0a12cf199659a749ff1fe7b788626eddc095ebKarl Rosaen /*package*/ boolean hasIdent() { 1505ec0a12cf199659a749ff1fe7b788626eddc095ebKarl Rosaen return mIdent != 0; 1506ec0a12cf199659a749ff1fe7b788626eddc095ebKarl Rosaen } 15079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1508b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn /*package*/ void setIdent(int ident) { 1509b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn if (mIdent != 0) { 1510b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn throw new IllegalStateException("mIdent already set"); 1511b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn } 1512b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn mIdent = ident; 1513b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn } 1514b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn 15159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Launch search UI. 15179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The search manager will open a search widget in an overlapping 15199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * window, and the underlying activity may be obscured. The search 15209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * entry state will remain in effect until one of the following events: 15219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 15229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>The user completes the search. In most cases this will launch 15239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a search intent.</li> 15249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>The user uses the back, home, or other keys to exit the search.</li> 15259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>The application calls the {@link #stopSearch} 15269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * method, which will hide the search window and return focus to the 15279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * activity from which it was launched.</li> 15289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Most applications will <i>not</i> use this interface to invoke search. 15309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The primary method for invoking search is to call 15319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onSearchRequested Activity.onSearchRequested()} or 15329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#startSearch Activity.startSearch()}. 15339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param initialQuery A search string can be pre-entered here, but this 15359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is typically null or empty. 15369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectInitialQuery If true, the intial query will be preselected, which means that 15379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * any further typing will replace it. This is useful for cases where an entire pre-formed 15389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * query is being inserted. If false, the selection point will be placed at the end of the 15399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * inserted query. This is useful when the inserted query is text that the user entered, 15409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and the user would expect to be able to keep typing. <i>This parameter is only meaningful 15419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if initialQuery is a non-empty string.</i> 15429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param launchActivity The ComponentName of the activity that has launched this search. 15439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param appSearchData An application can insert application-specific 15449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * context here, in order to improve quality or specificity of its own 15459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * searches. This data will be returned with SEARCH intent(s). Null if 15469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * no extra data is required. 15479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param globalSearch If false, this will only launch the search that has been specifically 15489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * defined by the application (which is usually defined as a local search). If no default 15499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * search is defined in the current application or activity, no search will be launched. 15509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If true, this will always launch a platform-global (e.g. web-based) search instead. 15519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see android.app.Activity#onSearchRequested 15539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #stopSearch 15549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void startSearch(String initialQuery, 15569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean selectInitialQuery, 15579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ComponentName launchActivity, 15589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Bundle appSearchData, 15599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean globalSearch) { 1560b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn if (mIdent == 0) throw new IllegalArgumentException( 1561b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn "Called from outside of an Activity context"); 15628d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert try { 15638d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert // activate the search manager and start it up! 15648d1538237847baf381787b881141f8c0478bef5bBjorn Bringert mService.startSearch(initialQuery, selectInitialQuery, launchActivity, appSearchData, 1565b06ea706530e6d19eb2a1a9a7ae6c5dd77d80af0Dianne Hackborn globalSearch, mSearchManagerCallback, mIdent); 15668d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } catch (RemoteException ex) { 15678d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Log.e(TAG, "startSearch() failed: " + ex); 15689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Terminate search UI. 15739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Typically the user will terminate the search UI by launching a 15759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * search or by canceling. This function allows the underlying application 15769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or activity to cancel the search prematurely (for any reason). 15779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This function can be safely called at any time (even if no search is active.) 15799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #startSearch 15819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15828d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void stopSearch() { 1583ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen if (DBG) debug("stopSearch()"); 15848d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert try { 15858d1538237847baf381787b881141f8c0478bef5bBjorn Bringert mService.stopSearch(); 15868d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } catch (RemoteException ex) { 15879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Determine if the Search UI is currently displayed. 15929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is provided primarily for application test purposes. 15949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the search UI is currently displayed. 15969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @hide 15989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15998d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public boolean isVisible() { 1600ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen if (DBG) debug("isVisible()"); 1601ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen try { 1602ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen return mService.isVisible(); 1603ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen } catch (RemoteException e) { 1604ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen Log.e(TAG, "isVisible() failed: " + e); 1605ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen return false; 1606ea52d29bc46c306f3607d121aa1ad84f0e9eb473Karl Rosaen } 16079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16088d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1610a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * See {@link SearchManager#setOnDismissListener} for configuring your activity to monitor 1611a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * search UI state. 16129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface OnDismissListener { 16149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1615a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * This method will be called when the search UI is dismissed. To make use of it, you must 1616a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * implement this method in your activity, and call 1617a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * {@link SearchManager#setOnDismissListener} to register it. 16189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void onDismiss(); 16209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1623a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * See {@link SearchManager#setOnCancelListener} for configuring your activity to monitor 1624a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * search UI state. 16259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface OnCancelListener { 16279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This method will be called when the search UI is canceled. To make use if it, you must 1629a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * implement this method in your activity, and call 1630a058f02b591d971a829cb1e28d48a992e46ad85eKarl Rosaen * {@link SearchManager#setOnCancelListener} to register it. 16319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void onCancel(); 16339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set or clear the callback that will be invoked whenever the search UI is dismissed. 16379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param listener The {@link OnDismissListener} to use, or null. 16399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setOnDismissListener(final OnDismissListener listener) { 16419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDismissListener = listener; 16429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set or clear the callback that will be invoked whenever the search UI is canceled. 16469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param listener The {@link OnCancelListener} to use, or null. 16489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16498d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void setOnCancelListener(OnCancelListener listener) { 16509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCancelListener = listener; 16519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16528d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16538d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert private class SearchManagerCallback extends ISearchManagerCallback.Stub { 16548d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16558d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert private final Runnable mFireOnDismiss = new Runnable() { 16568d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void run() { 16578d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert if (DBG) debug("mFireOnDismiss"); 16588d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert if (mDismissListener != null) { 16598d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert mDismissListener.onDismiss(); 16608d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } 16618d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } 16628d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert }; 16638d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16648d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert private final Runnable mFireOnCancel = new Runnable() { 16658d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void run() { 16668d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert if (DBG) debug("mFireOnCancel"); 16678d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert if (mCancelListener != null) { 16688d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert mCancelListener.onCancel(); 16698d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } 16709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16718d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert }; 16728d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16738d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void onDismiss() { 16748d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert if (DBG) debug("onDismiss()"); 16758d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert mHandler.post(mFireOnDismiss); 16768d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } 16778d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16788d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void onCancel() { 16798d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert if (DBG) debug("onCancel()"); 16808d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert mHandler.post(mFireOnCancel); 16819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16828d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16838d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } 16848d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 16850e01ea41b215941128a4ea8dee454e6b35a4e798Bjorn Bringert /** 16860e01ea41b215941128a4ea8dee454e6b35a4e798Bjorn Bringert * @deprecated This method is an obsolete internal implementation detail. Do not use. 16870e01ea41b215941128a4ea8dee454e6b35a4e798Bjorn Bringert */ 16888d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void onCancel(DialogInterface dialog) { 16898d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert throw new UnsupportedOperationException(); 16908d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } 16910e01ea41b215941128a4ea8dee454e6b35a4e798Bjorn Bringert 16920e01ea41b215941128a4ea8dee454e6b35a4e798Bjorn Bringert /** 16930e01ea41b215941128a4ea8dee454e6b35a4e798Bjorn Bringert * @deprecated This method is an obsolete internal implementation detail. Do not use. 16940e01ea41b215941128a4ea8dee454e6b35a4e798Bjorn Bringert */ 16958d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert public void onDismiss(DialogInterface dialog) { 16968d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert throw new UnsupportedOperationException(); 16979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1700875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * Gets information about a searchable activity. This method is static so that it can 1701875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * be used from non-Activity contexts. 1702875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1703875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * @param componentName The activity to get searchable information for. 1704875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * @param globalSearch If <code>false</code>, return information about the given activity. 1705875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * If <code>true</code>, return information about the global search activity. 1706875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * @return Searchable information, or <code>null</code> if the activity is not searchable. 1707875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1708875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * @hide because SearchableInfo is not part of the API. 1709875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen */ 17108d1538237847baf381787b881141f8c0478bef5bBjorn Bringert public SearchableInfo getSearchableInfo(ComponentName componentName, 1711875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen boolean globalSearch) { 1712875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen try { 17138d1538237847baf381787b881141f8c0478bef5bBjorn Bringert return mService.getSearchableInfo(componentName, globalSearch); 17148d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } catch (RemoteException ex) { 17158d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Log.e(TAG, "getSearchableInfo() failed: " + ex); 1716875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen return null; 1717875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 1718875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 1719875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1720875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen /** 1721875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * Checks whether the given searchable is the default searchable. 1722875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * 1723875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen * @hide because SearchableInfo is not part of the API. 1724875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen */ 17258d1538237847baf381787b881141f8c0478bef5bBjorn Bringert public boolean isDefaultSearchable(SearchableInfo searchable) { 17268d1538237847baf381787b881141f8c0478bef5bBjorn Bringert SearchableInfo defaultSearchable = getSearchableInfo(null, true); 1727875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen return defaultSearchable != null 1728a92041306e4d73baa10fb711fb905b9590f06b26Bjorn Bringert && defaultSearchable.getSearchActivity().equals(searchable.getSearchActivity()); 1729875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 17308d1538237847baf381787b881141f8c0478bef5bBjorn Bringert 1731875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen /** 173297325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert * Gets a cursor with search suggestions. 173397325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert * 173497325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert * @param searchable Information about how to get the suggestions. 173597325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert * @param query The search text entered (so far). 173697325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert * @return a cursor with suggestions, or <code>null</null> the suggestion query failed. 173797325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert * 173897325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert * @hide because SearchableInfo is not part of the API. 173997325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert */ 174097325db8565ad503b86d9a0f602b2d001b5cee13Bjorn Bringert public Cursor getSuggestions(SearchableInfo searchable, String query) { 1741875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen if (searchable == null) { 1742875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen return null; 1743875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 1744875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1745875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen String authority = searchable.getSuggestAuthority(); 1746875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen if (authority == null) { 1747875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen return null; 1748875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 1749875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1750875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen Uri.Builder uriBuilder = new Uri.Builder() 1751875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen .scheme(ContentResolver.SCHEME_CONTENT) 1752875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen .authority(authority); 1753875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1754875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen // if content path provided, insert it now 1755875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen final String contentPath = searchable.getSuggestPath(); 1756875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen if (contentPath != null) { 1757875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen uriBuilder.appendEncodedPath(contentPath); 1758875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 1759875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1760875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen // append standard suggestion query path 1761875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen uriBuilder.appendPath(SearchManager.SUGGEST_URI_PATH_QUERY); 1762875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1763875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen // get the query selection, may be null 1764875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen String selection = searchable.getSuggestSelection(); 1765875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen // inject query, either as selection args or inline 1766875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen String[] selArgs = null; 1767875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen if (selection != null) { // use selection if provided 1768875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen selArgs = new String[] { query }; 1769875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } else { // no selection, use REST pattern 1770875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen uriBuilder.appendPath(query); 1771875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 1772875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1773875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen Uri uri = uriBuilder 1774875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen .query("") // TODO: Remove, workaround for a bug in Uri.writeToParcel() 1775875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen .fragment("") // TODO: Remove, workaround for a bug in Uri.writeToParcel() 1776875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen .build(); 1777875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 1778875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen // finally, make the query 17798d1538237847baf381787b881141f8c0478bef5bBjorn Bringert return mContext.getContentResolver().query(uri, null, selection, selArgs, null); 1780875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen } 1781875d50a4b9294b2be33cff6493cae7acd1d07ea7Karl Rosaen 17826d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert /** 17836d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert * Returns a list of the searchable activities that can be included in global search. 17846d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert * 17856d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert * @return a list containing searchable information for all searchable activities 17866d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert * that have the <code>exported</code> attribute set in their searchable 17876d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert * meta-data. 17886d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert * 17896d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert * @hide because SearchableInfo is not part of the API. 17906d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert */ 17918d1538237847baf381787b881141f8c0478bef5bBjorn Bringert public List<SearchableInfo> getSearchablesInGlobalSearch() { 17926d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert try { 17938d1538237847baf381787b881141f8c0478bef5bBjorn Bringert return mService.getSearchablesInGlobalSearch(); 17946d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert } catch (RemoteException e) { 17958d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Log.e(TAG, "getSearchablesInGlobalSearch() failed: " + e); 17966d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert return null; 17976d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert } 17986d72e029cb6e5a9cf26aa3314c3dca83614fc91bBjorn Bringert } 1799f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath 1800f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath /** 1801f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * Returns a list of the searchable activities that handle web searches. 1802f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * 18038d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert * @return a list of all searchable activities that handle 18048d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert * {@link android.content.Intent#ACTION_WEB_SEARCH}. 1805f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * 1806f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * @hide because SearchableInfo is not part of the API. 1807f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath */ 18088d1538237847baf381787b881141f8c0478bef5bBjorn Bringert public List<SearchableInfo> getSearchablesForWebSearch() { 1809f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath try { 18108d1538237847baf381787b881141f8c0478bef5bBjorn Bringert return mService.getSearchablesForWebSearch(); 1811f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } catch (RemoteException e) { 18128d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Log.e(TAG, "getSearchablesForWebSearch() failed: " + e); 1813f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath return null; 1814f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } 1815f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } 1816f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath 1817f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath /** 1818f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * Returns the default searchable activity for web searches. 1819f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * 1820f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * @return searchable information for the activity handling web searches by default. 1821f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * 1822f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * @hide because SearchableInfo is not part of the API. 1823f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath */ 18248d1538237847baf381787b881141f8c0478bef5bBjorn Bringert public SearchableInfo getDefaultSearchableForWebSearch() { 1825f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath try { 18268d1538237847baf381787b881141f8c0478bef5bBjorn Bringert return mService.getDefaultSearchableForWebSearch(); 1827f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } catch (RemoteException e) { 18288d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Log.e(TAG, "getDefaultSearchableForWebSearch() failed: " + e); 1829f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath return null; 1830f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } 1831f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } 1832f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath 1833f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath /** 1834f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * Sets the default searchable activity for web searches. 1835f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * 1836f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * @param component Name of the component to set as default activity for web searches. 1837f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * 1838f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath * @hide 1839f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath */ 18408d1538237847baf381787b881141f8c0478bef5bBjorn Bringert public void setDefaultWebSearch(ComponentName component) { 1841f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath try { 18428d1538237847baf381787b881141f8c0478bef5bBjorn Bringert mService.setDefaultWebSearch(component); 1843f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } catch (RemoteException e) { 18448d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Log.e(TAG, "setDefaultWebSearch() failed: " + e); 1845f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } 1846f9acde27486bcc6eea1092073f7b47c31749efd6Satish Sampath } 18478d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert 18488d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert private static void debug(String msg) { 18498d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Thread thread = Thread.currentThread(); 18508d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert Log.d(TAG, msg + " (" + thread.getName() + "-" + thread.getId() + ")"); 18518d17f3f24bbda9a9cd7ea08c5925508dc2c011beBjorn Bringert } 18529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 1853