The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 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 | |
| 17 | package android.app; |
| 18 | |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 19 | import android.annotation.SystemService; |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 20 | import android.annotation.UnsupportedAppUsage; |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 21 | import android.content.ActivityNotFoundException; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 22 | import android.content.ComponentName; |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 23 | import android.content.ContentResolver; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 24 | import android.content.Context; |
| 25 | import android.content.DialogInterface; |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 26 | import android.content.Intent; |
Narayan Kamath | ee69ff4 | 2011-06-28 12:07:18 +0100 | [diff] [blame] | 27 | import android.content.pm.ResolveInfo; |
Tim Kilbourn | 99e9095 | 2014-10-08 17:01:42 -0700 | [diff] [blame] | 28 | import android.content.res.Configuration; |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 29 | import android.database.Cursor; |
Mathew Inwood | 050453e | 2011-10-13 11:00:39 +0100 | [diff] [blame] | 30 | import android.graphics.Rect; |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 31 | import android.net.Uri; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 32 | import android.os.Bundle; |
| 33 | import android.os.Handler; |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 34 | import android.os.RemoteException; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 35 | import android.os.ServiceManager; |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 36 | import android.os.ServiceManager.ServiceNotFoundException; |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 37 | import android.text.TextUtils; |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 38 | import android.util.Log; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 39 | import android.view.KeyEvent; |
| 40 | |
Bjorn Bringert | 6d72e02 | 2009-04-29 14:56:12 +0100 | [diff] [blame] | 41 | import java.util.List; |
| 42 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 43 | /** |
| 44 | * This class provides access to the system search services. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 45 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 46 | * <p>In practice, you won't interact with this class directly, as search |
| 47 | * services are provided through methods in {@link android.app.Activity Activity} |
Scott Main | 8ad6465 | 2010-03-17 12:06:06 -0700 | [diff] [blame] | 48 | * and the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} |
| 49 | * {@link android.content.Intent Intent}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 50 | * |
Erik Wolsheimer | ac5cecd | 2017-12-05 13:11:50 -0800 | [diff] [blame] | 51 | * <p> |
| 52 | * {@link Configuration#UI_MODE_TYPE_WATCH} does not support this system service. |
| 53 | * |
Joe Fernandez | 3aef8e1d | 2011-12-20 10:38:34 -0800 | [diff] [blame] | 54 | * <div class="special reference"> |
| 55 | * <h3>Developer Guides</h3> |
| 56 | * <p>For more information about using the search dialog and adding search |
| 57 | * suggestions in your application, read the |
| 58 | * <a href="{@docRoot}guide/topics/search/index.html">Search</a> developer guide.</p> |
Scott Main | 8ad6465 | 2010-03-17 12:06:06 -0700 | [diff] [blame] | 59 | * </div> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 60 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 61 | @SystemService(Context.SEARCH_SERVICE) |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 62 | public class SearchManager |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 63 | implements DialogInterface.OnDismissListener, DialogInterface.OnCancelListener { |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 64 | |
| 65 | private static final boolean DBG = false; |
| 66 | private static final String TAG = "SearchManager"; |
| 67 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 68 | /** |
| 69 | * This is a shortcut definition for the default menu key to use for invoking search. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 70 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 71 | * See Menu.Item.setAlphabeticShortcut() for more information. |
| 72 | */ |
| 73 | public final static char MENU_KEY = 's'; |
| 74 | |
| 75 | /** |
| 76 | * This is a shortcut definition for the default menu key to use for invoking search. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 77 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 78 | * See Menu.Item.setAlphabeticShortcut() for more information. |
| 79 | */ |
| 80 | public final static int MENU_KEYCODE = KeyEvent.KEYCODE_S; |
| 81 | |
| 82 | /** |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 83 | * Intent extra data key: Use this key with |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 84 | * {@link android.content.Intent#getStringExtra |
| 85 | * content.Intent.getStringExtra()} |
| 86 | * to obtain the query string from Intent.ACTION_SEARCH. |
| 87 | */ |
| 88 | public final static String QUERY = "query"; |
| 89 | |
| 90 | /** |
Bjorn Bringert | 5f80605 | 2009-06-24 12:02:26 +0100 | [diff] [blame] | 91 | * Intent extra data key: Use this key with |
| 92 | * {@link android.content.Intent#getStringExtra |
| 93 | * content.Intent.getStringExtra()} |
| 94 | * to obtain the query string typed in by the user. |
| 95 | * This may be different from the value of {@link #QUERY} |
| 96 | * if the intent is the result of selecting a suggestion. |
| 97 | * In that case, {@link #QUERY} will contain the value of |
| 98 | * {@link #SUGGEST_COLUMN_QUERY} for the suggestion, and |
| 99 | * {@link #USER_QUERY} will contain the string typed by the |
| 100 | * user. |
| 101 | */ |
| 102 | public final static String USER_QUERY = "user_query"; |
| 103 | |
| 104 | /** |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 105 | * Intent extra data key: Use this key with Intent.ACTION_SEARCH and |
| 106 | * {@link android.content.Intent#getBundleExtra |
| 107 | * content.Intent.getBundleExtra()} |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 108 | * to obtain any additional app-specific data that was inserted by the |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 109 | * activity that launched the search. |
| 110 | */ |
| 111 | public final static String APP_DATA = "app_data"; |
| 112 | |
| 113 | /** |
Bjorn Bringert | be5b73c | 2009-09-21 23:05:23 +0100 | [diff] [blame] | 114 | * Intent extra data key: Use {@link android.content.Intent#getBundleExtra |
| 115 | * content.Intent.getBundleExtra(SEARCH_MODE)} to get the search mode used |
| 116 | * to launch the intent. |
| 117 | * The only current value for this is {@link #MODE_GLOBAL_SEARCH_SUGGESTION}. |
| 118 | * |
| 119 | * @hide |
| 120 | */ |
| 121 | public final static String SEARCH_MODE = "search_mode"; |
| 122 | |
| 123 | /** |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 124 | * Intent extra data key: Use this key with Intent.ACTION_SEARCH and |
| 125 | * {@link android.content.Intent#getIntExtra content.Intent.getIntExtra()} |
| 126 | * to obtain the keycode that the user used to trigger this query. It will be zero if the |
| 127 | * user simply pressed the "GO" button on the search UI. This is primarily used in conjunction |
| 128 | * with the keycode attribute in the actionkey element of your searchable.xml configuration |
| 129 | * file. |
| 130 | */ |
| 131 | public final static String ACTION_KEY = "action_key"; |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 132 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 133 | /** |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 134 | * Intent extra data key: This key will be used for the extra populated by the |
| 135 | * {@link #SUGGEST_COLUMN_INTENT_EXTRA_DATA} column. |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 136 | */ |
| 137 | public final static String EXTRA_DATA_KEY = "intent_extra_data_key"; |
Karl Rosaen | a058f02 | 2009-06-01 23:11:44 +0100 | [diff] [blame] | 138 | |
Karl Rosaen | a058f02 | 2009-06-01 23:11:44 +0100 | [diff] [blame] | 139 | /** |
Bjorn Bringert | 55f3ac5 | 2010-01-14 11:38:22 +0000 | [diff] [blame] | 140 | * Boolean extra data key for {@link #INTENT_ACTION_GLOBAL_SEARCH} intents. If {@code true}, |
| 141 | * the initial query should be selected when the global search activity is started, so |
| 142 | * that the user can easily replace it with another query. |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 143 | */ |
Bjorn Bringert | 55f3ac5 | 2010-01-14 11:38:22 +0000 | [diff] [blame] | 144 | public final static String EXTRA_SELECT_QUERY = "select_query"; |
Bjorn Bringert | 32d580c | 2010-01-06 09:29:11 +0000 | [diff] [blame] | 145 | |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 146 | /** |
Leon Scroggins | af5b406 | 2011-02-22 16:35:13 -0500 | [diff] [blame] | 147 | * Boolean extra data key for {@link Intent#ACTION_WEB_SEARCH} intents. If {@code true}, |
| 148 | * this search should open a new browser window, rather than using an existing one. |
| 149 | */ |
| 150 | public final static String EXTRA_NEW_SEARCH = "new_search"; |
| 151 | |
| 152 | /** |
Bjorn Bringert | 4519ff6 | 2011-08-10 15:42:11 -0700 | [diff] [blame] | 153 | * Extra data key for {@link Intent#ACTION_WEB_SEARCH}. If set, the value must be a |
| 154 | * {@link PendingIntent}. The search activity handling the {@link Intent#ACTION_WEB_SEARCH} |
| 155 | * intent will fill in and launch the pending intent. The data URI will be filled in with an |
| 156 | * http or https URI, and {@link android.provider.Browser#EXTRA_HEADERS} may be filled in. |
| 157 | */ |
| 158 | public static final String EXTRA_WEB_SEARCH_PENDINGINTENT = "web_search_pendingintent"; |
| 159 | |
| 160 | /** |
Amith Yamasani | c37cb24 | 2010-02-24 17:44:46 -0800 | [diff] [blame] | 161 | * Boolean extra data key for a suggestion provider to return in {@link Cursor#getExtras} to |
| 162 | * indicate that the search is not complete yet. This can be used by the search UI |
| 163 | * to indicate that a search is in progress. The suggestion provider can return partial results |
| 164 | * this way and send a change notification on the cursor when more results are available. |
| 165 | */ |
| 166 | public final static String CURSOR_EXTRA_KEY_IN_PROGRESS = "in_progress"; |
| 167 | |
| 168 | /** |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 169 | * Intent extra data key: Use this key with Intent.ACTION_SEARCH and |
| 170 | * {@link android.content.Intent#getStringExtra content.Intent.getStringExtra()} |
| 171 | * to obtain the action message that was defined for a particular search action key and/or |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 172 | * suggestion. It will be null if the search was launched by typing "enter", touched the the |
| 173 | * "GO" button, or other means not involving any action key. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 174 | */ |
| 175 | public final static String ACTION_MSG = "action_msg"; |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 176 | |
| 177 | /** |
| 178 | * Flag to specify that the entry can be used for query refinement, i.e., the query text |
| 179 | * in the search field can be replaced with the text in this entry, when a query refinement |
| 180 | * icon is clicked. The suggestion list should show such a clickable icon beside the entry. |
| 181 | * <p>Use this flag as a bit-field for {@link #SUGGEST_COLUMN_FLAGS}. |
| 182 | */ |
| 183 | public final static int FLAG_QUERY_REFINEMENT = 1 << 0; |
| 184 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 185 | /** |
| 186 | * Uri path for queried suggestions data. This is the path that the search manager |
| 187 | * will use when querying your content provider for suggestions data based on user input |
| 188 | * (e.g. looking for partial matches). |
| 189 | * Typically you'll use this with a URI matcher. |
| 190 | */ |
| 191 | public final static String SUGGEST_URI_PATH_QUERY = "search_suggest_query"; |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 192 | |
| 193 | /** |
Karl Rosaen | b619c91 | 2009-05-08 14:28:51 -0700 | [diff] [blame] | 194 | * MIME type for suggestions data. You'll use this in your suggestions content provider |
| 195 | * in the getType() function. |
| 196 | */ |
| 197 | public final static String SUGGEST_MIME_TYPE = |
| 198 | "vnd.android.cursor.dir/vnd.android.search.suggest"; |
| 199 | |
| 200 | /** |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 201 | * Uri path for shortcut validation. This is the path that the search manager will use when |
| 202 | * querying your content provider to refresh a shortcutted suggestion result and to check if it |
| 203 | * is still valid. When asked, a source may return an up to date result, or no result. No |
| 204 | * result indicates the shortcut refers to a no longer valid sugggestion. |
| 205 | * |
| 206 | * @see #SUGGEST_COLUMN_SHORTCUT_ID |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 207 | */ |
| 208 | public final static String SUGGEST_URI_PATH_SHORTCUT = "search_suggest_shortcut"; |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 209 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 210 | /** |
Karl Rosaen | b619c91 | 2009-05-08 14:28:51 -0700 | [diff] [blame] | 211 | * MIME type for shortcut validation. You'll use this in your suggestions content provider |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 212 | * in the getType() function. |
| 213 | */ |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 214 | public final static String SHORTCUT_MIME_TYPE = |
Karl Rosaen | b619c91 | 2009-05-08 14:28:51 -0700 | [diff] [blame] | 215 | "vnd.android.cursor.item/vnd.android.search.suggest"; |
Karl Rosaen | d4c98c4 | 2009-06-09 17:05:54 +0100 | [diff] [blame] | 216 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 217 | /** |
| 218 | * Column name for suggestions cursor. <i>Unused - can be null or column can be omitted.</i> |
| 219 | */ |
| 220 | public final static String SUGGEST_COLUMN_FORMAT = "suggest_format"; |
| 221 | /** |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 222 | * Column name for suggestions cursor. <i>Required.</i> This is the primary line of text that |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 223 | * will be presented to the user as the suggestion. |
| 224 | */ |
| 225 | public final static String SUGGEST_COLUMN_TEXT_1 = "suggest_text_1"; |
| 226 | /** |
| 227 | * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, |
| 228 | * then all suggestions will be provided in a two-line format. The second line of text is in |
| 229 | * a much smaller appearance. |
| 230 | */ |
| 231 | public final static String SUGGEST_COLUMN_TEXT_2 = "suggest_text_2"; |
Bjorn Bringert | 0b49ab5 | 2010-03-02 11:16:17 +0000 | [diff] [blame] | 232 | |
| 233 | /** |
| 234 | * Column name for suggestions cursor. <i>Optional.</i> This is a URL that will be shown |
| 235 | * as the second line of text instead of {@link #SUGGEST_COLUMN_TEXT_2}. This is a separate |
| 236 | * column so that the search UI knows to display the text as a URL, e.g. by using a different |
| 237 | * color. If this column is absent, or has the value {@code null}, |
| 238 | * {@link #SUGGEST_COLUMN_TEXT_2} will be used instead. |
| 239 | */ |
| 240 | public final static String SUGGEST_COLUMN_TEXT_2_URL = "suggest_text_2_url"; |
| 241 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 242 | /** |
| 243 | * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 244 | * then all suggestions will be provided in a format that includes space for two small icons, |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 245 | * one at the left and one at the right of each suggestion. The data in the column must |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 246 | * be a resource ID of a drawable, or a URI in one of the following formats: |
| 247 | * |
| 248 | * <ul> |
| 249 | * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> |
| 250 | * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> |
| 251 | * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> |
| 252 | * </ul> |
| 253 | * |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 254 | * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} |
| 255 | * for more information on these schemes. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 256 | */ |
| 257 | public final static String SUGGEST_COLUMN_ICON_1 = "suggest_icon_1"; |
Xiaolei Wang | b2b2ac1 | 2014-05-28 15:18:15 -0700 | [diff] [blame] | 258 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 259 | /** |
| 260 | * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 261 | * then all suggestions will be provided in a format that includes space for two small icons, |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 262 | * one at the left and one at the right of each suggestion. The data in the column must |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 263 | * be a resource ID of a drawable, or a URI in one of the following formats: |
| 264 | * |
| 265 | * <ul> |
| 266 | * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> |
| 267 | * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> |
| 268 | * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> |
| 269 | * </ul> |
| 270 | * |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 271 | * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} |
| 272 | * for more information on these schemes. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 273 | */ |
| 274 | public final static String SUGGEST_COLUMN_ICON_2 = "suggest_icon_2"; |
Xiaolei Wang | b2b2ac1 | 2014-05-28 15:18:15 -0700 | [diff] [blame] | 275 | |
| 276 | /** |
| 277 | * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, |
| 278 | * then the image will be displayed when forming the suggestion. The suggested dimension for |
| 279 | * the image is 270x400 px for portrait mode and 400x225 px for landscape mode. The data in the |
| 280 | * column must be a resource ID of a drawable, or a URI in one of the following formats: |
| 281 | * |
| 282 | * <ul> |
| 283 | * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> |
| 284 | * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> |
| 285 | * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> |
| 286 | * </ul> |
| 287 | * |
| 288 | * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} |
| 289 | * for more information on these schemes. |
| 290 | */ |
| 291 | public final static String SUGGEST_COLUMN_RESULT_CARD_IMAGE = "suggest_result_card_image"; |
| 292 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 293 | /** |
| 294 | * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> |
| 295 | * this element exists at the given row, this is the action that will be used when |
| 296 | * forming the suggestion's intent. If the element is not provided, the action will be taken |
| 297 | * from the android:searchSuggestIntentAction field in your XML metadata. <i>At least one of |
| 298 | * these must be present for the suggestion to generate an intent.</i> Note: If your action is |
| 299 | * the same for all suggestions, it is more efficient to specify it using XML metadata and omit |
| 300 | * it from the cursor. |
| 301 | */ |
| 302 | public final static String SUGGEST_COLUMN_INTENT_ACTION = "suggest_intent_action"; |
Xiaolei Wang | b2b2ac1 | 2014-05-28 15:18:15 -0700 | [diff] [blame] | 303 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 304 | /** |
| 305 | * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> |
| 306 | * this element exists at the given row, this is the data that will be used when |
| 307 | * forming the suggestion's intent. If the element is not provided, the data will be taken |
| 308 | * from the android:searchSuggestIntentData field in your XML metadata. If neither source |
| 309 | * is provided, the Intent's data field will be null. Note: If your data is |
| 310 | * the same for all suggestions, or can be described using a constant part and a specific ID, |
| 311 | * it is more efficient to specify it using XML metadata and omit it from the cursor. |
| 312 | */ |
| 313 | public final static String SUGGEST_COLUMN_INTENT_DATA = "suggest_intent_data"; |
Xiaolei Wang | b2b2ac1 | 2014-05-28 15:18:15 -0700 | [diff] [blame] | 314 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 315 | /** |
Satish Sampath | bf23fe0 | 2009-06-15 23:47:56 +0100 | [diff] [blame] | 316 | * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> |
| 317 | * this element exists at the given row, this is the data that will be used when |
| 318 | * forming the suggestion's intent. If not provided, the Intent's extra data field will be null. |
| 319 | * This column allows suggestions to provide additional arbitrary data which will be included as |
Mike LeBeau | 131234c | 2009-07-20 14:09:52 -0700 | [diff] [blame] | 320 | * an extra under the key {@link #EXTRA_DATA_KEY}. |
Satish Sampath | bf23fe0 | 2009-06-15 23:47:56 +0100 | [diff] [blame] | 321 | */ |
| 322 | public final static String SUGGEST_COLUMN_INTENT_EXTRA_DATA = "suggest_intent_extra_data"; |
Xiaolei Wang | b2b2ac1 | 2014-05-28 15:18:15 -0700 | [diff] [blame] | 323 | |
Satish Sampath | bf23fe0 | 2009-06-15 23:47:56 +0100 | [diff] [blame] | 324 | /** |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 325 | * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> |
| 326 | * this element exists at the given row, then "/" and this value will be appended to the data |
| 327 | * field in the Intent. This should only be used if the data field has already been set to an |
| 328 | * appropriate base string. |
| 329 | */ |
| 330 | public final static String SUGGEST_COLUMN_INTENT_DATA_ID = "suggest_intent_data_id"; |
Xiaolei Wang | b2b2ac1 | 2014-05-28 15:18:15 -0700 | [diff] [blame] | 331 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 332 | /** |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 333 | * Column name for suggestions cursor. <i>Required if action is |
| 334 | * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH}, optional otherwise.</i> If this |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 335 | * column exists <i>and</i> this element exists at the given row, this is the data that will be |
| 336 | * used when forming the suggestion's query. |
| 337 | */ |
| 338 | public final static String SUGGEST_COLUMN_QUERY = "suggest_intent_query"; |
| 339 | |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 340 | /** |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 341 | * Column name for suggestions cursor. <i>Optional.</i> This column is used to indicate whether |
Karl Rosaen | b504136 | 2009-08-11 11:35:07 -0700 | [diff] [blame] | 342 | * a search suggestion should be stored as a shortcut, and whether it should be refreshed. If |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 343 | * missing, the result will be stored as a shortcut and never validated. If set to |
| 344 | * {@link #SUGGEST_NEVER_MAKE_SHORTCUT}, the result will not be stored as a shortcut. |
Karl Rosaen | b504136 | 2009-08-11 11:35:07 -0700 | [diff] [blame] | 345 | * Otherwise, the shortcut id will be used to check back for an up to date suggestion using |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 346 | * {@link #SUGGEST_URI_PATH_SHORTCUT}. |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 347 | */ |
| 348 | public final static String SUGGEST_COLUMN_SHORTCUT_ID = "suggest_shortcut_id"; |
| 349 | |
| 350 | /** |
Mike LeBeau | ce0959d | 2009-06-10 23:47:54 +0100 | [diff] [blame] | 351 | * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify |
| 352 | * that a spinner should be shown in lieu of an icon2 while the shortcut of this suggestion |
| 353 | * is being refreshed. |
Mike LeBeau | ce0959d | 2009-06-10 23:47:54 +0100 | [diff] [blame] | 354 | */ |
| 355 | public final static String SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING = |
| 356 | "suggest_spinner_while_refreshing"; |
Satish Sampath | 1c5fa0f | 2009-06-08 23:10:40 +0100 | [diff] [blame] | 357 | |
| 358 | /** |
Xiaolei Wang | b2b2ac1 | 2014-05-28 15:18:15 -0700 | [diff] [blame] | 359 | * Column name for suggestions cursor. <i>Optional.</i> If your content is media type, you |
| 360 | * should provide this column so search app could understand more about your content. The data |
| 361 | * in the column must specify the MIME type of the content. |
| 362 | */ |
| 363 | public final static String SUGGEST_COLUMN_CONTENT_TYPE = "suggest_content_type"; |
| 364 | |
| 365 | /** |
| 366 | * Column name for suggestions cursor. <i>Optional.</i> If your content is media type, you |
| 367 | * should provide this column to specify whether your content is live media such as live video |
| 368 | * or live audio. The value in the column is of integer type with value of either 0 indicating |
| 369 | * non-live content or 1 indicating live content. |
| 370 | */ |
| 371 | public final static String SUGGEST_COLUMN_IS_LIVE = "suggest_is_live"; |
| 372 | |
| 373 | /** |
| 374 | * Column name for suggestions cursor. <i>Optional.</i> If your content is video, you should |
| 375 | * provide this column to specify the number of vertical lines. The data in the column is of |
| 376 | * integer type. |
| 377 | */ |
| 378 | public final static String SUGGEST_COLUMN_VIDEO_WIDTH = "suggest_video_width"; |
| 379 | |
| 380 | /** |
| 381 | * Column name for suggestions cursor. <i>Optional.</i> If your content is video, you should |
| 382 | * provide this column to specify the number of horizontal lines. The data in the column is of |
| 383 | * integer type. |
| 384 | */ |
| 385 | public final static String SUGGEST_COLUMN_VIDEO_HEIGHT = "suggest_video_height"; |
| 386 | |
| 387 | /** |
| 388 | * Column name for suggestions cursor. <i>Optional.</i> If your content contains audio, you |
| 389 | * should provide this column to specify the audio channel configuration. The data in the |
| 390 | * column is string with format like "channels.subchannels" such as "1.0" or "5.1". |
| 391 | */ |
| 392 | public final static String SUGGEST_COLUMN_AUDIO_CHANNEL_CONFIG = "suggest_audio_channel_config"; |
| 393 | |
| 394 | /** |
| 395 | * Column name for suggestions cursor. <i>Optional.</i> If your content is purchasable, you |
| 396 | * should provide this column to specify the displayable string representation of the purchase |
| 397 | * price of your content including the currency and the amount. If it's free, you should |
| 398 | * provide localized string to specify that it's free. This column can be omitted if the content |
| 399 | * is not applicable to purchase. |
| 400 | */ |
| 401 | public final static String SUGGEST_COLUMN_PURCHASE_PRICE = "suggest_purchase_price"; |
| 402 | |
| 403 | /** |
| 404 | * Column name for suggestions cursor. <i>Optional.</i> If your content is rentable, you |
| 405 | * should provide this column to specify the displayable string representation of the rental |
| 406 | * price of your content including the currency and the amount. If it's free, you should |
| 407 | * provide localized string to specify that it's free. This column can be ommitted if the |
| 408 | * content is not applicable to rent. |
| 409 | */ |
| 410 | public final static String SUGGEST_COLUMN_RENTAL_PRICE = "suggest_rental_price"; |
| 411 | |
| 412 | /** |
| 413 | * Column name for suggestions cursor. <i>Optional.</i> If your content has a rating, you |
| 414 | * should provide this column to specify the rating style of your content. The data in the |
| 415 | * column must be one of the constant values specified in {@link android.media.Rating} |
| 416 | */ |
| 417 | public final static String SUGGEST_COLUMN_RATING_STYLE = "suggest_rating_style"; |
| 418 | |
| 419 | /** |
| 420 | * Column name for suggestions cursor. <i>Optional.</i> If your content has a rating, you |
| 421 | * should provide this column to specify the rating score of your content. The data in the |
| 422 | * column is of float type. See {@link android.media.Rating} about valid rating scores for each |
| 423 | * rating style. |
| 424 | */ |
| 425 | public final static String SUGGEST_COLUMN_RATING_SCORE = "suggest_rating_score"; |
| 426 | |
| 427 | /** |
| 428 | * Column name for suggestions cursor. <i>Optional.</i> If your content is video or audio and |
| 429 | * has a known production year, you should provide this column to specify the production year |
| 430 | * of your content. The data in the column is of integer type. |
| 431 | */ |
| 432 | public final static String SUGGEST_COLUMN_PRODUCTION_YEAR = "suggest_production_year"; |
| 433 | |
| 434 | /** |
| 435 | * Column name for suggestions cursor. <i>Optional.</i> If your content is video or audio, you |
| 436 | * should provide this column to specify the duration of your content in milliseconds. The data |
| 437 | * in the column is of long type. |
| 438 | */ |
| 439 | public final static String SUGGEST_COLUMN_DURATION = "suggest_duration"; |
| 440 | |
| 441 | /** |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 442 | * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify |
| 443 | * additional flags per item. Multiple flags can be specified. |
| 444 | * <p> |
| 445 | * Must be one of {@link #FLAG_QUERY_REFINEMENT} or 0 to indicate no flags. |
| 446 | * </p> |
| 447 | */ |
| 448 | public final static String SUGGEST_COLUMN_FLAGS = "suggest_flags"; |
| 449 | |
| 450 | /** |
Mark Brophy | a31c7aa | 2011-06-17 16:36:38 +0100 | [diff] [blame] | 451 | * Column name for suggestions cursor. <i>Optional.</i> This column may be |
Mark Brophy | de2ba4c | 2011-09-16 12:27:20 +0100 | [diff] [blame] | 452 | * used to specify the time in {@link System#currentTimeMillis |
Mark Brophy | a31c7aa | 2011-06-17 16:36:38 +0100 | [diff] [blame] | 453 | * System.currentTImeMillis()} (wall time in UTC) when an item was last |
| 454 | * accessed within the results-providing application. If set, this may be |
| 455 | * used to show more-recently-used items first. |
| 456 | */ |
| 457 | public final static String SUGGEST_COLUMN_LAST_ACCESS_HINT = "suggest_last_access_hint"; |
| 458 | |
| 459 | /** |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 460 | * Column value for suggestion column {@link #SUGGEST_COLUMN_SHORTCUT_ID} when a suggestion |
| 461 | * should not be stored as a shortcut in global search. |
Karl Rosaen | b2a5011 | 2009-05-05 21:14:01 -0700 | [diff] [blame] | 462 | */ |
| 463 | public final static String SUGGEST_NEVER_MAKE_SHORTCUT = "_-1"; |
| 464 | |
| 465 | /** |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 466 | * Query parameter added to suggestion queries to limit the number of suggestions returned. |
Bjorn Bringert | 86917db | 2009-09-28 22:00:50 +0100 | [diff] [blame] | 467 | * This limit is only advisory and suggestion providers may chose to ignore it. |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 468 | */ |
| 469 | public final static String SUGGEST_PARAMETER_LIMIT = "limit"; |
| 470 | |
| 471 | /** |
Bjorn Bringert | 55f3ac5 | 2010-01-14 11:38:22 +0000 | [diff] [blame] | 472 | * Intent action for starting the global search activity. |
Bjorn Bringert | 74708bb | 2009-04-28 11:26:52 +0100 | [diff] [blame] | 473 | * The global search provider should handle this intent. |
Bjorn Bringert | 55f3ac5 | 2010-01-14 11:38:22 +0000 | [diff] [blame] | 474 | * |
| 475 | * Supported extra data keys: {@link #QUERY}, |
| 476 | * {@link #EXTRA_SELECT_QUERY}, |
| 477 | * {@link #APP_DATA}. |
Bjorn Bringert | 74708bb | 2009-04-28 11:26:52 +0100 | [diff] [blame] | 478 | */ |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 479 | public final static String INTENT_ACTION_GLOBAL_SEARCH |
Bjorn Bringert | 74708bb | 2009-04-28 11:26:52 +0100 | [diff] [blame] | 480 | = "android.search.action.GLOBAL_SEARCH"; |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 481 | |
Bjorn Bringert | 74708bb | 2009-04-28 11:26:52 +0100 | [diff] [blame] | 482 | /** |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 483 | * Intent action for starting the global search settings activity. |
| 484 | * The global search provider should handle this intent. |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 485 | */ |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 486 | public final static String INTENT_ACTION_SEARCH_SETTINGS |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 487 | = "android.search.action.SEARCH_SETTINGS"; |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 488 | |
Mike LeBeau | 3a27803 | 2009-06-04 14:09:42 +0100 | [diff] [blame] | 489 | /** |
| 490 | * Intent action for starting a web search provider's settings activity. |
| 491 | * Web search providers should handle this intent if they have provider-specific |
| 492 | * settings to implement. |
Mike LeBeau | 3a27803 | 2009-06-04 14:09:42 +0100 | [diff] [blame] | 493 | */ |
| 494 | public final static String INTENT_ACTION_WEB_SEARCH_SETTINGS |
| 495 | = "android.search.action.WEB_SEARCH_SETTINGS"; |
Karl Rosaen | a058f02 | 2009-06-01 23:11:44 +0100 | [diff] [blame] | 496 | |
| 497 | /** |
Satish Sampath | f9acde2 | 2009-06-04 11:51:17 +0100 | [diff] [blame] | 498 | * Intent action broadcasted to inform that the searchables list or default have changed. |
| 499 | * Components should handle this intent if they cache any searchable data and wish to stay |
| 500 | * up to date on changes. |
Satish Sampath | f9acde2 | 2009-06-04 11:51:17 +0100 | [diff] [blame] | 501 | */ |
| 502 | public final static String INTENT_ACTION_SEARCHABLES_CHANGED |
| 503 | = "android.search.action.SEARCHABLES_CHANGED"; |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 504 | |
Mike LeBeau | d4fb7a0 | 2009-07-20 17:37:38 -0700 | [diff] [blame] | 505 | /** |
Narayan Kamath | ee69ff4 | 2011-06-28 12:07:18 +0100 | [diff] [blame] | 506 | * Intent action to be broadcast to inform that the global search provider |
Michael Jurka | 3f5cfcf | 2012-04-27 14:20:59 -0700 | [diff] [blame] | 507 | * has changed. |
Narayan Kamath | ee69ff4 | 2011-06-28 12:07:18 +0100 | [diff] [blame] | 508 | */ |
| 509 | public final static String INTENT_GLOBAL_SEARCH_ACTIVITY_CHANGED |
| 510 | = "android.search.action.GLOBAL_SEARCH_ACTIVITY_CHANGED"; |
| 511 | |
| 512 | /** |
Mike LeBeau | d4fb7a0 | 2009-07-20 17:37:38 -0700 | [diff] [blame] | 513 | * Intent action broadcasted to inform that the search settings have changed in some way. |
Karl Rosaen | 590f634 | 2009-08-27 17:42:48 -0700 | [diff] [blame] | 514 | * Either searchables have been enabled or disabled, or a different web search provider |
| 515 | * has been chosen. |
Mike LeBeau | d4fb7a0 | 2009-07-20 17:37:38 -0700 | [diff] [blame] | 516 | */ |
| 517 | public final static String INTENT_ACTION_SEARCH_SETTINGS_CHANGED |
| 518 | = "android.search.action.SETTINGS_CHANGED"; |
Satish Sampath | f9acde2 | 2009-06-04 11:51:17 +0100 | [diff] [blame] | 519 | |
| 520 | /** |
Leon Scroggins | 4f22a54 | 2010-03-09 17:28:13 -0500 | [diff] [blame] | 521 | * This means that context is voice, and therefore the SearchDialog should |
| 522 | * continue showing the microphone until the user indicates that he/she does |
| 523 | * not want to re-speak (e.g. by typing). |
| 524 | * |
| 525 | * @hide |
| 526 | */ |
| 527 | public final static String CONTEXT_IS_VOICE = "android.search.CONTEXT_IS_VOICE"; |
| 528 | |
| 529 | /** |
Leon Scroggins III | 4a02800 | 2010-09-14 10:56:25 -0400 | [diff] [blame] | 530 | * This means that the voice icon should not be shown at all, because the |
| 531 | * current search engine does not support voice search. |
| 532 | * @hide |
| 533 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 534 | @UnsupportedAppUsage |
Leon Scroggins III | 4a02800 | 2010-09-14 10:56:25 -0400 | [diff] [blame] | 535 | public final static String DISABLE_VOICE_SEARCH |
| 536 | = "android.search.DISABLE_VOICE_SEARCH"; |
| 537 | |
| 538 | /** |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 539 | * Reference to the shared system search service. |
| 540 | */ |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 541 | private final ISearchManager mService; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 542 | |
| 543 | private final Context mContext; |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 544 | |
| 545 | // package private since they are used by the inner class SearchManagerCallback |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 546 | /* package */ final Handler mHandler; |
| 547 | /* package */ OnDismissListener mDismissListener = null; |
| 548 | /* package */ OnCancelListener mCancelListener = null; |
| 549 | |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 550 | @UnsupportedAppUsage |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 551 | private SearchDialog mSearchDialog; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 552 | |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 553 | @UnsupportedAppUsage |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 554 | /*package*/ SearchManager(Context context, Handler handler) throws ServiceNotFoundException { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 555 | mContext = context; |
| 556 | mHandler = handler; |
Bjorn Bringert | 8d15382 | 2009-06-22 10:31:44 +0100 | [diff] [blame] | 557 | mService = ISearchManager.Stub.asInterface( |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 558 | ServiceManager.getServiceOrThrow(Context.SEARCH_SERVICE)); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 559 | } |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 560 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 561 | /** |
| 562 | * Launch search UI. |
| 563 | * |
| 564 | * <p>The search manager will open a search widget in an overlapping |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 565 | * window, and the underlying activity may be obscured. The search |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 566 | * entry state will remain in effect until one of the following events: |
| 567 | * <ul> |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 568 | * <li>The user completes the search. In most cases this will launch |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 569 | * a search intent.</li> |
| 570 | * <li>The user uses the back, home, or other keys to exit the search.</li> |
| 571 | * <li>The application calls the {@link #stopSearch} |
| 572 | * method, which will hide the search window and return focus to the |
| 573 | * activity from which it was launched.</li> |
| 574 | * |
| 575 | * <p>Most applications will <i>not</i> use this interface to invoke search. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 576 | * The primary method for invoking search is to call |
| 577 | * {@link android.app.Activity#onSearchRequested Activity.onSearchRequested()} or |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 578 | * {@link android.app.Activity#startSearch Activity.startSearch()}. |
| 579 | * |
| 580 | * @param initialQuery A search string can be pre-entered here, but this |
| 581 | * is typically null or empty. |
| 582 | * @param selectInitialQuery If true, the intial query will be preselected, which means that |
| 583 | * any further typing will replace it. This is useful for cases where an entire pre-formed |
| 584 | * query is being inserted. If false, the selection point will be placed at the end of the |
| 585 | * inserted query. This is useful when the inserted query is text that the user entered, |
| 586 | * and the user would expect to be able to keep typing. <i>This parameter is only meaningful |
| 587 | * if initialQuery is a non-empty string.</i> |
| 588 | * @param launchActivity The ComponentName of the activity that has launched this search. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 589 | * @param appSearchData An application can insert application-specific |
| 590 | * context here, in order to improve quality or specificity of its own |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 591 | * searches. This data will be returned with SEARCH intent(s). Null if |
| 592 | * no extra data is required. |
| 593 | * @param globalSearch If false, this will only launch the search that has been specifically |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 594 | * defined by the application (which is usually defined as a local search). If no default |
Mike LeBeau | cfa419b | 2009-08-17 10:56:02 -0700 | [diff] [blame] | 595 | * search is defined in the current application or activity, global search will be launched. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 596 | * If true, this will always launch a platform-global (e.g. web-based) search instead. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 597 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 598 | * @see android.app.Activity#onSearchRequested |
| 599 | * @see #stopSearch |
| 600 | */ |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 601 | public void startSearch(String initialQuery, |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 602 | boolean selectInitialQuery, |
| 603 | ComponentName launchActivity, |
| 604 | Bundle appSearchData, |
| 605 | boolean globalSearch) { |
Mathew Inwood | 050453e | 2011-10-13 11:00:39 +0100 | [diff] [blame] | 606 | startSearch(initialQuery, selectInitialQuery, launchActivity, |
| 607 | appSearchData, globalSearch, null); |
| 608 | } |
| 609 | |
| 610 | /** |
| 611 | * As {@link #startSearch(String, boolean, ComponentName, Bundle, boolean)} but including |
| 612 | * source bounds for the global search intent. |
| 613 | * |
| 614 | * @hide |
| 615 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 616 | @UnsupportedAppUsage |
Mathew Inwood | 050453e | 2011-10-13 11:00:39 +0100 | [diff] [blame] | 617 | public void startSearch(String initialQuery, |
| 618 | boolean selectInitialQuery, |
| 619 | ComponentName launchActivity, |
| 620 | Bundle appSearchData, |
| 621 | boolean globalSearch, |
| 622 | Rect sourceBounds) { |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 623 | if (globalSearch) { |
Mathew Inwood | 050453e | 2011-10-13 11:00:39 +0100 | [diff] [blame] | 624 | startGlobalSearch(initialQuery, selectInitialQuery, appSearchData, sourceBounds); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 625 | return; |
| 626 | } |
| 627 | |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 628 | final UiModeManager uiModeManager = mContext.getSystemService(UiModeManager.class); |
Tim Kilbourn | 99e9095 | 2014-10-08 17:01:42 -0700 | [diff] [blame] | 629 | // Don't show search dialog on televisions. |
| 630 | if (uiModeManager.getCurrentModeType() != Configuration.UI_MODE_TYPE_TELEVISION) { |
| 631 | ensureSearchDialog(); |
Amith Yamasani | 479ae0a | 2010-02-04 14:52:32 -0800 | [diff] [blame] | 632 | |
Tim Kilbourn | 99e9095 | 2014-10-08 17:01:42 -0700 | [diff] [blame] | 633 | mSearchDialog.show(initialQuery, selectInitialQuery, launchActivity, appSearchData); |
| 634 | } |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 635 | } |
| 636 | |
| 637 | private void ensureSearchDialog() { |
| 638 | if (mSearchDialog == null) { |
| 639 | mSearchDialog = new SearchDialog(mContext, this); |
| 640 | mSearchDialog.setOnCancelListener(this); |
| 641 | mSearchDialog.setOnDismissListener(this); |
krosaen | d2d6014 | 2009-08-17 08:56:48 -0700 | [diff] [blame] | 642 | } |
| 643 | } |
| 644 | |
| 645 | /** |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 646 | * Starts the global search activity. |
| 647 | */ |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 648 | /* package */ void startGlobalSearch(String initialQuery, boolean selectInitialQuery, |
Mathew Inwood | 050453e | 2011-10-13 11:00:39 +0100 | [diff] [blame] | 649 | Bundle appSearchData, Rect sourceBounds) { |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 650 | ComponentName globalSearchActivity = getGlobalSearchActivity(); |
| 651 | if (globalSearchActivity == null) { |
| 652 | Log.w(TAG, "No global search activity found."); |
| 653 | return; |
| 654 | } |
Bjorn Bringert | a94e7af | 2010-01-13 21:09:20 +0000 | [diff] [blame] | 655 | Intent intent = new Intent(INTENT_ACTION_GLOBAL_SEARCH); |
Bjorn Bringert | b8144a9 | 2010-02-22 20:48:57 +0000 | [diff] [blame] | 656 | intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 657 | intent.setComponent(globalSearchActivity); |
Bjorn Bringert | 3c24cb7 | 2010-03-16 12:54:41 +0000 | [diff] [blame] | 658 | // Make sure that we have a Bundle to put source in |
| 659 | if (appSearchData == null) { |
| 660 | appSearchData = new Bundle(); |
| 661 | } else { |
| 662 | appSearchData = new Bundle(appSearchData); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 663 | } |
Bjorn Bringert | 3c24cb7 | 2010-03-16 12:54:41 +0000 | [diff] [blame] | 664 | // Set source to package name of app that starts global search, if not set already. |
| 665 | if (!appSearchData.containsKey("source")) { |
| 666 | appSearchData.putString("source", mContext.getPackageName()); |
| 667 | } |
| 668 | intent.putExtra(APP_DATA, appSearchData); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 669 | if (!TextUtils.isEmpty(initialQuery)) { |
Bjorn Bringert | 55f3ac5 | 2010-01-14 11:38:22 +0000 | [diff] [blame] | 670 | intent.putExtra(QUERY, initialQuery); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 671 | } |
| 672 | if (selectInitialQuery) { |
Bjorn Bringert | 55f3ac5 | 2010-01-14 11:38:22 +0000 | [diff] [blame] | 673 | intent.putExtra(EXTRA_SELECT_QUERY, selectInitialQuery); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 674 | } |
Mathew Inwood | 050453e | 2011-10-13 11:00:39 +0100 | [diff] [blame] | 675 | intent.setSourceBounds(sourceBounds); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 676 | try { |
| 677 | if (DBG) Log.d(TAG, "Starting global search: " + intent.toUri(0)); |
| 678 | mContext.startActivity(intent); |
| 679 | } catch (ActivityNotFoundException ex) { |
| 680 | Log.e(TAG, "Global search activity not found: " + globalSearchActivity); |
| 681 | } |
| 682 | } |
| 683 | |
| 684 | /** |
Narayan Kamath | ee69ff4 | 2011-06-28 12:07:18 +0100 | [diff] [blame] | 685 | * Returns a list of installed apps that handle the global search |
| 686 | * intent. |
| 687 | * |
| 688 | * @hide |
| 689 | */ |
| 690 | public List<ResolveInfo> getGlobalSearchActivities() { |
| 691 | try { |
| 692 | return mService.getGlobalSearchActivities(); |
| 693 | } catch (RemoteException ex) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 694 | throw ex.rethrowFromSystemServer(); |
Narayan Kamath | ee69ff4 | 2011-06-28 12:07:18 +0100 | [diff] [blame] | 695 | } |
| 696 | } |
| 697 | |
| 698 | /** |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 699 | * Gets the name of the global search activity. |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 700 | */ |
Bjorn Bringert | 38015f3 | 2010-01-14 14:56:18 +0000 | [diff] [blame] | 701 | public ComponentName getGlobalSearchActivity() { |
Bjorn Bringert | 6cf7a32 | 2010-02-23 13:17:06 +0000 | [diff] [blame] | 702 | try { |
| 703 | return mService.getGlobalSearchActivity(); |
| 704 | } catch (RemoteException ex) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 705 | throw ex.rethrowFromSystemServer(); |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 706 | } |
Bjorn Bringert | 3c50ef6 | 2009-12-09 12:23:12 +0000 | [diff] [blame] | 707 | } |
| 708 | |
| 709 | /** |
Bjorn Bringert | ea125f4 | 2010-02-18 21:57:59 +0000 | [diff] [blame] | 710 | * Gets the name of the web search activity. |
| 711 | * |
| 712 | * @return The name of the default activity for web searches. This activity |
| 713 | * can be used to get web search suggestions. Returns {@code null} if |
| 714 | * there is no default web search activity. |
| 715 | * |
| 716 | * @hide |
| 717 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 718 | @UnsupportedAppUsage |
Bjorn Bringert | ea125f4 | 2010-02-18 21:57:59 +0000 | [diff] [blame] | 719 | public ComponentName getWebSearchActivity() { |
Bjorn Bringert | 6cf7a32 | 2010-02-23 13:17:06 +0000 | [diff] [blame] | 720 | try { |
| 721 | return mService.getWebSearchActivity(); |
| 722 | } catch (RemoteException ex) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 723 | throw ex.rethrowFromSystemServer(); |
Bjorn Bringert | ea125f4 | 2010-02-18 21:57:59 +0000 | [diff] [blame] | 724 | } |
Bjorn Bringert | ea125f4 | 2010-02-18 21:57:59 +0000 | [diff] [blame] | 725 | } |
| 726 | |
| 727 | /** |
krosaen | d2d6014 | 2009-08-17 08:56:48 -0700 | [diff] [blame] | 728 | * Similar to {@link #startSearch} but actually fires off the search query after invoking |
| 729 | * the search dialog. Made available for testing purposes. |
| 730 | * |
| 731 | * @param query The query to trigger. If empty, request will be ignored. |
| 732 | * @param launchActivity The ComponentName of the activity that has launched this search. |
| 733 | * @param appSearchData An application can insert application-specific |
| 734 | * context here, in order to improve quality or specificity of its own |
| 735 | * searches. This data will be returned with SEARCH intent(s). Null if |
| 736 | * no extra data is required. |
krosaen | d2d6014 | 2009-08-17 08:56:48 -0700 | [diff] [blame] | 737 | * |
| 738 | * @see #startSearch |
| 739 | */ |
| 740 | public void triggerSearch(String query, |
| 741 | ComponentName launchActivity, |
Bjorn Bringert | b782a2f | 2009-10-01 09:57:33 +0100 | [diff] [blame] | 742 | Bundle appSearchData) { |
krosaen | d2d6014 | 2009-08-17 08:56:48 -0700 | [diff] [blame] | 743 | if (query == null || TextUtils.getTrimmedLength(query) == 0) { |
| 744 | Log.w(TAG, "triggerSearch called with empty query, ignoring."); |
| 745 | return; |
| 746 | } |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 747 | startSearch(query, false, launchActivity, appSearchData, false); |
| 748 | mSearchDialog.launchQuerySearch(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 749 | } |
| 750 | |
| 751 | /** |
| 752 | * Terminate search UI. |
| 753 | * |
| 754 | * <p>Typically the user will terminate the search UI by launching a |
| 755 | * search or by canceling. This function allows the underlying application |
| 756 | * or activity to cancel the search prematurely (for any reason). |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 757 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 758 | * <p>This function can be safely called at any time (even if no search is active.) |
| 759 | * |
Leif Hendrik Wilden | 6daeacd | 2018-02-28 15:18:40 -0800 | [diff] [blame] | 760 | * <p>{@link Configuration#UI_MODE_TYPE_TELEVISION} does not support this method. |
| 761 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 762 | * @see #startSearch |
| 763 | */ |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 764 | public void stopSearch() { |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 765 | if (mSearchDialog != null) { |
| 766 | mSearchDialog.cancel(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 767 | } |
| 768 | } |
| 769 | |
| 770 | /** |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 771 | * Determine if the Search UI is currently displayed. |
| 772 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 773 | * This is provided primarily for application test purposes. |
| 774 | * |
| 775 | * @return Returns true if the search UI is currently displayed. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 776 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 777 | * @hide |
| 778 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 779 | @UnsupportedAppUsage |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 780 | public boolean isVisible() { |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 781 | return mSearchDialog == null? false : mSearchDialog.isShowing(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 782 | } |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 783 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 784 | /** |
Karl Rosaen | a058f02 | 2009-06-01 23:11:44 +0100 | [diff] [blame] | 785 | * See {@link SearchManager#setOnDismissListener} for configuring your activity to monitor |
| 786 | * search UI state. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 787 | */ |
| 788 | public interface OnDismissListener { |
| 789 | /** |
Karl Rosaen | a058f02 | 2009-06-01 23:11:44 +0100 | [diff] [blame] | 790 | * This method will be called when the search UI is dismissed. To make use of it, you must |
| 791 | * implement this method in your activity, and call |
| 792 | * {@link SearchManager#setOnDismissListener} to register it. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 793 | */ |
| 794 | public void onDismiss(); |
| 795 | } |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 796 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 797 | /** |
Karl Rosaen | a058f02 | 2009-06-01 23:11:44 +0100 | [diff] [blame] | 798 | * See {@link SearchManager#setOnCancelListener} for configuring your activity to monitor |
| 799 | * search UI state. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 800 | */ |
| 801 | public interface OnCancelListener { |
| 802 | /** |
| 803 | * This method will be called when the search UI is canceled. To make use if it, you must |
Karl Rosaen | a058f02 | 2009-06-01 23:11:44 +0100 | [diff] [blame] | 804 | * implement this method in your activity, and call |
| 805 | * {@link SearchManager#setOnCancelListener} to register it. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 806 | */ |
| 807 | public void onCancel(); |
| 808 | } |
| 809 | |
| 810 | /** |
| 811 | * Set or clear the callback that will be invoked whenever the search UI is dismissed. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 812 | * |
Leif Hendrik Wilden | 6daeacd | 2018-02-28 15:18:40 -0800 | [diff] [blame] | 813 | * <p>{@link Configuration#UI_MODE_TYPE_TELEVISION} does not support this method. |
| 814 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 815 | * @param listener The {@link OnDismissListener} to use, or null. |
| 816 | */ |
| 817 | public void setOnDismissListener(final OnDismissListener listener) { |
| 818 | mDismissListener = listener; |
| 819 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 820 | |
| 821 | /** |
| 822 | * Set or clear the callback that will be invoked whenever the search UI is canceled. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 823 | * |
Leif Hendrik Wilden | 6daeacd | 2018-02-28 15:18:40 -0800 | [diff] [blame] | 824 | * <p>{@link Configuration#UI_MODE_TYPE_TELEVISION} does not support this method. |
| 825 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 826 | * @param listener The {@link OnCancelListener} to use, or null. |
| 827 | */ |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 828 | public void setOnCancelListener(OnCancelListener listener) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 829 | mCancelListener = listener; |
| 830 | } |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 831 | |
Bjorn Bringert | 0e01ea4 | 2009-07-08 22:01:29 +0100 | [diff] [blame] | 832 | /** |
| 833 | * @deprecated This method is an obsolete internal implementation detail. Do not use. |
| 834 | */ |
Dianne Hackborn | 4a51c20 | 2009-08-21 15:14:02 -0700 | [diff] [blame] | 835 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 836 | public void onCancel(DialogInterface dialog) { |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 837 | if (mCancelListener != null) { |
| 838 | mCancelListener.onCancel(); |
| 839 | } |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 840 | } |
Bjorn Bringert | 0e01ea4 | 2009-07-08 22:01:29 +0100 | [diff] [blame] | 841 | |
| 842 | /** |
| 843 | * @deprecated This method is an obsolete internal implementation detail. Do not use. |
| 844 | */ |
Dianne Hackborn | 4a51c20 | 2009-08-21 15:14:02 -0700 | [diff] [blame] | 845 | @Deprecated |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 846 | public void onDismiss(DialogInterface dialog) { |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 847 | if (mDismissListener != null) { |
| 848 | mDismissListener.onDismiss(); |
| 849 | } |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 850 | } |
| 851 | |
| 852 | /** |
Bjorn Bringert | 0408675 | 2010-01-12 15:50:04 +0000 | [diff] [blame] | 853 | * Gets information about a searchable activity. |
| 854 | * |
| 855 | * @param componentName The activity to get searchable information for. |
| 856 | * @return Searchable information, or <code>null</code> if the activity does not |
| 857 | * exist, or is not searchable. |
| 858 | */ |
| 859 | public SearchableInfo getSearchableInfo(ComponentName componentName) { |
| 860 | try { |
Bjorn Bringert | 6cf7a32 | 2010-02-23 13:17:06 +0000 | [diff] [blame] | 861 | return mService.getSearchableInfo(componentName); |
Bjorn Bringert | 8d17f3f | 2009-06-05 13:22:28 +0100 | [diff] [blame] | 862 | } catch (RemoteException ex) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 863 | throw ex.rethrowFromSystemServer(); |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 864 | } |
| 865 | } |
Bjorn Bringert | 8d15382 | 2009-06-22 10:31:44 +0100 | [diff] [blame] | 866 | |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 867 | /** |
Bjorn Bringert | 97325db | 2009-06-22 11:37:03 +0100 | [diff] [blame] | 868 | * Gets a cursor with search suggestions. |
| 869 | * |
| 870 | * @param searchable Information about how to get the suggestions. |
| 871 | * @param query The search text entered (so far). |
| 872 | * @return a cursor with suggestions, or <code>null</null> the suggestion query failed. |
| 873 | * |
| 874 | * @hide because SearchableInfo is not part of the API. |
| 875 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 876 | @UnsupportedAppUsage |
Bjorn Bringert | 97325db | 2009-06-22 11:37:03 +0100 | [diff] [blame] | 877 | public Cursor getSuggestions(SearchableInfo searchable, String query) { |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 878 | return getSuggestions(searchable, query, -1); |
| 879 | } |
| 880 | |
| 881 | /** |
| 882 | * Gets a cursor with search suggestions. |
| 883 | * |
| 884 | * @param searchable Information about how to get the suggestions. |
| 885 | * @param query The search text entered (so far). |
| 886 | * @param limit The query limit to pass to the suggestion provider. This is advisory, |
| 887 | * the returned cursor may contain more rows. Pass {@code -1} for no limit. |
| 888 | * @return a cursor with suggestions, or <code>null</null> the suggestion query failed. |
| 889 | * |
| 890 | * @hide because SearchableInfo is not part of the API. |
| 891 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 892 | @UnsupportedAppUsage |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 893 | public Cursor getSuggestions(SearchableInfo searchable, String query, int limit) { |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 894 | if (searchable == null) { |
| 895 | return null; |
| 896 | } |
| 897 | |
| 898 | String authority = searchable.getSuggestAuthority(); |
| 899 | if (authority == null) { |
| 900 | return null; |
| 901 | } |
| 902 | |
| 903 | Uri.Builder uriBuilder = new Uri.Builder() |
| 904 | .scheme(ContentResolver.SCHEME_CONTENT) |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 905 | .authority(authority) |
| 906 | .query("") // TODO: Remove, workaround for a bug in Uri.writeToParcel() |
| 907 | .fragment(""); // TODO: Remove, workaround for a bug in Uri.writeToParcel() |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 908 | |
| 909 | // if content path provided, insert it now |
| 910 | final String contentPath = searchable.getSuggestPath(); |
| 911 | if (contentPath != null) { |
| 912 | uriBuilder.appendEncodedPath(contentPath); |
| 913 | } |
| 914 | |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 915 | // append standard suggestion query path |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 916 | uriBuilder.appendPath(SearchManager.SUGGEST_URI_PATH_QUERY); |
| 917 | |
| 918 | // get the query selection, may be null |
| 919 | String selection = searchable.getSuggestSelection(); |
| 920 | // inject query, either as selection args or inline |
| 921 | String[] selArgs = null; |
| 922 | if (selection != null) { // use selection if provided |
| 923 | selArgs = new String[] { query }; |
| 924 | } else { // no selection, use REST pattern |
| 925 | uriBuilder.appendPath(query); |
| 926 | } |
| 927 | |
Bjorn Bringert | 3fc7c67 | 2009-09-28 20:11:52 +0100 | [diff] [blame] | 928 | if (limit > 0) { |
| 929 | uriBuilder.appendQueryParameter(SUGGEST_PARAMETER_LIMIT, String.valueOf(limit)); |
| 930 | } |
| 931 | |
| 932 | Uri uri = uriBuilder.build(); |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 933 | |
| 934 | // finally, make the query |
Bjorn Bringert | 8d15382 | 2009-06-22 10:31:44 +0100 | [diff] [blame] | 935 | return mContext.getContentResolver().query(uri, null, selection, selArgs, null); |
Karl Rosaen | 875d50a | 2009-04-23 19:00:21 -0700 | [diff] [blame] | 936 | } |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 937 | |
Bjorn Bringert | 6d72e02 | 2009-04-29 14:56:12 +0100 | [diff] [blame] | 938 | /** |
| 939 | * Returns a list of the searchable activities that can be included in global search. |
Amith Yamasani | e678f46 | 2010-09-15 16:13:43 -0700 | [diff] [blame] | 940 | * |
Bjorn Bringert | 6d72e02 | 2009-04-29 14:56:12 +0100 | [diff] [blame] | 941 | * @return a list containing searchable information for all searchable activities |
Bjorn Bringert | 13107bb | 2009-12-07 10:41:24 +0000 | [diff] [blame] | 942 | * that have the <code>android:includeInGlobalSearch</code> attribute set |
| 943 | * in their searchable meta-data. |
Bjorn Bringert | 6d72e02 | 2009-04-29 14:56:12 +0100 | [diff] [blame] | 944 | */ |
Bjorn Bringert | 8d15382 | 2009-06-22 10:31:44 +0100 | [diff] [blame] | 945 | public List<SearchableInfo> getSearchablesInGlobalSearch() { |
Bjorn Bringert | 6d72e02 | 2009-04-29 14:56:12 +0100 | [diff] [blame] | 946 | try { |
Bjorn Bringert | 8d15382 | 2009-06-22 10:31:44 +0100 | [diff] [blame] | 947 | return mService.getSearchablesInGlobalSearch(); |
Bjorn Bringert | 6d72e02 | 2009-04-29 14:56:12 +0100 | [diff] [blame] | 948 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 949 | throw e.rethrowFromSystemServer(); |
Bjorn Bringert | 6d72e02 | 2009-04-29 14:56:12 +0100 | [diff] [blame] | 950 | } |
| 951 | } |
Satish Sampath | f9acde2 | 2009-06-04 11:51:17 +0100 | [diff] [blame] | 952 | |
Jeff Brown | de7a8ea | 2012-06-13 18:28:57 -0700 | [diff] [blame] | 953 | /** |
Jim Miller | 45308b1 | 2012-06-18 19:23:39 -0700 | [diff] [blame] | 954 | * Gets an intent for launching installed assistant activity, or null if not available. |
Jeff Brown | de7a8ea | 2012-06-13 18:28:57 -0700 | [diff] [blame] | 955 | * @return The assist intent. |
| 956 | * |
| 957 | * @hide |
| 958 | */ |
Jorim Jaggi | 165ce06 | 2015-07-06 16:18:11 -0700 | [diff] [blame] | 959 | public Intent getAssistIntent(boolean inclContext) { |
Amith Yamasani | c1d07a4 | 2012-08-14 09:32:02 -0700 | [diff] [blame] | 960 | try { |
Amith Yamasani | c1d07a4 | 2012-08-14 09:32:02 -0700 | [diff] [blame] | 961 | Intent intent = new Intent(Intent.ACTION_ASSIST); |
Dianne Hackborn | f9c5e0f | 2013-01-23 14:39:13 -0800 | [diff] [blame] | 962 | if (inclContext) { |
Sudheer Shanka | dc589ac | 2016-11-10 15:30:17 -0800 | [diff] [blame] | 963 | IActivityManager am = ActivityManager.getService(); |
Dianne Hackborn | a83ce1d | 2015-03-11 15:16:13 -0700 | [diff] [blame] | 964 | Bundle extras = am.getAssistContextExtras(ActivityManager.ASSIST_CONTEXT_BASIC); |
Dianne Hackborn | f9c5e0f | 2013-01-23 14:39:13 -0800 | [diff] [blame] | 965 | if (extras != null) { |
| 966 | intent.replaceExtras(extras); |
| 967 | } |
| 968 | } |
Jeff Brown | de7a8ea | 2012-06-13 18:28:57 -0700 | [diff] [blame] | 969 | return intent; |
Amith Yamasani | c1d07a4 | 2012-08-14 09:32:02 -0700 | [diff] [blame] | 970 | } catch (RemoteException re) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 971 | throw re.rethrowFromSystemServer(); |
Jeff Brown | de7a8ea | 2012-06-13 18:28:57 -0700 | [diff] [blame] | 972 | } |
Jeff Brown | de7a8ea | 2012-06-13 18:28:57 -0700 | [diff] [blame] | 973 | } |
Dianne Hackborn | fdf5b35 | 2014-10-08 17:43:48 -0700 | [diff] [blame] | 974 | |
| 975 | /** |
Jorim Jaggi | 165ce06 | 2015-07-06 16:18:11 -0700 | [diff] [blame] | 976 | * Starts the assistant. |
| 977 | * |
| 978 | * @param args the args to pass to the assistant |
| 979 | * |
Dianne Hackborn | fdf5b35 | 2014-10-08 17:43:48 -0700 | [diff] [blame] | 980 | * @hide |
| 981 | */ |
Mathew Inwood | 4fb17d1 | 2018-08-14 14:25:44 +0100 | [diff] [blame] | 982 | @UnsupportedAppUsage |
Jorim Jaggi | 165ce06 | 2015-07-06 16:18:11 -0700 | [diff] [blame] | 983 | public void launchAssist(Bundle args) { |
| 984 | try { |
| 985 | if (mService == null) { |
| 986 | return; |
| 987 | } |
| 988 | mService.launchAssist(args); |
| 989 | } catch (RemoteException re) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 990 | throw re.rethrowFromSystemServer(); |
Jorim Jaggi | 165ce06 | 2015-07-06 16:18:11 -0700 | [diff] [blame] | 991 | } |
| 992 | } |
| 993 | |
| 994 | /** |
| 995 | * Starts the legacy assistant (i.e. the {@link Intent#ACTION_ASSIST}). |
| 996 | * |
| 997 | * @param args the args to pass to the assistant |
| 998 | * |
| 999 | * @hide |
| 1000 | */ |
| 1001 | public boolean launchLegacyAssist(String hint, int userHandle, Bundle args) { |
Dianne Hackborn | fdf5b35 | 2014-10-08 17:43:48 -0700 | [diff] [blame] | 1002 | try { |
| 1003 | if (mService == null) { |
| 1004 | return false; |
| 1005 | } |
Jorim Jaggi | 165ce06 | 2015-07-06 16:18:11 -0700 | [diff] [blame] | 1006 | return mService.launchLegacyAssist(hint, userHandle, args); |
Dianne Hackborn | fdf5b35 | 2014-10-08 17:43:48 -0700 | [diff] [blame] | 1007 | } catch (RemoteException re) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 1008 | throw re.rethrowFromSystemServer(); |
Dianne Hackborn | fdf5b35 | 2014-10-08 17:43:48 -0700 | [diff] [blame] | 1009 | } |
| 1010 | } |
Amith Yamasani | e9ce3f0 | 2010-01-25 09:15:50 -0800 | [diff] [blame] | 1011 | } |