SearchManager.java revision ea125f45ebf25494ae190b2f338f359f830674df
1/* 2 * Copyright (C) 2007 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.app; 18 19import android.Manifest; 20import android.content.ActivityNotFoundException; 21import android.content.ComponentName; 22import android.content.ContentResolver; 23import android.content.Context; 24import android.content.DialogInterface; 25import android.content.Intent; 26import android.content.pm.ActivityInfo; 27import android.content.pm.PackageManager; 28import android.content.pm.ResolveInfo; 29import android.database.Cursor; 30import android.net.Uri; 31import android.os.Bundle; 32import android.os.Handler; 33import android.os.RemoteException; 34import android.os.ServiceManager; 35import android.text.TextUtils; 36import android.util.Log; 37import android.view.KeyEvent; 38 39import java.util.List; 40 41/** 42 * This class provides access to the system search services. 43 * 44 * <p>In practice, you won't interact with this class directly, as search 45 * services are provided through methods in {@link android.app.Activity Activity} 46 * methods and the the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 47 * {@link android.content.Intent Intent}. This class does provide a basic 48 * overview of search services and how to integrate them with your activities. 49 * If you do require direct access to the SearchManager, do not instantiate 50 * this class directly; instead, retrieve it through 51 * {@link android.content.Context#getSystemService 52 * context.getSystemService(Context.SEARCH_SERVICE)}. 53 * 54 * <p>Topics covered here: 55 * <ol> 56 * <li><a href="#DeveloperGuide">Developer Guide</a> 57 * <li><a href="#HowSearchIsInvoked">How Search Is Invoked</a> 58 * <li><a href="#ImplementingSearchForYourApp">Implementing Search for Your App</a> 59 * <li><a href="#Suggestions">Search Suggestions</a> 60 * <li><a href="#ExposingSearchSuggestionsToQuickSearchBox">Exposing Search Suggestions to 61 * Quick Search Box</a></li> 62 * <li><a href="#ActionKeys">Action Keys</a> 63 * <li><a href="#SearchabilityMetadata">Searchability Metadata</a> 64 * <li><a href="#PassingSearchContext">Passing Search Context</a> 65 * <li><a href="#ProtectingUserPrivacy">Protecting User Privacy</a> 66 * </ol> 67 * 68 * <a name="DeveloperGuide"></a> 69 * <h3>Developer Guide</h3> 70 * 71 * <p>The ability to search for user, system, or network based data is considered to be 72 * a core user-level feature of the Android platform. At any time, the user should be 73 * able to use a familiar command, button, or keystroke to invoke search, and the user 74 * should be able to search any data which is available to them. 75 * 76 * <p>To make search appear to the user as a seamless system-wide feature, the application 77 * framework centrally controls it, offering APIs to individual applications to control how they 78 * are searched. Applications can customize how search is invoked, how the search dialog looks, 79 * and what type of search results are available, including suggestions that are available as the 80 * user types. 81 * 82 * <p>Even applications which are not searchable will by default support the invocation of 83 * search to trigger Quick Search Box, the system's 'global search'. 84 * 85 * <a name="HowSearchIsInvoked"></a> 86 * <h3>How Search Is Invoked</h3> 87 * 88 * <p>Unless impossible or inapplicable, all applications should support 89 * invoking the search UI. This means that when the user invokes the search command, 90 * a search UI will be presented to them. The search command is currently defined as a menu 91 * item called "Search" (with an alphabetic shortcut key of "S"), or on many devices, a dedicated 92 * search button key. 93 * <p>If your application is not inherently searchable, the default implementation will cause 94 * the search UI to be invoked in a "global search" mode known as Quick Search Box. As the user 95 * types, search suggestions from across the device and the web will be surfaced, and if they 96 * click the "Search" button, this will bring the browser to the front and will launch a web-based 97 * search. The user will be able to click the "Back" button and return to your application. 98 * <p>In general this is implemented by your activity, or the {@link android.app.Activity Activity} 99 * base class, which captures the search command and invokes the SearchManager to 100 * display and operate the search UI. You can also cause the search UI to be presented in response 101 * to user keystrokes in your activity (for example, to instantly start filter searching while 102 * viewing a list and typing any key). 103 * <p>The search UI is presented as a floating 104 * window and does not cause any change in the activity stack. If the user 105 * cancels search, the previous activity re-emerges. If the user launches a 106 * search, this will be done by sending a search {@link android.content.Intent Intent} (see below), 107 * and the normal intent-handling sequence will take place (your activity will pause, 108 * etc.) 109 * <p><b>What you need to do:</b> First, you should consider the way in which you want to 110 * handle invoking search. There are four broad (and partially overlapping) categories for 111 * you to choose from. 112 * <ul><li>You can capture the search command yourself, by including a <i>search</i> 113 * button or menu item - and invoking the search UI directly.</li> 114 * <li>You can provide a <i>type-to-search</i> feature, in which search is invoked automatically 115 * when the user enters any characters.</li> 116 * <li>Even if your application is not inherently searchable, you can allow global search, 117 * via the search key (or even via a search menu item). 118 * <li>You can disable search entirely. This should only be used in very rare circumstances, 119 * as search is a system-wide feature and users will expect it to be available in all contexts.</li> 120 * </ul> 121 * 122 * <p><b>How to define a search menu.</b> The system provides the following resources which may 123 * be useful when adding a search item to your menu: 124 * <ul><li>android.R.drawable.ic_search_category_default is an icon you can use in your menu.</li> 125 * <li>{@link #MENU_KEY SearchManager.MENU_KEY} is the recommended alphabetic shortcut.</li> 126 * </ul> 127 * 128 * <p><b>How to invoke search directly.</b> In order to invoke search directly, from a button 129 * or menu item, you can launch a generic search by calling 130 * {@link android.app.Activity#onSearchRequested onSearchRequested} as shown: 131 * <pre class="prettyprint"> 132 * onSearchRequested();</pre> 133 * 134 * <p><b>How to implement type-to-search.</b> While setting up your activity, call 135 * {@link android.app.Activity#setDefaultKeyMode setDefaultKeyMode}: 136 * <pre class="prettyprint"> 137 * setDefaultKeyMode(DEFAULT_KEYS_SEARCH_LOCAL); // search within your activity 138 * setDefaultKeyMode(DEFAULT_KEYS_SEARCH_GLOBAL); // search using platform global search</pre> 139 * 140 * <p><b>How to enable global search with Quick Search Box.</b> In addition to searching within 141 * your activity or application, you can also use the Search Manager to invoke a platform-global 142 * search, which uses Quick Search Box to search across the device and the web. There are two ways 143 * to do this: 144 * <ul><li>You can simply define "search" within your application or activity to mean global search. 145 * This is described in more detail in the 146 * <a href="#SearchabilityMetadata">Searchability Metadata</a> section. Briefly, you will 147 * add a single meta-data entry to your manifest, declaring that the default search 148 * for your application is "*". This indicates to the system that no application-specific 149 * search activity is provided, and that it should launch web-based search instead.</li> 150 * <li>Simply do nothing and the default implementation of 151 * {@link android.app.Activity#onSearchRequested} will cause global search to be triggered. 152 * (You can also always trigger search via a direct call to {@link android.app.Activity#startSearch}. 153 * This is most useful if you wish to provide local searchability <i>and</i> access to global 154 * search.)</li></ul> 155 * 156 * <p><b>How to disable search from your activity.</b> Search is a system-wide feature and users 157 * will expect it to be available in all contexts. If your UI design absolutely precludes 158 * launching search, override {@link android.app.Activity#onSearchRequested onSearchRequested} 159 * as shown: 160 * <pre class="prettyprint"> 161 * @Override 162 * public boolean onSearchRequested() { 163 * return false; 164 * }</pre> 165 * 166 * <p><b>Managing focus and knowing if search is active.</b> The search UI is not a separate 167 * activity, and when the UI is invoked or dismissed, your activity will not typically be paused, 168 * resumed, or otherwise notified by the methods defined in 169 * <a href="{@docRoot}guide/topics/fundamentals.html#actlife">Application Fundamentals: 170 * Activity Lifecycle</a>. The search UI is 171 * handled in the same way as other system UI elements which may appear from time to time, such as 172 * notifications, screen locks, or other system alerts: 173 * <p>When the search UI appears, your activity will lose input focus. 174 * <p>When the search activity is dismissed, there are three possible outcomes: 175 * <ul><li>If the user simply canceled the search UI, your activity will regain input focus and 176 * proceed as before. See {@link #setOnDismissListener} and {@link #setOnCancelListener} if you 177 * required direct notification of search dialog dismissals.</li> 178 * <li>If the user launched a search, and this required switching to another activity to receive 179 * and process the search {@link android.content.Intent Intent}, your activity will receive the 180 * normal sequence of activity pause or stop notifications.</li> 181 * <li>If the user launched a search, and the current activity is the recipient of the search 182 * {@link android.content.Intent Intent}, you will receive notification via the 183 * {@link android.app.Activity#onNewIntent onNewIntent()} method.</li></ul> 184 * <p>This list is provided in order to clarify the ways in which your activities will interact with 185 * the search UI. More details on searchable activities and search intents are provided in the 186 * sections below. 187 * 188 * <a name="ImplementingSearchForYourApp"></a> 189 * <h3>Implementing Search for Your App</h3> 190 * 191 * <p>The following steps are necessary in order to implement search. 192 * <ul> 193 * <li>Implement search invocation as described above. (Strictly speaking, 194 * these are decoupled, but it would make little sense to be "searchable" but not 195 * "search-invoking".)</li> 196 * <li>Your application should have an activity that takes a search string and 197 * converts it to a list of results. This could be your primary display activity 198 * or it could be a dedicated search results activity. This is your <i>searchable</i> 199 * activity and every query-search application must have one.</li> 200 * <li>In the searchable activity, in onCreate(), you must receive and handle the 201 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 202 * {@link android.content.Intent Intent}. The text to search (query string) for is provided by 203 * calling 204 * {@link #QUERY getStringExtra(SearchManager.QUERY)}.</li> 205 * <li>To identify and support your searchable activity, you'll need to 206 * provide an XML file providing searchability configuration parameters, a reference to that 207 * in your searchable activity's 208 * <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> entry, and an 209 * intent-filter declaring that you can receive ACTION_SEARCH intents. This is described in more 210 * detail in the <a href="#SearchabilityMetadata">Searchability Metadata</a> section.</li> 211 * <li>Your <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> also needs a 212 * metadata entry providing a global reference to the searchable activity. This is the "glue" 213 * directing the search UI, when invoked from any of your <i>other</i> activities, to use your 214 * application as the default search context. This is also described in more detail in the 215 * <a href="#SearchabilityMetadata">Searchability Metadata</a> section.</li> 216 * <li>Finally, you may want to define your search results activity as single-top with the 217 * {@link android.R.attr#launchMode singleTop} launchMode flag. This allows the system 218 * to launch searches from/to the same activity without creating a pile of them on the 219 * activity stack. If you do this, be sure to also override 220 * {@link android.app.Activity#onNewIntent onNewIntent} to handle the 221 * updated intents (with new queries) as they arrive.</li> 222 * </ul> 223 * 224 * <p>Code snippet showing handling of intents in your search activity: 225 * <pre class="prettyprint"> 226 * @Override 227 * protected void onCreate(Bundle icicle) { 228 * super.onCreate(icicle); 229 * 230 * final Intent queryIntent = getIntent(); 231 * final String queryAction = queryIntent.getAction(); 232 * if (Intent.ACTION_SEARCH.equals(queryAction)) { 233 * doSearchWithIntent(queryIntent); 234 * } 235 * } 236 * 237 * private void doSearchWithIntent(final Intent queryIntent) { 238 * final String queryString = queryIntent.getStringExtra(SearchManager.QUERY); 239 * doSearchWithQuery(queryString); 240 * }</pre> 241 * 242 * <a name="Suggestions"></a> 243 * <h3>Search Suggestions</h3> 244 * 245 * <p>A powerful feature of the search system is the ability of any application to easily provide 246 * live "suggestions" in order to prompt the user. Each application implements suggestions in a 247 * different, unique, and appropriate way. Suggestions be drawn from many sources, including but 248 * not limited to: 249 * <ul> 250 * <li>Actual searchable results (e.g. names in the address book)</li> 251 * <li>Recently entered queries</li> 252 * <li>Recently viewed data or results</li> 253 * <li>Contextually appropriate queries or results</li> 254 * <li>Summaries of possible results</li> 255 * </ul> 256 * 257 * <p>Once an application is configured to provide search suggestions, those same suggestions can 258 * easily be made available to the system-wide Quick Search Box, providing faster access to its 259 * content from one central prominent place. See 260 * <a href="#ExposingSearchSuggestionsToQuickSearchBox">Exposing Search Suggestions to Quick Search 261 * Box</a> for more details. 262 * 263 * <p>The primary form of suggestions is known as <i>queried suggestions</i> and is based on query 264 * text that the user has already typed. This would generally be based on partial matches in 265 * the available data. In certain situations - for example, when no query text has been typed yet - 266 * an application may also opt to provide <i>zero-query suggestions</i>. 267 * These would typically be drawn from the same data source, but because no partial query text is 268 * available, they should be weighted based on other factors - for example, most recent queries 269 * or most recent results. 270 * 271 * <p><b>Overview of how suggestions are provided.</b> Suggestions are accessed via a 272 * {@link android.content.ContentProvider Content Provider}. When the search manager identifies a 273 * particular activity as searchable, it will check for certain metadata which indicates that 274 * there is also a source of suggestions. If suggestions are provided, the following steps are 275 * taken. 276 * <ul><li>Using formatting information found in the metadata, the user's query text (whatever 277 * has been typed so far) will be formatted into a query and sent to the suggestions 278 * {@link android.content.ContentProvider Content Provider}.</li> 279 * <li>The suggestions {@link android.content.ContentProvider Content Provider} will create a 280 * {@link android.database.Cursor Cursor} which can iterate over the possible suggestions.</li> 281 * <li>The search manager will populate a list using display data found in each row of the cursor, 282 * and display these suggestions to the user.</li> 283 * <li>If the user types another key, or changes the query in any way, the above steps are repeated 284 * and the suggestions list is updated or repopulated.</li> 285 * <li>If the user clicks or touches the "GO" button, the suggestions are ignored and the search is 286 * launched using the normal {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} type of 287 * {@link android.content.Intent Intent}.</li> 288 * <li>If the user uses the directional controls to navigate the focus into the suggestions list, 289 * the query text will be updated while the user navigates from suggestion to suggestion. The user 290 * can then click or touch the updated query and edit it further. If the user navigates back to 291 * the edit field, the original typed query is restored.</li> 292 * <li>If the user clicks or touches a particular suggestion, then a combination of data from the 293 * cursor and 294 * values found in the metadata are used to synthesize an Intent and send it to the application. 295 * Depending on the design of the activity and the way it implements search, this might be a 296 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} (in order to launch a query), or it 297 * might be a {@link android.content.Intent#ACTION_VIEW ACTION_VIEW}, in order to proceed directly 298 * to display of specific data.</li> 299 * </ul> 300 * 301 * <p><b>Simple Recent-Query-Based Suggestions.</b> The Android framework provides a simple Search 302 * Suggestions provider, which simply records and replays recent queries. For many applications, 303 * this will be sufficient. The basic steps you will need to 304 * do, in order to use the built-in recent queries suggestions provider, are as follows: 305 * <ul> 306 * <li>Implement and test query search, as described in the previous sections.</li> 307 * <li>Create a Provider within your application by extending 308 * {@link android.content.SearchRecentSuggestionsProvider}.</li> 309 * <li>Create a manifest entry describing your provider.</li> 310 * <li>Update your searchable activity's XML configuration file with information about your 311 * provider.</li> 312 * <li>In your searchable activities, capture any user-generated queries and record them 313 * for future searches by calling {@link android.provider.SearchRecentSuggestions#saveRecentQuery}. 314 * </li> 315 * </ul> 316 * <p>For complete implementation details, please refer to 317 * {@link android.content.SearchRecentSuggestionsProvider}. The rest of the information in this 318 * section should not be necessary, as it refers to custom suggestions providers. 319 * 320 * <p><b>Creating a Customized Suggestions Provider:</b> In order to create more sophisticated 321 * suggestion providers, you'll need to take the following steps: 322 * <ul> 323 * <li>Implement and test query search, as described in the previous sections.</li> 324 * <li>Decide how you wish to <i>receive</i> suggestions. Just like queries that the user enters, 325 * suggestions will be delivered to your searchable activity as 326 * {@link android.content.Intent Intent} messages; Unlike simple queries, you have quite a bit of 327 * flexibility in forming those intents. A query search application will probably 328 * wish to continue receiving the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 329 * {@link android.content.Intent Intent}, which will launch a query search using query text as 330 * provided by the suggestion. A filter search application will probably wish to 331 * receive the {@link android.content.Intent#ACTION_VIEW ACTION_VIEW} 332 * {@link android.content.Intent Intent}, which will take the user directly to a selected entry. 333 * Other interesting suggestions, including hybrids, are possible, and the suggestion provider 334 * can easily mix-and-match results to provide a richer set of suggestions for the user. Finally, 335 * you'll need to update your searchable activity (or other activities) to receive the intents 336 * as you've defined them.</li> 337 * <li>Implement a Content Provider that provides suggestions. If you already have one, and it 338 * has access to your suggestions data, you can use that provider. If not, you'll have to create 339 * one. You'll also provide information about your Content Provider in your 340 * package's <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a>.</li> 341 * <li>Update your searchable activity's XML configuration file. There are two categories of 342 * information used for suggestions: 343 * <ul><li>The first is (required) data that the search manager will 344 * use to format the queries which are sent to the Content Provider.</li> 345 * <li>The second is (optional) parameters to configure structure 346 * if intents generated by suggestions.</li></li> 347 * </ul> 348 * </ul> 349 * 350 * <p><b>Configuring your Content Provider to Receive Suggestion Queries.</b> The basic job of 351 * a search suggestions {@link android.content.ContentProvider Content Provider} is to provide 352 * "live" (while-you-type) conversion of the user's query text into a set of zero or more 353 * suggestions. Each application is free to define the conversion, and as described above there are 354 * many possible solutions. This section simply defines how to communicate with the suggestion 355 * provider. 356 * 357 * <p>The Search Manager must first determine if your package provides suggestions. This is done 358 * by examination of your searchable meta-data XML file. The android:searchSuggestAuthority 359 * attribute, if provided, is the signal to obtain & display suggestions. 360 * 361 * <p>Every query includes a Uri, and the Search Manager will format the Uri as shown: 362 * <p><pre class="prettyprint"> 363 * content:// your.suggest.authority / your.suggest.path / SearchManager.SUGGEST_URI_PATH_QUERY 364 * </pre> 365 * 366 * <p>Your Content Provider can receive the query text in one of two ways. 367 * <ul> 368 * <li><b>Query provided as a selection argument.</b> If you define the attribute value 369 * android:searchSuggestSelection and include a string, this string will be passed as the 370 * <i>selection</i> parameter to your Content Provider's query function. You must define a single 371 * selection argument, using the '?' character. The user's query text will be passed to you 372 * as the first element of the selection arguments array.</li> 373 * <li><b>Query provided with Data Uri.</b> If you <i>do not</i> define the attribute value 374 * android:searchSuggestSelection, then the Search Manager will append another "/" followed by 375 * the user's query to the query Uri. The query will be encoding using Uri encoding rules - don't 376 * forget to decode it. (See {@link android.net.Uri#getPathSegments} and 377 * {@link android.net.Uri#getLastPathSegment} for helpful utilities you can use here.)</li> 378 * </ul> 379 * 380 * <p><b>Providing access to Content Providers that require permissions.</b> If your content 381 * provider declares an android:readPermission in your application's manifest, you must provide 382 * access to the search infrastructure to the search suggestion path by including a path-permission 383 * that grants android:readPermission access to "android.permission.GLOBAL_SEARCH". Granting access 384 * explicitly to the search infrastructure ensures it will be able to access the search suggestions 385 * without needing to know ahead of time any other details of the permissions protecting your 386 * provider. Content providers that require no permissions are already available to the search 387 * infrastructure. Here is an example of a provider that protects access to it with permissions, 388 * and provides read access to the search infrastructure to the path that it expects to receive the 389 * suggestion query on: 390 * <pre class="prettyprint"> 391 * <provider android:name="MyProvider" android:authorities="myprovider" 392 * android:readPermission="android.permission.READ_MY_DATA" 393 * android:writePermission="android.permission.WRITE_MY_DATA"> 394 * <path-permission android:path="/search_suggest_query" 395 * android:readPermission="android.permission.GLOBAL_SEARCH" /> 396 * </provider> 397 * </pre> 398 * 399 * <p><b>Handling empty queries.</b> Your application should handle the "empty query" 400 * (no user text entered) case properly, and generate useful suggestions in this case. There are a 401 * number of ways to do this; Two are outlined here: 402 * <ul><li>For a simple filter search of local data, you could simply present the entire dataset, 403 * unfiltered. (example: People)</li> 404 * <li>For a query search, you could simply present the most recent queries. This allows the user 405 * to quickly repeat a recent search.</li></ul> 406 * 407 * <p><b>The Format of Individual Suggestions.</b> Your suggestions are communicated back to the 408 * Search Manager by way of a {@link android.database.Cursor Cursor}. The Search Manager will 409 * usually pass a null Projection, which means that your provider can simply return all appropriate 410 * columns for each suggestion. The columns currently defined are: 411 * 412 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 413 * 414 * <thead> 415 * <tr><th>Column Name</th> <th>Description</th> <th>Required?</th></tr> 416 * </thead> 417 * 418 * <tbody> 419 * <tr><th>{@link #SUGGEST_COLUMN_FORMAT}</th> 420 * <td><i>Unused - can be null.</i></td> 421 * <td align="center">No</td> 422 * </tr> 423 * 424 * <tr><th>{@link #SUGGEST_COLUMN_TEXT_1}</th> 425 * <td>This is the line of text that will be presented to the user as the suggestion.</td> 426 * <td align="center">Yes</td> 427 * </tr> 428 * 429 * <tr><th>{@link #SUGGEST_COLUMN_TEXT_2}</th> 430 * <td>If your cursor includes this column, then all suggestions will be provided in a 431 * two-line format. The data in this column will be displayed as a second, smaller 432 * line of text below the primary suggestion, or it can be null or empty to indicate no 433 * text in this row's suggestion.</td> 434 * <td align="center">No</td> 435 * </tr> 436 * 437 * <tr><th>{@link #SUGGEST_COLUMN_ICON_1}</th> 438 * <td>If your cursor includes this column, then all suggestions will be provided in an 439 * icons+text format. This value should be a reference to the icon to 440 * draw on the left side, or it can be null or zero to indicate no icon in this row. 441 * </td> 442 * <td align="center">No.</td> 443 * </tr> 444 * 445 * <tr><th>{@link #SUGGEST_COLUMN_ICON_2}</th> 446 * <td>If your cursor includes this column, then all suggestions will be provided in an 447 * icons+text format. This value should be a reference to the icon to 448 * draw on the right side, or it can be null or zero to indicate no icon in this row. 449 * </td> 450 * <td align="center">No.</td> 451 * </tr> 452 * 453 * <tr><th>{@link #SUGGEST_COLUMN_INTENT_ACTION}</th> 454 * <td>If this column exists <i>and</i> this element exists at the given row, this is the 455 * action that will be used when forming the suggestion's intent. If the element is 456 * not provided, the action will be taken from the android:searchSuggestIntentAction 457 * field in your XML metadata. <i>At least one of these must be present for the 458 * suggestion to generate an intent.</i> Note: If your action is the same for all 459 * suggestions, it is more efficient to specify it using XML metadata and omit it from 460 * the cursor.</td> 461 * <td align="center">No</td> 462 * </tr> 463 * 464 * <tr><th>{@link #SUGGEST_COLUMN_INTENT_DATA}</th> 465 * <td>If this column exists <i>and</i> this element exists at the given row, this is the 466 * data that will be used when forming the suggestion's intent. If the element is not 467 * provided, the data will be taken from the android:searchSuggestIntentData field in 468 * your XML metadata. If neither source is provided, the Intent's data field will be 469 * null. Note: If your data is the same for all suggestions, or can be described 470 * using a constant part and a specific ID, it is more efficient to specify it using 471 * XML metadata and omit it from the cursor.</td> 472 * <td align="center">No</td> 473 * </tr> 474 * 475 * <tr><th>{@link #SUGGEST_COLUMN_INTENT_DATA_ID}</th> 476 * <td>If this column exists <i>and</i> this element exists at the given row, then "/" and 477 * this value will be appended to the data field in the Intent. This should only be 478 * used if the data field has already been set to an appropriate base string.</td> 479 * <td align="center">No</td> 480 * </tr> 481 * 482 * <tr><th>{@link #SUGGEST_COLUMN_INTENT_EXTRA_DATA}</th> 483 * <td>If this column exists <i>and</i> this element exists at a given row, this is the 484 * data that will be used when forming the suggestion's intent. If not provided, 485 * the Intent's extra data field will be null. This column allows suggestions to 486 * provide additional arbitrary data which will be included as an extra under the 487 * key {@link #EXTRA_DATA_KEY}.</td> 488 * <td align="center">No.</td> 489 * </tr> 490 * 491 * <tr><th>{@link #SUGGEST_COLUMN_QUERY}</th> 492 * <td>If this column exists <i>and</i> this element exists at the given row, this is the 493 * data that will be used when forming the suggestion's query.</td> 494 * <td align="center">Required if suggestion's action is 495 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH}, optional otherwise.</td> 496 * </tr> 497 * 498 * <tr><th>{@link #SUGGEST_COLUMN_SHORTCUT_ID}</th> 499 * <td>This column is used to indicate whether a search suggestion should be stored as a 500 * shortcut, and whether it should be validated. Shortcuts are usually formed when the 501 * user clicks a suggestion from Quick Search Box. If missing, the result will be 502 * stored as a shortcut and never refreshed. If set to 503 * {@link #SUGGEST_NEVER_MAKE_SHORTCUT}, the result will not be stored as a shortcut. 504 * Otherwise, the shortcut id will be used to check back for for an up to date 505 * suggestion using {@link #SUGGEST_URI_PATH_SHORTCUT}. Read more about shortcut 506 * refreshing in the section about 507 * <a href="#ExposingSearchSuggestionsToQuickSearchBox">exposing search suggestions to 508 * Quick Search Box</a>.</td> 509 * <td align="center">No. Only applicable to sources included in Quick Search Box.</td> 510 * </tr> 511 * 512 * <tr><th>{@link #SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING}</th> 513 * <td>This column is used to specify that a spinner should be shown in lieu of an icon2 514 * while the shortcut of this suggestion is being refreshed in Quick Search Box.</td> 515 * <td align="center">No. Only applicable to sources included in Quick Search Box.</td> 516 * </tr> 517 * 518 * <tr><th><i>Other Columns</i></th> 519 * <td>Finally, if you have defined any <a href="#ActionKeys">Action Keys</a> and you wish 520 * for them to have suggestion-specific definitions, you'll need to define one 521 * additional column per action key. The action key will only trigger if the 522 * currently-selection suggestion has a non-empty string in the corresponding column. 523 * See the section on <a href="#ActionKeys">Action Keys</a> for additional details and 524 * implementation steps.</td> 525 * <td align="center">No</td> 526 * </tr> 527 * 528 * </tbody> 529 * </table> 530 * 531 * <p>Clearly there are quite a few permutations of your suggestion data, but in the next section 532 * we'll look at a few simple combinations that you'll select from. 533 * 534 * <p><b>The Format Of Intents Sent By Search Suggestions.</b> Although there are many ways to 535 * configure these intents, this document will provide specific information on just a few of them. 536 * <ul><li><b>Launch a query.</b> In this model, each suggestion represents a query that your 537 * searchable activity can perform, and the {@link android.content.Intent Intent} will be formatted 538 * exactly like those sent when the user enters query text and clicks the "GO" button: 539 * <ul> 540 * <li><b>Action:</b> {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} provided 541 * using your XML metadata (android:searchSuggestIntentAction).</li> 542 * <li><b>Data:</b> empty (not used).</li> 543 * <li><b>Query:</b> query text supplied by the cursor.</li> 544 * </ul> 545 * </li> 546 * <li><b>Go directly to a result, using a complete Data Uri.</b> In this model, the user will be 547 * taken directly to a specific result. 548 * <ul> 549 * <li><b>Action:</b> {@link android.content.Intent#ACTION_VIEW ACTION_VIEW}</li> 550 * <li><b>Data:</b> a complete Uri, supplied by the cursor, that identifies the desired data. 551 * </li> 552 * <li><b>Query:</b> query text supplied with the suggestion (probably ignored)</li> 553 * </ul> 554 * </li> 555 * <li><b>Go directly to a result, using a synthesized Data Uri.</b> This has the same result 556 * as the previous suggestion, but provides the Data Uri in a different way. 557 * <ul> 558 * <li><b>Action:</b> {@link android.content.Intent#ACTION_VIEW ACTION_VIEW}</li> 559 * <li><b>Data:</b> The search manager will assemble a Data Uri using the following elements: 560 * a Uri fragment provided in your XML metadata (android:searchSuggestIntentData), followed by 561 * a single "/", followed by the value found in the {@link #SUGGEST_COLUMN_INTENT_DATA_ID} 562 * entry in your cursor.</li> 563 * <li><b>Query:</b> query text supplied with the suggestion (probably ignored)</li> 564 * </ul> 565 * </li> 566 * </ul> 567 * <p>This list is not meant to be exhaustive. Applications should feel free to define other types 568 * of suggestions. For example, you could reduce long lists of results to summaries, and use one 569 * of the above intents (or one of your own) with specially formatted Data Uri's to display more 570 * detailed results. Or you could display textual shortcuts as suggestions, but launch a display 571 * in a more data-appropriate format such as media artwork. 572 * 573 * <p><b>Suggestion Rewriting.</b> If the user navigates through the suggestions list, the UI 574 * may temporarily rewrite the user's query with a query that matches the currently selected 575 * suggestion. This enables the user to see what query is being suggested, and also allows the user 576 * to click or touch in the entry EditText element and make further edits to the query before 577 * dispatching it. In order to perform this correctly, the Search UI needs to know exactly what 578 * text to rewrite the query with. 579 * 580 * <p>For each suggestion, the following logic is used to select a new query string: 581 * <ul><li>If the suggestion provides an explicit value in the {@link #SUGGEST_COLUMN_QUERY} 582 * column, this value will be used.</li> 583 * <li>If the metadata includes the queryRewriteFromData flag, and the suggestion provides an 584 * explicit value for the intent Data field, this Uri will be used. Note that this should only be 585 * used with Uri's that are intended to be user-visible, such as HTTP. Internal Uri schemes should 586 * not be used in this way.</li> 587 * <li>If the metadata includes the queryRewriteFromText flag, the text in 588 * {@link #SUGGEST_COLUMN_TEXT_1} will be used. This should be used for suggestions in which no 589 * query text is provided and the SUGGEST_COLUMN_INTENT_DATA values are not suitable for user 590 * inspection and editing.</li></ul> 591 * 592 * <a name="ExposingSearchSuggestionsToQuickSearchBox"></a> 593 * <h3>Exposing Search Suggestions to Quick Search Box</h3> 594 * 595 * <p>Once your application is set up to provide search suggestions, making them available to the 596 * globally accessable Quick Search Box is as easy as setting android:includeInGlobalSearch to 597 * "true" in your searchable metadata file. Beyond that, here are some more details of how 598 * suggestions interact with Quick Search Box, and optional ways that you may customize suggestions 599 * for your application. 600 * 601 * <p><b>Important Note:</b> By default, your application will not be enabled as a suggestion 602 * provider (or "searchable item") in Quick Search Box. Once your app is installed, the user must 603 * enable it as a "searchable item" in the Search settings in order to receive your app's 604 * suggestions in Quick Search Box. You should consider how to message this to users of your app - 605 * perhaps with a note to the user the first time they launch the app about how to enable search 606 * suggestions. This gives your app a chance to be queried for suggestions as the user types into 607 * Quick Search Box, though exactly how or if your suggestions will be surfaced is decided by Quick 608 * Search Box. 609 * 610 * <p><b>Source Ranking:</b> Once your application's search results are made available to Quick 611 * Search Box, how they surface to the user for a particular query will be determined as appropriate 612 * by Quick Search Box ranking. This may depend on how many other apps have results for that query, 613 * and how often the user has clicked on your results compared to the other apps - but there is no 614 * guarantee about how ranking will occur, or whether your app's suggestions will show at all for 615 * a given query. In general, you can expect that providing quality results will increase the 616 * likelihood that your app's suggestions are provided in a prominent position, and apps that 617 * provide lower quality suggestions will be more likely to be ranked lower and/or not displayed. 618 * 619 * <p><b>Search Settings:</b> Each app that is available to Quick Search Box has an entry in the 620 * system settings where the user can enable or disable the inclusion of its results. Below the 621 * name of the application, each application may provide a brief description of what kind of 622 * information will be made available via a search settings description string pointed to by the 623 * android:searchSettingsDescription attribute in the searchable metadata. Note that the 624 * user will need to visit this settings menu to enable search suggestions for your app before your 625 * app will have a chance to provide search suggestions to Quick Search Box - see the section 626 * called "Important Note" above. 627 * 628 * <p><b>Shortcuts:</b> Suggestions that are clicked on by the user may be automatically made into 629 * shortcuts, which are suggestions that have been copied from your provider in order to be quickly 630 * displayed without the need to re-query the original sources. Shortcutted suggestions may be 631 * displayed for the query that yielded the suggestion and for any prefixes of that query. You can 632 * request how to have your app's suggestions made into shortcuts, and whether they should be 633 * refreshed, using the {@link #SUGGEST_COLUMN_SHORTCUT_ID} column: 634 * <ul><li>Suggestions that do not include a shortcut id column will be made into shortcuts and 635 * never refreshed. This makes sense for suggestions that refer to data that will never be changed 636 * or removed.</li> 637 * <li>Suggestions that include a shortcut id will be re-queried for a fresh version of the 638 * suggestion each time the shortcut is displayed. The shortcut will be quickly displayed with 639 * whatever data was most recently available until the refresh query returns, after which the 640 * suggestion will be dynamically refreshed with the up to date information. The shortcut refresh 641 * query will be sent to your suggestion provider with a uri of {@link #SUGGEST_URI_PATH_SHORTCUT}. 642 * The result should contain one suggestion using the same columns as the suggestion query, or be 643 * empty, indicating that the shortcut is no longer valid. Shortcut ids make sense when referring 644 * to data that may change over time, such as a contact's presence status. If a suggestion refers 645 * to data that could take longer to refresh, such as a network based refresh of a stock quote, you 646 * may include {@link #SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING} to show a progress spinner for the 647 * right hand icon until the refresh is complete.</li> 648 * <li>Finally, to prevent a suggestion from being copied into a shortcut, you may provide a 649 * shortcut id with a value of {@link #SUGGEST_NEVER_MAKE_SHORTCUT}.</li></ul> 650 * 651 * Note that Quick Search Box will ultimately decide whether to shortcut your app's suggestions, 652 * considering these values as a strong request from your application. 653 * 654 * <a name="ActionKeys"></a> 655 * <h3>Action Keys</h3> 656 * 657 * <p>Searchable activities may also wish to provide shortcuts based on the various action keys 658 * available on the device. The most basic example of this is the contacts app, which enables the 659 * green "dial" key for quick access during searching. Not all action keys are available on 660 * every device, and not all are allowed to be overriden in this way. (For example, the "Home" 661 * key must always return to the home screen, with no exceptions.) 662 * 663 * <p>In order to define action keys for your searchable application, you must do two things. 664 * 665 * <ul> 666 * <li>You'll add one or more <i>actionkey</i> elements to your searchable metadata configuration 667 * file. Each element defines one of the keycodes you are interested in, 668 * defines the conditions under which they are sent, and provides details 669 * on how to communicate the action key event back to your searchable activity.</li> 670 * <li>In your broadcast receiver, if you wish, you can check for action keys by checking the 671 * extras field of the {@link android.content.Intent Intent}.</li> 672 * </ul> 673 * 674 * <p><b>Updating metadata.</b> For each keycode of interest, you must add an <actionkey> 675 * element. Within this element you must define two or three attributes. The first attribute, 676 * <android:keycode>, is required; It is the key code of the action key event, as defined in 677 * {@link android.view.KeyEvent}. The remaining two attributes define the value of the actionkey's 678 * <i>message</i>, which will be passed to your searchable activity in the 679 * {@link android.content.Intent Intent} (see below for more details). Although each of these 680 * attributes is optional, you must define one or both for the action key to have any effect. 681 * <android:queryActionMsg> provides the message that will be sent if the action key is 682 * pressed while the user is simply entering query text. <android:suggestActionMsgColumn> 683 * is used when action keys are tied to specific suggestions. This attribute provides the name 684 * of a <i>column</i> in your suggestion cursor; The individual suggestion, in that column, 685 * provides the message. (If the cell is empty or null, that suggestion will not work with that 686 * action key.) 687 * <p>See the <a href="#SearchabilityMetadata">Searchability Metadata</a> section for more details 688 * and examples. 689 * 690 * <p><b>Receiving Action Keys</b> Intents launched by action keys will be specially marked 691 * using a combination of values. This enables your searchable application to examine the intent, 692 * if necessary, and perform special processing. For example, clicking a suggested contact might 693 * simply display them; Selecting a suggested contact and clicking the dial button might 694 * immediately call them. 695 * 696 * <p>When a search {@link android.content.Intent Intent} is launched by an action key, two values 697 * will be added to the extras field. 698 * <ul> 699 * <li>To examine the key code, use {@link android.content.Intent#getIntExtra 700 * getIntExtra(SearchManager.ACTION_KEY)}.</li> 701 * <li>To examine the message string, use {@link android.content.Intent#getStringExtra 702 * getStringExtra(SearchManager.ACTION_MSG)}</li> 703 * </ul> 704 * 705 * <a name="SearchabilityMetadata"></a> 706 * <h3>Searchability Metadata</h3> 707 * 708 * <p>Every activity that is searchable must provide a small amount of additional information 709 * in order to properly configure the search system. This controls the way that your search 710 * is presented to the user, and controls for the various modalities described previously. 711 * 712 * <p>If your application is not searchable, 713 * then you do not need to provide any search metadata, and you can skip the rest of this section. 714 * When this search metadata cannot be found, the search manager will assume that the activity 715 * does not implement search. (Note: to implement web-based search, you will need to add 716 * the android.app.default_searchable metadata to your manifest, as shown below.) 717 * 718 * <p>Values you supply in metadata apply only to each local searchable activity. Each 719 * searchable activity can define a completely unique search experience relevant to its own 720 * capabilities and user experience requirements, and a single application can even define multiple 721 * searchable activities. 722 * 723 * <p><b>Metadata for searchable activity.</b> As with your search implementations described 724 * above, you must first identify which of your activities is searchable. In the 725 * <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> entry for this activity, you must 726 * provide two elements: 727 * <ul><li>An intent-filter specifying that you can receive and process the 728 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} {@link android.content.Intent Intent}. 729 * </li> 730 * <li>A reference to a small XML file (typically called "searchable.xml") which contains the 731 * remaining configuration information for how your application implements search.</li></ul> 732 * 733 * <p>Here is a snippet showing the necessary elements in the 734 * <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> entry for your searchable activity. 735 * <pre class="prettyprint"> 736 * <!-- Search Activity - searchable --> 737 * <activity android:name="MySearchActivity" 738 * android:label="Search" 739 * android:launchMode="singleTop"> 740 * <intent-filter> 741 * <action android:name="android.intent.action.SEARCH" /> 742 * <category android:name="android.intent.category.DEFAULT" /> 743 * </intent-filter> 744 * <meta-data android:name="android.app.searchable" 745 * android:resource="@xml/searchable" /> 746 * </activity></pre> 747 * 748 * <p>Next, you must provide the rest of the searchability configuration in 749 * the small XML file, stored in the ../xml/ folder in your build. The XML file is a 750 * simple enumeration of the search configuration parameters for searching within this activity, 751 * application, or package. Here is a sample XML file (named searchable.xml, for use with 752 * the above manifest) for a query-search activity. 753 * 754 * <pre class="prettyprint"> 755 * <searchable xmlns:android="http://schemas.android.com/apk/res/android" 756 * android:label="@string/search_label" 757 * android:hint="@string/search_hint" > 758 * </searchable></pre> 759 * 760 * <p>Note that all user-visible strings <i>must</i> be provided in the form of "@string" 761 * references. Hard-coded strings, which cannot be localized, will not work properly in search 762 * metadata. 763 * 764 * <p>Attributes you can set in search metadata: 765 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 766 * 767 * <thead> 768 * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 769 * </thead> 770 * 771 * <tbody> 772 * <tr><th>android:label</th> 773 * <td>This is the name for your application that will be presented to the user in a 774 * list of search targets, or in the search box as a label.</td> 775 * <td align="center">Yes</td> 776 * </tr> 777 * 778 * <tr><th>android:icon</th> 779 * <td><strong>This is deprecated.</strong><br/>The default 780 * application icon is now always used, so this attribute is 781 * obsolete.</td> 782 * <td align="center">No</td> 783 * </tr> 784 * 785 * <tr><th>android:hint</th> 786 * <td>This is the text to display in the search text field when no text 787 * has been entered by the user.</td> 788 * <td align="center">No</td> 789 * </tr> 790 * 791 * <tr><th>android:searchMode</th> 792 * <td>If provided and non-zero, sets additional modes for control of the search 793 * presentation. The following mode bits are defined: 794 * <table border="2" align="center" frame="hsides" rules="rows"> 795 * <tbody> 796 * <tr><th>showSearchLabelAsBadge</th> 797 * <td>If set, this flag enables the display of the search target (label) 798 * above the search box. As an alternative, you may 799 * want to instead use "hint" text in the search box. 800 * See the "android:hint" attribute above.</td> 801 * </tr> 802 * <tr><th>showSearchIconAsBadge</th> 803 * <td><strong>This is deprecated.</strong><br/>The default 804 * application icon is now always used, so this 805 * option is obsolete.</td> 806 * </tr> 807 * <tr><th>queryRewriteFromData</th> 808 * <td>If set, this flag causes the suggestion column SUGGEST_COLUMN_INTENT_DATA 809 * to be considered as the text for suggestion query rewriting. This should 810 * only be used when the values in SUGGEST_COLUMN_INTENT_DATA are suitable 811 * for user inspection and editing - typically, HTTP/HTTPS Uri's.</td> 812 * </tr> 813 * <tr><th>queryRewriteFromText</th> 814 * <td>If set, this flag causes the suggestion column SUGGEST_COLUMN_TEXT_1 to 815 * be considered as the text for suggestion query rewriting. This should 816 * be used for suggestions in which no query text is provided and the 817 * SUGGEST_COLUMN_INTENT_DATA values are not suitable for user inspection 818 * and editing.</td> 819 * </tr> 820 * </tbody> 821 * </table> 822 * Note that the icon of your app will likely be shown alongside any badge you specify, 823 * to differentiate search in your app from Quick Search Box. The display of this icon 824 * is not under the app's control. 825 * </td> 826 * 827 * <td align="center">No</td> 828 * </tr> 829 * 830 * <tr><th>android:inputType</th> 831 * <td>If provided, supplies a hint about the type of search text the user will be 832 * entering. For most searches, in which free form text is expected, this attribute 833 * need not be provided. Suitable values for this attribute are described in the 834 * <a href="../R.attr.html#inputType">inputType</a> attribute.</td> 835 * <td align="center">No</td> 836 * </tr> 837 * <tr><th>android:imeOptions</th> 838 * <td>If provided, supplies additional options for the input method. 839 * For most searches, in which free form text is expected, this attribute 840 * need not be provided, and will default to "actionSearch". 841 * Suitable values for this attribute are described in the 842 * <a href="../R.attr.html#imeOptions">imeOptions</a> attribute.</td> 843 * <td align="center">No</td> 844 * </tr> 845 * 846 * </tbody> 847 * </table> 848 * 849 * <p><b>Styleable Resources in your Metadata.</b> It's possible to provide alternate strings 850 * for your searchable application, in order to provide localization and/or to better visual 851 * presentation on different device configurations. Each searchable activity has a single XML 852 * metadata file, but any resource references can be replaced at runtime based on device 853 * configuration, language setting, and other system inputs. 854 * 855 * <p>A concrete example is the "hint" text you supply using the android:searchHint attribute. 856 * In portrait mode you'll have less screen space and may need to provide a shorter string, but 857 * in landscape mode you can provide a longer, more descriptive hint. To do this, you'll need to 858 * define two or more strings.xml files, in the following directories: 859 * <ul><li>.../res/values-land/strings.xml</li> 860 * <li>.../res/values-port/strings.xml</li> 861 * <li>.../res/values/strings.xml</li></ul> 862 * 863 * <p>For more complete documentation on this capability, see 864 * <a href="{@docRoot}guide/topics/resources/resources-i18n.html#AlternateResources">Resources and 865 * Internationalization: Alternate Resources</a>. 866 * 867 * <p><b>Metadata for non-searchable activities.</b> Activities which are part of a searchable 868 * application, but don't implement search itself, require a bit of "glue" in order to cause 869 * them to invoke search using your searchable activity as their primary context. If this is not 870 * provided, then searches from these activities will use the system default search context. 871 * 872 * <p>The simplest way to specify this is to add a <i>search reference</i> element to the 873 * application entry in the <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a> file. 874 * The value of this reference can be either of: 875 * <ul><li>The name of your searchable activity. 876 * It is typically prefixed by '.' to indicate that it's in the same package.</li> 877 * <li>A "*" indicates that the system may select a default searchable activity, in which 878 * case it will typically select web-based search.</li> 879 * </ul> 880 * 881 * <p>Here is a snippet showing the necessary addition to the manifest entry for your 882 * non-searchable activities. 883 * <pre class="prettyprint"> 884 * <application> 885 * <meta-data android:name="android.app.default_searchable" 886 * android:value=".MySearchActivity" /> 887 * 888 * <!-- followed by activities, providers, etc... --> 889 * </application></pre> 890 * 891 * <p>You can also specify android.app.default_searchable on a per-activity basis, by including 892 * the meta-data element (as shown above) in one or more activity sections. If found, these will 893 * override the reference in the application section. The only reason to configure your application 894 * this way would be if you wish to partition it into separate sections with different search 895 * behaviors; Otherwise this configuration is not recommended. 896 * 897 * <p><b>Additional metadata for search suggestions.</b> If you have defined a content provider 898 * to generate search suggestions, you'll need to publish it to the system, and you'll need to 899 * provide a bit of additional XML metadata in order to configure communications with it. 900 * 901 * <p>First, in your <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a>, you'll add the 902 * following lines. 903 * <pre class="prettyprint"> 904 * <!-- Content provider for search suggestions --> 905 * <provider android:name="YourSuggestionProviderClass" 906 * android:authorities="your.suggestion.authority" /></pre> 907 * 908 * <p>Next, you'll add a few lines to your XML metadata file, as shown: 909 * <pre class="prettyprint"> 910 * <!-- Required attribute for any suggestions provider --> 911 * android:searchSuggestAuthority="your.suggestion.authority" 912 * 913 * <!-- Optional attribute for configuring queries --> 914 * android:searchSuggestSelection="field =?" 915 * 916 * <!-- Optional attributes for configuring intent construction --> 917 * android:searchSuggestIntentAction="intent action string" 918 * android:searchSuggestIntentData="intent data Uri" /></pre> 919 * 920 * <p>Elements of search metadata that support suggestions: 921 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 922 * 923 * <thead> 924 * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 925 * </thead> 926 * 927 * <tbody> 928 * <tr><th>android:searchSuggestAuthority</th> 929 * <td>This value must match the authority string provided in the <i>provider</i> section 930 * of your <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest</a>.</td> 931 * <td align="center">Yes</td> 932 * </tr> 933 * 934 * <tr><th>android:searchSuggestPath</th> 935 * <td>If provided, this will be inserted in the suggestions query Uri, after the authority 936 * you have provide but before the standard suggestions path. This is only required if 937 * you have a single content provider issuing different types of suggestions (e.g. for 938 * different data types) and you need a way to disambiguate the suggestions queries 939 * when they are received.</td> 940 * <td align="center">No</td> 941 * </tr> 942 * 943 * <tr><th>android:searchSuggestSelection</th> 944 * <td>If provided, this value will be passed into your query function as the 945 * <i>selection</i> parameter. Typically this will be a WHERE clause for your database, 946 * and will contain a single question mark, which represents the actual query string 947 * that has been typed by the user. However, you can also use any non-null value 948 * to simply trigger the delivery of the query text (via selection arguments), and then 949 * use the query text in any way appropriate for your provider (ignoring the actual 950 * text of the selection parameter.)</td> 951 * <td align="center">No</td> 952 * </tr> 953 * 954 * <tr><th>android:searchSuggestIntentAction</th> 955 * <td>If provided, and not overridden by the selected suggestion, this value will be 956 * placed in the action field of the {@link android.content.Intent Intent} when the 957 * user clicks a suggestion.</td> 958 * <td align="center">No</td> 959 * 960 * <tr><th>android:searchSuggestIntentData</th> 961 * <td>If provided, and not overridden by the selected suggestion, this value will be 962 * placed in the data field of the {@link android.content.Intent Intent} when the user 963 * clicks a suggestion.</td> 964 * <td align="center">No</td> 965 * </tr> 966 * 967 * </tbody> 968 * </table> 969 * 970 * <p>Elements of search metadata that configure search suggestions being available to Quick Search 971 * Box: 972 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 973 * 974 * <thead> 975 * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 976 * </thead> 977 * 978 * <tr><th>android:includeInGlobalSearch</th> 979 * <td>If true, indicates the search suggestions provided by your application should be 980 * included in the globally accessible Quick Search Box. The attributes below are only 981 * applicable if this is set to true.</td> 982 * <td align="center">Yes</td> 983 * </tr> 984 * 985 * <tr><th>android:searchSettingsDescription</th> 986 * <td>If provided, provides a brief description of the search suggestions that are provided 987 * by your application to Quick Search Box, and will be displayed in the search settings 988 * entry for your application.</td> 989 * <td align="center">No</td> 990 * </tr> 991 * 992 * <tr><th>android:queryAfterZeroResults</th> 993 * <td>Indicates whether a source should be invoked for supersets of queries it has 994 * returned zero results for in the past. For example, if a source returned zero 995 * results for "bo", it would be ignored for "bob". If set to false, this source 996 * will only be ignored for a single session; the next time the search dialog is 997 * invoked, all sources will be queried. The default value is false.</td> 998 * <td align="center">No</td> 999 * </tr> 1000 * 1001 * <tr><th>android:searchSuggestThreshold</th> 1002 * <td>Indicates the minimum number of characters needed to trigger a source from Quick 1003 * Search Box. Only guarantees that a source will not be queried for anything shorter 1004 * than the threshold. The default value is 0.</td> 1005 * <td align="center">No</td> 1006 * </tr> 1007 * 1008 * </tbody> 1009 * </table> 1010 * 1011 * <p><b>Additional metadata for search action keys.</b> For each action key that you would like to 1012 * define, you'll need to add an additional element defining that key, and using the attributes 1013 * discussed in <a href="#ActionKeys">Action Keys</a>. A simple example is shown here: 1014 * 1015 * <pre class="prettyprint"><actionkey 1016 * android:keycode="KEYCODE_CALL" 1017 * android:queryActionMsg="call" 1018 * android:suggestActionMsg="call" 1019 * android:suggestActionMsgColumn="call_column" /></pre> 1020 * 1021 * <p>Elements of search metadata that support search action keys. Note that although each of the 1022 * action message elements are marked as <i>optional</i>, at least one must be present for the 1023 * action key to have any effect. 1024 * 1025 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 1026 * 1027 * <thead> 1028 * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 1029 * </thead> 1030 * 1031 * <tbody> 1032 * <tr><th>android:keycode</th> 1033 * <td>This attribute denotes the action key you wish to respond to. Note that not 1034 * all action keys are actually supported using this mechanism, as many of them are 1035 * used for typing, navigation, or system functions. This will be added to the 1036 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to 1037 * your searchable activity. To examine the key code, use 1038 * {@link android.content.Intent#getIntExtra getIntExtra(SearchManager.ACTION_KEY)}. 1039 * <p>Note, in addition to the keycode, you must also provide one or more of the action 1040 * specifier attributes.</td> 1041 * <td align="center">Yes</td> 1042 * </tr> 1043 * 1044 * <tr><th>android:queryActionMsg</th> 1045 * <td>If you wish to handle an action key during normal search query entry, you 1046 * must define an action string here. This will be added to the 1047 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to your 1048 * searchable activity. To examine the string, use 1049 * {@link android.content.Intent#getStringExtra 1050 * getStringExtra(SearchManager.ACTION_MSG)}.</td> 1051 * <td align="center">No</td> 1052 * </tr> 1053 * 1054 * <tr><th>android:suggestActionMsg</th> 1055 * <td>If you wish to handle an action key while a suggestion is being displayed <i>and 1056 * selected</i>, there are two ways to handle this. If <i>all</i> of your suggestions 1057 * can handle the action key, you can simply define the action message using this 1058 * attribute. This will be added to the 1059 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to 1060 * your searchable activity. To examine the string, use 1061 * {@link android.content.Intent#getStringExtra 1062 * getStringExtra(SearchManager.ACTION_MSG)}.</td> 1063 * <td align="center">No</td> 1064 * </tr> 1065 * 1066 * <tr><th>android:suggestActionMsgColumn</th> 1067 * <td>If you wish to handle an action key while a suggestion is being displayed <i>and 1068 * selected</i>, but you do not wish to enable this action key for every suggestion, 1069 * then you can use this attribute to control it on a suggestion-by-suggestion basis. 1070 * First, you must define a column (and name it here) where your suggestions will 1071 * include the action string. Then, in your content provider, you must provide this 1072 * column, and when desired, provide data in this column. 1073 * The search manager will look at your suggestion cursor, using the string 1074 * provided here in order to select a column, and will use that to select a string from 1075 * the cursor. That string will be added to the 1076 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} intent that is passed to 1077 * your searchable activity. To examine the string, use 1078 * {@link android.content.Intent#getStringExtra 1079 * getStringExtra(SearchManager.ACTION_MSG)}. <i>If the data does not exist for the 1080 * selection suggestion, the action key will be ignored.</i></td> 1081 * <td align="center">No</td> 1082 * </tr> 1083 * 1084 * </tbody> 1085 * </table> 1086 * 1087 * <p><b>Additional metadata for enabling voice search.</b> To enable voice search for your 1088 * activity, you can add fields to the metadata that enable and configure voice search. When 1089 * enabled (and available on the device), a voice search button will be displayed in the 1090 * Search UI. Clicking this button will launch a voice search activity. When the user has 1091 * finished speaking, the voice search phrase will be transcribed into text and presented to the 1092 * searchable activity as if it were a typed query. 1093 * 1094 * <p>Elements of search metadata that support voice search: 1095 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 1096 * 1097 * <thead> 1098 * <tr><th>Attribute</th> <th>Description</th> <th>Required?</th></tr> 1099 * </thead> 1100 * 1101 * <tr><th>android:voiceSearchMode</th> 1102 * <td>If provided and non-zero, enables voice search. (Voice search may not be 1103 * provided by the device, in which case these flags will have no effect.) The 1104 * following mode bits are defined: 1105 * <table border="2" align="center" frame="hsides" rules="rows"> 1106 * <tbody> 1107 * <tr><th>showVoiceSearchButton</th> 1108 * <td>If set, display a voice search button. This only takes effect if voice 1109 * search is available on the device. If set, then launchWebSearch or 1110 * launchRecognizer must also be set.</td> 1111 * </tr> 1112 * <tr><th>launchWebSearch</th> 1113 * <td>If set, the voice search button will take the user directly to a 1114 * built-in voice web search activity. Most applications will not use this 1115 * flag, as it will take the user away from the activity in which search 1116 * was invoked.</td> 1117 * </tr> 1118 * <tr><th>launchRecognizer</th> 1119 * <td>If set, the voice search button will take the user directly to a 1120 * built-in voice recording activity. This activity will prompt the user 1121 * to speak, transcribe the spoken text, and forward the resulting query 1122 * text to the searchable activity, just as if the user had typed it into 1123 * the search UI and clicked the search button.</td> 1124 * </tr> 1125 * </tbody> 1126 * </table></td> 1127 * <td align="center">No</td> 1128 * </tr> 1129 * 1130 * <tr><th>android:voiceLanguageModel</th> 1131 * <td>If provided, this specifies the language model that should be used by the voice 1132 * recognition system. 1133 * See {@link android.speech.RecognizerIntent#EXTRA_LANGUAGE_MODEL} 1134 * for more information. If not provided, the default value 1135 * {@link android.speech.RecognizerIntent#LANGUAGE_MODEL_FREE_FORM} will be used.</td> 1136 * <td align="center">No</td> 1137 * </tr> 1138 * 1139 * <tr><th>android:voicePromptText</th> 1140 * <td>If provided, this specifies a prompt that will be displayed during voice input. 1141 * (If not provided, a default prompt will be displayed.)</td> 1142 * <td align="center">No</td> 1143 * </tr> 1144 * 1145 * <tr><th>android:voiceLanguage</th> 1146 * <td>If provided, this specifies the spoken language to be expected. This is only 1147 * needed if it is different from the current value of 1148 * {@link java.util.Locale#getDefault()}. 1149 * </td> 1150 * <td align="center">No</td> 1151 * </tr> 1152 * 1153 * <tr><th>android:voiceMaxResults</th> 1154 * <td>If provided, enforces the maximum number of results to return, including the "best" 1155 * result which will always be provided as the SEARCH intent's primary query. Must be 1156 * one or greater. Use {@link android.speech.RecognizerIntent#EXTRA_RESULTS} 1157 * to get the results from the intent. If not provided, the recognizer will choose 1158 * how many results to return.</td> 1159 * <td align="center">No</td> 1160 * </tr> 1161 * 1162 * </tbody> 1163 * </table> 1164 * 1165 * <a name="PassingSearchContext"></a> 1166 * <h3>Passing Search Context</h3> 1167 * 1168 * <p>In order to improve search experience, an application may wish to specify 1169 * additional data along with the search, such as local history or context. For 1170 * example, a maps search would be improved by including the current location. 1171 * In order to simplify the structure of your activities, this can be done using 1172 * the search manager. 1173 * 1174 * <p>Any data can be provided at the time the search is launched, as long as it 1175 * can be stored in a {@link android.os.Bundle Bundle} object. 1176 * 1177 * <p>To pass application data into the Search Manager, you'll need to override 1178 * {@link android.app.Activity#onSearchRequested onSearchRequested} as follows: 1179 * 1180 * <pre class="prettyprint"> 1181 * @Override 1182 * public boolean onSearchRequested() { 1183 * Bundle appData = new Bundle(); 1184 * appData.put...(); 1185 * appData.put...(); 1186 * startSearch(null, false, appData, false); 1187 * return true; 1188 * }</pre> 1189 * 1190 * <p>To receive application data from the Search Manager, you'll extract it from 1191 * the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 1192 * {@link android.content.Intent Intent} as follows: 1193 * 1194 * <pre class="prettyprint"> 1195 * final Bundle appData = queryIntent.getBundleExtra(SearchManager.APP_DATA); 1196 * if (appData != null) { 1197 * appData.get...(); 1198 * appData.get...(); 1199 * }</pre> 1200 * 1201 * <a name="ProtectingUserPrivacy"></a> 1202 * <h3>Protecting User Privacy</h3> 1203 * 1204 * <p>Many users consider their activities on the phone, including searches, to be private 1205 * information. Applications that implement search should take steps to protect users' privacy 1206 * wherever possible. This section covers two areas of concern, but you should consider your search 1207 * design carefully and take any additional steps necessary. 1208 * 1209 * <p><b>Don't send personal information to servers, and if you do, don't log it.</b> 1210 * "Personal information" is information that can personally identify your users, such as name, 1211 * email address or billing information, or other data which can be reasonably linked to such 1212 * information. If your application implements search with the assistance of a server, try to 1213 * avoid sending personal information with your searches. For example, if you are searching for 1214 * businesses near a zip code, you don't need to send the user ID as well - just send the zip code 1215 * to the server. If you do need to send personal information, you should take steps to avoid 1216 * logging it. If you must log it, you should protect that data very carefully, and erase it as 1217 * soon as possible. 1218 * 1219 * <p><b>Provide the user with a way to clear their search history.</b> The Search Manager helps 1220 * your application provide context-specific suggestions. Sometimes these suggestions are based 1221 * on previous searches, or other actions taken by the user in an earlier session. A user may not 1222 * wish for previous searches to be revealed to other users, for instance if they share their phone 1223 * with a friend. If your application provides suggestions that can reveal previous activities, 1224 * you should implement a "Clear History" menu, preference, or button. If you are using 1225 * {@link android.provider.SearchRecentSuggestions}, you can simply call its 1226 * {@link android.provider.SearchRecentSuggestions#clearHistory() clearHistory()} method from 1227 * your "Clear History" UI. If you are implementing your own form of recent suggestions, you'll 1228 * need to provide a similar a "clear history" API in your provider, and call it from your 1229 * "Clear History" UI. 1230 */ 1231public class SearchManager 1232 implements DialogInterface.OnDismissListener, DialogInterface.OnCancelListener 1233{ 1234 1235 private static final boolean DBG = false; 1236 private static final String TAG = "SearchManager"; 1237 1238 /** 1239 * This is a shortcut definition for the default menu key to use for invoking search. 1240 * 1241 * See Menu.Item.setAlphabeticShortcut() for more information. 1242 */ 1243 public final static char MENU_KEY = 's'; 1244 1245 /** 1246 * This is a shortcut definition for the default menu key to use for invoking search. 1247 * 1248 * See Menu.Item.setAlphabeticShortcut() for more information. 1249 */ 1250 public final static int MENU_KEYCODE = KeyEvent.KEYCODE_S; 1251 1252 /** 1253 * Intent extra data key: Use this key with 1254 * {@link android.content.Intent#getStringExtra 1255 * content.Intent.getStringExtra()} 1256 * to obtain the query string from Intent.ACTION_SEARCH. 1257 */ 1258 public final static String QUERY = "query"; 1259 1260 /** 1261 * Intent extra data key: Use this key with 1262 * {@link android.content.Intent#getStringExtra 1263 * content.Intent.getStringExtra()} 1264 * to obtain the query string typed in by the user. 1265 * This may be different from the value of {@link #QUERY} 1266 * if the intent is the result of selecting a suggestion. 1267 * In that case, {@link #QUERY} will contain the value of 1268 * {@link #SUGGEST_COLUMN_QUERY} for the suggestion, and 1269 * {@link #USER_QUERY} will contain the string typed by the 1270 * user. 1271 */ 1272 public final static String USER_QUERY = "user_query"; 1273 1274 /** 1275 * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 1276 * {@link android.content.Intent#getBundleExtra 1277 * content.Intent.getBundleExtra()} 1278 * to obtain any additional app-specific data that was inserted by the 1279 * activity that launched the search. 1280 */ 1281 public final static String APP_DATA = "app_data"; 1282 1283 /** 1284 * Intent extra data key: Use {@link android.content.Intent#getBundleExtra 1285 * content.Intent.getBundleExtra(SEARCH_MODE)} to get the search mode used 1286 * to launch the intent. 1287 * The only current value for this is {@link #MODE_GLOBAL_SEARCH_SUGGESTION}. 1288 * 1289 * @hide 1290 */ 1291 public final static String SEARCH_MODE = "search_mode"; 1292 1293 /** 1294 * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 1295 * {@link android.content.Intent#getIntExtra content.Intent.getIntExtra()} 1296 * to obtain the keycode that the user used to trigger this query. It will be zero if the 1297 * user simply pressed the "GO" button on the search UI. This is primarily used in conjunction 1298 * with the keycode attribute in the actionkey element of your searchable.xml configuration 1299 * file. 1300 */ 1301 public final static String ACTION_KEY = "action_key"; 1302 1303 /** 1304 * Intent extra data key: This key will be used for the extra populated by the 1305 * {@link #SUGGEST_COLUMN_INTENT_EXTRA_DATA} column. 1306 */ 1307 public final static String EXTRA_DATA_KEY = "intent_extra_data_key"; 1308 1309 /** 1310 * Boolean extra data key for {@link #INTENT_ACTION_GLOBAL_SEARCH} intents. If {@code true}, 1311 * the initial query should be selected when the global search activity is started, so 1312 * that the user can easily replace it with another query. 1313 */ 1314 public final static String EXTRA_SELECT_QUERY = "select_query"; 1315 1316 /** 1317 * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 1318 * {@link android.content.Intent#getStringExtra content.Intent.getStringExtra()} 1319 * to obtain the action message that was defined for a particular search action key and/or 1320 * suggestion. It will be null if the search was launched by typing "enter", touched the the 1321 * "GO" button, or other means not involving any action key. 1322 */ 1323 public final static String ACTION_MSG = "action_msg"; 1324 1325 /** 1326 * Uri path for queried suggestions data. This is the path that the search manager 1327 * will use when querying your content provider for suggestions data based on user input 1328 * (e.g. looking for partial matches). 1329 * Typically you'll use this with a URI matcher. 1330 */ 1331 public final static String SUGGEST_URI_PATH_QUERY = "search_suggest_query"; 1332 1333 /** 1334 * MIME type for suggestions data. You'll use this in your suggestions content provider 1335 * in the getType() function. 1336 */ 1337 public final static String SUGGEST_MIME_TYPE = 1338 "vnd.android.cursor.dir/vnd.android.search.suggest"; 1339 1340 /** 1341 * Uri path for shortcut validation. This is the path that the search manager will use when 1342 * querying your content provider to refresh a shortcutted suggestion result and to check if it 1343 * is still valid. When asked, a source may return an up to date result, or no result. No 1344 * result indicates the shortcut refers to a no longer valid sugggestion. 1345 * 1346 * @see #SUGGEST_COLUMN_SHORTCUT_ID 1347 */ 1348 public final static String SUGGEST_URI_PATH_SHORTCUT = "search_suggest_shortcut"; 1349 1350 /** 1351 * MIME type for shortcut validation. You'll use this in your suggestions content provider 1352 * in the getType() function. 1353 */ 1354 public final static String SHORTCUT_MIME_TYPE = 1355 "vnd.android.cursor.item/vnd.android.search.suggest"; 1356 1357 /** 1358 * Column name for suggestions cursor. <i>Unused - can be null or column can be omitted.</i> 1359 */ 1360 public final static String SUGGEST_COLUMN_FORMAT = "suggest_format"; 1361 /** 1362 * Column name for suggestions cursor. <i>Required.</i> This is the primary line of text that 1363 * will be presented to the user as the suggestion. 1364 */ 1365 public final static String SUGGEST_COLUMN_TEXT_1 = "suggest_text_1"; 1366 /** 1367 * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 1368 * then all suggestions will be provided in a two-line format. The second line of text is in 1369 * a much smaller appearance. 1370 */ 1371 public final static String SUGGEST_COLUMN_TEXT_2 = "suggest_text_2"; 1372 /** 1373 * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 1374 * then all suggestions will be provided in a format that includes space for two small icons, 1375 * one at the left and one at the right of each suggestion. The data in the column must 1376 * be a resource ID of a drawable, or a URI in one of the following formats: 1377 * 1378 * <ul> 1379 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 1380 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 1381 * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> 1382 * </ul> 1383 * 1384 * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} 1385 * for more information on these schemes. 1386 */ 1387 public final static String SUGGEST_COLUMN_ICON_1 = "suggest_icon_1"; 1388 /** 1389 * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 1390 * then all suggestions will be provided in a format that includes space for two small icons, 1391 * one at the left and one at the right of each suggestion. The data in the column must 1392 * be a resource ID of a drawable, or a URI in one of the following formats: 1393 * 1394 * <ul> 1395 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 1396 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 1397 * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> 1398 * </ul> 1399 * 1400 * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} 1401 * for more information on these schemes. 1402 */ 1403 public final static String SUGGEST_COLUMN_ICON_2 = "suggest_icon_2"; 1404 /** 1405 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 1406 * this element exists at the given row, this is the action that will be used when 1407 * forming the suggestion's intent. If the element is not provided, the action will be taken 1408 * from the android:searchSuggestIntentAction field in your XML metadata. <i>At least one of 1409 * these must be present for the suggestion to generate an intent.</i> Note: If your action is 1410 * the same for all suggestions, it is more efficient to specify it using XML metadata and omit 1411 * it from the cursor. 1412 */ 1413 public final static String SUGGEST_COLUMN_INTENT_ACTION = "suggest_intent_action"; 1414 /** 1415 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 1416 * this element exists at the given row, this is the data that will be used when 1417 * forming the suggestion's intent. If the element is not provided, the data will be taken 1418 * from the android:searchSuggestIntentData field in your XML metadata. If neither source 1419 * is provided, the Intent's data field will be null. Note: If your data is 1420 * the same for all suggestions, or can be described using a constant part and a specific ID, 1421 * it is more efficient to specify it using XML metadata and omit it from the cursor. 1422 */ 1423 public final static String SUGGEST_COLUMN_INTENT_DATA = "suggest_intent_data"; 1424 /** 1425 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 1426 * this element exists at the given row, this is the data that will be used when 1427 * forming the suggestion's intent. If not provided, the Intent's extra data field will be null. 1428 * This column allows suggestions to provide additional arbitrary data which will be included as 1429 * an extra under the key {@link #EXTRA_DATA_KEY}. 1430 */ 1431 public final static String SUGGEST_COLUMN_INTENT_EXTRA_DATA = "suggest_intent_extra_data"; 1432 /** 1433 * TODO: Remove 1434 * 1435 * @hide 1436 */ 1437 public final static String SUGGEST_COLUMN_INTENT_COMPONENT_NAME = "suggest_intent_component"; 1438 /** 1439 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 1440 * this element exists at the given row, then "/" and this value will be appended to the data 1441 * field in the Intent. This should only be used if the data field has already been set to an 1442 * appropriate base string. 1443 */ 1444 public final static String SUGGEST_COLUMN_INTENT_DATA_ID = "suggest_intent_data_id"; 1445 /** 1446 * Column name for suggestions cursor. <i>Required if action is 1447 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH}, optional otherwise.</i> If this 1448 * column exists <i>and</i> this element exists at the given row, this is the data that will be 1449 * used when forming the suggestion's query. 1450 */ 1451 public final static String SUGGEST_COLUMN_QUERY = "suggest_intent_query"; 1452 1453 /** 1454 * Column name for suggestions cursor. <i>Optional.</i> This column is used to indicate whether 1455 * a search suggestion should be stored as a shortcut, and whether it should be refreshed. If 1456 * missing, the result will be stored as a shortcut and never validated. If set to 1457 * {@link #SUGGEST_NEVER_MAKE_SHORTCUT}, the result will not be stored as a shortcut. 1458 * Otherwise, the shortcut id will be used to check back for an up to date suggestion using 1459 * {@link #SUGGEST_URI_PATH_SHORTCUT}. 1460 */ 1461 public final static String SUGGEST_COLUMN_SHORTCUT_ID = "suggest_shortcut_id"; 1462 1463 /** 1464 * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify the 1465 * cursor item's background color if it needs a non-default background color. A non-zero value 1466 * indicates a valid background color to override the default. 1467 * 1468 * @hide For internal use, not part of the public API. 1469 */ 1470 public final static String SUGGEST_COLUMN_BACKGROUND_COLOR = "suggest_background_color"; 1471 1472 /** 1473 * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify 1474 * that a spinner should be shown in lieu of an icon2 while the shortcut of this suggestion 1475 * is being refreshed. 1476 */ 1477 public final static String SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING = 1478 "suggest_spinner_while_refreshing"; 1479 1480 /** 1481 * Column value for suggestion column {@link #SUGGEST_COLUMN_SHORTCUT_ID} when a suggestion 1482 * should not be stored as a shortcut in global search. 1483 */ 1484 public final static String SUGGEST_NEVER_MAKE_SHORTCUT = "_-1"; 1485 1486 /** 1487 * Query parameter added to suggestion queries to limit the number of suggestions returned. 1488 * This limit is only advisory and suggestion providers may chose to ignore it. 1489 */ 1490 public final static String SUGGEST_PARAMETER_LIMIT = "limit"; 1491 1492 /** 1493 * Intent action for starting the global search activity. 1494 * The global search provider should handle this intent. 1495 * 1496 * Supported extra data keys: {@link #QUERY}, 1497 * {@link #EXTRA_SELECT_QUERY}, 1498 * {@link #APP_DATA}. 1499 */ 1500 public final static String INTENT_ACTION_GLOBAL_SEARCH 1501 = "android.search.action.GLOBAL_SEARCH"; 1502 1503 /** 1504 * Intent action for starting the global search settings activity. 1505 * The global search provider should handle this intent. 1506 */ 1507 public final static String INTENT_ACTION_SEARCH_SETTINGS 1508 = "android.search.action.SEARCH_SETTINGS"; 1509 1510 /** 1511 * Intent action for starting a web search provider's settings activity. 1512 * Web search providers should handle this intent if they have provider-specific 1513 * settings to implement. 1514 */ 1515 public final static String INTENT_ACTION_WEB_SEARCH_SETTINGS 1516 = "android.search.action.WEB_SEARCH_SETTINGS"; 1517 1518 /** 1519 * Intent action broadcasted to inform that the searchables list or default have changed. 1520 * Components should handle this intent if they cache any searchable data and wish to stay 1521 * up to date on changes. 1522 */ 1523 public final static String INTENT_ACTION_SEARCHABLES_CHANGED 1524 = "android.search.action.SEARCHABLES_CHANGED"; 1525 1526 /** 1527 * Intent action broadcasted to inform that the search settings have changed in some way. 1528 * Either searchables have been enabled or disabled, or a different web search provider 1529 * has been chosen. 1530 */ 1531 public final static String INTENT_ACTION_SEARCH_SETTINGS_CHANGED 1532 = "android.search.action.SETTINGS_CHANGED"; 1533 1534 /** 1535 * If a suggestion has this value in {@link #SUGGEST_COLUMN_INTENT_ACTION}, 1536 * the search dialog will take no action. 1537 * 1538 * @hide 1539 */ 1540 public final static String INTENT_ACTION_NONE = "android.search.action.ZILCH"; 1541 1542 /** 1543 * Reference to the shared system search service. 1544 */ 1545 private static ISearchManager mService; 1546 1547 private final Context mContext; 1548 1549 /** 1550 * The package associated with this seach manager. 1551 */ 1552 private String mAssociatedPackage; 1553 1554 // package private since they are used by the inner class SearchManagerCallback 1555 /* package */ final Handler mHandler; 1556 /* package */ OnDismissListener mDismissListener = null; 1557 /* package */ OnCancelListener mCancelListener = null; 1558 1559 private SearchDialog mSearchDialog; 1560 1561 /*package*/ SearchManager(Context context, Handler handler) { 1562 mContext = context; 1563 mHandler = handler; 1564 mService = ISearchManager.Stub.asInterface( 1565 ServiceManager.getService(Context.SEARCH_SERVICE)); 1566 } 1567 1568 /** 1569 * Launch search UI. 1570 * 1571 * <p>The search manager will open a search widget in an overlapping 1572 * window, and the underlying activity may be obscured. The search 1573 * entry state will remain in effect until one of the following events: 1574 * <ul> 1575 * <li>The user completes the search. In most cases this will launch 1576 * a search intent.</li> 1577 * <li>The user uses the back, home, or other keys to exit the search.</li> 1578 * <li>The application calls the {@link #stopSearch} 1579 * method, which will hide the search window and return focus to the 1580 * activity from which it was launched.</li> 1581 * 1582 * <p>Most applications will <i>not</i> use this interface to invoke search. 1583 * The primary method for invoking search is to call 1584 * {@link android.app.Activity#onSearchRequested Activity.onSearchRequested()} or 1585 * {@link android.app.Activity#startSearch Activity.startSearch()}. 1586 * 1587 * @param initialQuery A search string can be pre-entered here, but this 1588 * is typically null or empty. 1589 * @param selectInitialQuery If true, the intial query will be preselected, which means that 1590 * any further typing will replace it. This is useful for cases where an entire pre-formed 1591 * query is being inserted. If false, the selection point will be placed at the end of the 1592 * inserted query. This is useful when the inserted query is text that the user entered, 1593 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful 1594 * if initialQuery is a non-empty string.</i> 1595 * @param launchActivity The ComponentName of the activity that has launched this search. 1596 * @param appSearchData An application can insert application-specific 1597 * context here, in order to improve quality or specificity of its own 1598 * searches. This data will be returned with SEARCH intent(s). Null if 1599 * no extra data is required. 1600 * @param globalSearch If false, this will only launch the search that has been specifically 1601 * defined by the application (which is usually defined as a local search). If no default 1602 * search is defined in the current application or activity, global search will be launched. 1603 * If true, this will always launch a platform-global (e.g. web-based) search instead. 1604 * 1605 * @see android.app.Activity#onSearchRequested 1606 * @see #stopSearch 1607 */ 1608 public void startSearch(String initialQuery, 1609 boolean selectInitialQuery, 1610 ComponentName launchActivity, 1611 Bundle appSearchData, 1612 boolean globalSearch) { 1613 if (globalSearch) { 1614 startGlobalSearch(initialQuery, selectInitialQuery, appSearchData); 1615 return; 1616 } 1617 1618 ensureSearchDialog(); 1619 1620 mSearchDialog.show(initialQuery, selectInitialQuery, launchActivity, appSearchData); 1621 } 1622 1623 private void ensureSearchDialog() { 1624 if (mSearchDialog == null) { 1625 mSearchDialog = new SearchDialog(mContext, this); 1626 mSearchDialog.setOnCancelListener(this); 1627 mSearchDialog.setOnDismissListener(this); 1628 } 1629 } 1630 1631 /** 1632 * Starts the global search activity. 1633 */ 1634 /* package */ void startGlobalSearch(String initialQuery, boolean selectInitialQuery, 1635 Bundle appSearchData) { 1636 ComponentName globalSearchActivity = getGlobalSearchActivity(); 1637 if (globalSearchActivity == null) { 1638 Log.w(TAG, "No global search activity found."); 1639 return; 1640 } 1641 Intent intent = new Intent(INTENT_ACTION_GLOBAL_SEARCH); 1642 intent.setComponent(globalSearchActivity); 1643 // TODO: Always pass name of calling package as an extra? 1644 if (appSearchData != null) { 1645 intent.putExtra(APP_DATA, appSearchData); 1646 } 1647 if (!TextUtils.isEmpty(initialQuery)) { 1648 intent.putExtra(QUERY, initialQuery); 1649 } 1650 if (selectInitialQuery) { 1651 intent.putExtra(EXTRA_SELECT_QUERY, selectInitialQuery); 1652 } 1653 try { 1654 if (DBG) Log.d(TAG, "Starting global search: " + intent.toUri(0)); 1655 mContext.startActivity(intent); 1656 } catch (ActivityNotFoundException ex) { 1657 Log.e(TAG, "Global search activity not found: " + globalSearchActivity); 1658 } 1659 } 1660 1661 /** 1662 * Gets the name of the global search activity. 1663 * 1664 * This is currently implemented by returning the first activity that handles 1665 * the GLOBAL_SEARCH intent and has the GLOBAL_SEARCH permission. If we allow 1666 * more than one global search acitivity to be installed, this code must be changed. 1667 * 1668 * TODO: Doing this every time we start global search is inefficient. Will fix that once 1669 * we have settled on the right mechanism for finding the global search activity. 1670 * 1671 * @hide 1672 */ 1673 public ComponentName getGlobalSearchActivity() { 1674 Intent intent = new Intent(INTENT_ACTION_GLOBAL_SEARCH); 1675 PackageManager pm = mContext.getPackageManager(); 1676 List<ResolveInfo> activities = 1677 pm.queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY); 1678 int count = activities.size(); 1679 for (int i = 0; i < count; i++) { 1680 ActivityInfo ai = activities.get(i).activityInfo; 1681 if (pm.checkPermission(Manifest.permission.GLOBAL_SEARCH, 1682 ai.packageName) == PackageManager.PERMISSION_GRANTED) { 1683 return new ComponentName(ai.packageName, ai.name); 1684 } else { 1685 Log.w(TAG, "Package " + ai.packageName + " wants to handle GLOBAL_SEARCH, " 1686 + "but does not have the GLOBAL_SEARCH permission."); 1687 } 1688 } 1689 return null; 1690 } 1691 1692 /** 1693 * Gets the name of the web search activity. 1694 * 1695 * @return The name of the default activity for web searches. This activity 1696 * can be used to get web search suggestions. Returns {@code null} if 1697 * there is no default web search activity. 1698 * 1699 * @hide 1700 */ 1701 public ComponentName getWebSearchActivity() { 1702 ComponentName globalSearch = getGlobalSearchActivity(); 1703 if (globalSearch == null) { 1704 return null; 1705 } 1706 Intent intent = new Intent(Intent.ACTION_WEB_SEARCH); 1707 intent.setPackage(globalSearch.getPackageName()); 1708 return intent.resolveActivity(mContext.getPackageManager()); 1709 } 1710 1711 /** 1712 * Similar to {@link #startSearch} but actually fires off the search query after invoking 1713 * the search dialog. Made available for testing purposes. 1714 * 1715 * @param query The query to trigger. If empty, request will be ignored. 1716 * @param launchActivity The ComponentName of the activity that has launched this search. 1717 * @param appSearchData An application can insert application-specific 1718 * context here, in order to improve quality or specificity of its own 1719 * searches. This data will be returned with SEARCH intent(s). Null if 1720 * no extra data is required. 1721 * 1722 * @see #startSearch 1723 */ 1724 public void triggerSearch(String query, 1725 ComponentName launchActivity, 1726 Bundle appSearchData) { 1727 if (!mAssociatedPackage.equals(launchActivity.getPackageName())) { 1728 throw new IllegalArgumentException("invoking app search on a different package " + 1729 "not associated with this search manager"); 1730 } 1731 if (query == null || TextUtils.getTrimmedLength(query) == 0) { 1732 Log.w(TAG, "triggerSearch called with empty query, ignoring."); 1733 return; 1734 } 1735 startSearch(query, false, launchActivity, appSearchData, false); 1736 mSearchDialog.launchQuerySearch(); 1737 } 1738 1739 /** 1740 * Terminate search UI. 1741 * 1742 * <p>Typically the user will terminate the search UI by launching a 1743 * search or by canceling. This function allows the underlying application 1744 * or activity to cancel the search prematurely (for any reason). 1745 * 1746 * <p>This function can be safely called at any time (even if no search is active.) 1747 * 1748 * @see #startSearch 1749 */ 1750 public void stopSearch() { 1751 if (mSearchDialog != null) { 1752 mSearchDialog.cancel(); 1753 } 1754 } 1755 1756 /** 1757 * Determine if the Search UI is currently displayed. 1758 * 1759 * This is provided primarily for application test purposes. 1760 * 1761 * @return Returns true if the search UI is currently displayed. 1762 * 1763 * @hide 1764 */ 1765 public boolean isVisible() { 1766 return mSearchDialog == null? false : mSearchDialog.isShowing(); 1767 } 1768 1769 /** 1770 * See {@link SearchManager#setOnDismissListener} for configuring your activity to monitor 1771 * search UI state. 1772 */ 1773 public interface OnDismissListener { 1774 /** 1775 * This method will be called when the search UI is dismissed. To make use of it, you must 1776 * implement this method in your activity, and call 1777 * {@link SearchManager#setOnDismissListener} to register it. 1778 */ 1779 public void onDismiss(); 1780 } 1781 1782 /** 1783 * See {@link SearchManager#setOnCancelListener} for configuring your activity to monitor 1784 * search UI state. 1785 */ 1786 public interface OnCancelListener { 1787 /** 1788 * This method will be called when the search UI is canceled. To make use if it, you must 1789 * implement this method in your activity, and call 1790 * {@link SearchManager#setOnCancelListener} to register it. 1791 */ 1792 public void onCancel(); 1793 } 1794 1795 /** 1796 * Set or clear the callback that will be invoked whenever the search UI is dismissed. 1797 * 1798 * @param listener The {@link OnDismissListener} to use, or null. 1799 */ 1800 public void setOnDismissListener(final OnDismissListener listener) { 1801 mDismissListener = listener; 1802 } 1803 1804 /** 1805 * Set or clear the callback that will be invoked whenever the search UI is canceled. 1806 * 1807 * @param listener The {@link OnCancelListener} to use, or null. 1808 */ 1809 public void setOnCancelListener(OnCancelListener listener) { 1810 mCancelListener = listener; 1811 } 1812 1813 /** 1814 * @deprecated This method is an obsolete internal implementation detail. Do not use. 1815 */ 1816 @Deprecated 1817 public void onCancel(DialogInterface dialog) { 1818 if (mCancelListener != null) { 1819 mCancelListener.onCancel(); 1820 } 1821 } 1822 1823 /** 1824 * @deprecated This method is an obsolete internal implementation detail. Do not use. 1825 */ 1826 @Deprecated 1827 public void onDismiss(DialogInterface dialog) { 1828 if (mDismissListener != null) { 1829 mDismissListener.onDismiss(); 1830 } 1831 } 1832 1833 /** 1834 * Gets information about a searchable activity. 1835 * 1836 * @param componentName The activity to get searchable information for. 1837 * @return Searchable information, or <code>null</code> if the activity does not 1838 * exist, or is not searchable. 1839 */ 1840 public SearchableInfo getSearchableInfo(ComponentName componentName) { 1841 try { 1842 return mService.getSearchableInfo(componentName, false); 1843 } catch (RemoteException ex) { 1844 Log.e(TAG, "getSearchableInfo() failed: " + ex); 1845 return null; 1846 } 1847 } 1848 1849 /** 1850 * Gets information about a searchable activity. 1851 * 1852 * @param componentName The activity to get searchable information for. 1853 * @param globalSearch If <code>false</code>, return information about the given activity. 1854 * If <code>true</code>, return information about the global search activity. 1855 * @return Searchable information, or <code>null</code> if the activity is not searchable. 1856 * 1857 * @hide because SearchableInfo is not part of the API. 1858 */ 1859 public SearchableInfo getSearchableInfo(ComponentName componentName, 1860 boolean globalSearch) { 1861 try { 1862 return mService.getSearchableInfo(componentName, globalSearch); 1863 } catch (RemoteException ex) { 1864 Log.e(TAG, "getSearchableInfo() failed: " + ex); 1865 return null; 1866 } 1867 } 1868 1869 /** 1870 * Gets a cursor with search suggestions. 1871 * 1872 * @param searchable Information about how to get the suggestions. 1873 * @param query The search text entered (so far). 1874 * @return a cursor with suggestions, or <code>null</null> the suggestion query failed. 1875 * 1876 * @hide because SearchableInfo is not part of the API. 1877 */ 1878 public Cursor getSuggestions(SearchableInfo searchable, String query) { 1879 return getSuggestions(searchable, query, -1); 1880 } 1881 1882 /** 1883 * Gets a cursor with search suggestions. 1884 * 1885 * @param searchable Information about how to get the suggestions. 1886 * @param query The search text entered (so far). 1887 * @param limit The query limit to pass to the suggestion provider. This is advisory, 1888 * the returned cursor may contain more rows. Pass {@code -1} for no limit. 1889 * @return a cursor with suggestions, or <code>null</null> the suggestion query failed. 1890 * 1891 * @hide because SearchableInfo is not part of the API. 1892 */ 1893 public Cursor getSuggestions(SearchableInfo searchable, String query, int limit) { 1894 if (searchable == null) { 1895 return null; 1896 } 1897 1898 String authority = searchable.getSuggestAuthority(); 1899 if (authority == null) { 1900 return null; 1901 } 1902 1903 Uri.Builder uriBuilder = new Uri.Builder() 1904 .scheme(ContentResolver.SCHEME_CONTENT) 1905 .authority(authority) 1906 .query("") // TODO: Remove, workaround for a bug in Uri.writeToParcel() 1907 .fragment(""); // TODO: Remove, workaround for a bug in Uri.writeToParcel() 1908 1909 // if content path provided, insert it now 1910 final String contentPath = searchable.getSuggestPath(); 1911 if (contentPath != null) { 1912 uriBuilder.appendEncodedPath(contentPath); 1913 } 1914 1915 // append standard suggestion query path 1916 uriBuilder.appendPath(SearchManager.SUGGEST_URI_PATH_QUERY); 1917 1918 // get the query selection, may be null 1919 String selection = searchable.getSuggestSelection(); 1920 // inject query, either as selection args or inline 1921 String[] selArgs = null; 1922 if (selection != null) { // use selection if provided 1923 selArgs = new String[] { query }; 1924 } else { // no selection, use REST pattern 1925 uriBuilder.appendPath(query); 1926 } 1927 1928 if (limit > 0) { 1929 uriBuilder.appendQueryParameter(SUGGEST_PARAMETER_LIMIT, String.valueOf(limit)); 1930 } 1931 1932 Uri uri = uriBuilder.build(); 1933 1934 // finally, make the query 1935 return mContext.getContentResolver().query(uri, null, selection, selArgs, null); 1936 } 1937 1938 /** 1939 * Returns a list of the searchable activities that can be included in global search. 1940 * 1941 * @return a list containing searchable information for all searchable activities 1942 * that have the <code>android:includeInGlobalSearch</code> attribute set 1943 * in their searchable meta-data. 1944 */ 1945 public List<SearchableInfo> getSearchablesInGlobalSearch() { 1946 try { 1947 return mService.getSearchablesInGlobalSearch(); 1948 } catch (RemoteException e) { 1949 Log.e(TAG, "getSearchablesInGlobalSearch() failed: " + e); 1950 return null; 1951 } 1952 } 1953 1954} 1955