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