SearchManager

ACTION_KEY

static val ACTION_KEY: String

Intent extra data key: Use this key with Intent.ACTION_SEARCH and content.Intent.getIntExtra() to obtain the keycode that the user used to trigger this query. It will be zero if the user simply pressed the "GO" button on the search UI. This is primarily used in conjunction with the keycode attribute in the actionkey element of your searchable.xml configuration file.

Value: "action_key"

ACTION_MSG

static val ACTION_MSG: String

Intent extra data key: Use this key with Intent.ACTION_SEARCH and content.Intent.getStringExtra() to obtain the action message that was defined for a particular search action key and/or suggestion. It will be null if the search was launched by typing "enter", touching the "GO" button, or other means not involving any action key.

Value: "action_msg"

APP_DATA

static val APP_DATA: String

Intent extra data key: Use this key with Intent.ACTION_SEARCH and content.Intent.getBundleExtra() to obtain any additional app-specific data that was inserted by the activity that launched the search.

Value: "app_data"

CURSOR_EXTRA_KEY_IN_PROGRESS

static val CURSOR_EXTRA_KEY_IN_PROGRESS: String

Boolean extra data key for a suggestion provider to return in Cursor#getExtras to indicate that the search is not complete yet. This can be used by the search UI to indicate that a search is in progress. The suggestion provider can return partial results this way and send a change notification on the cursor when more results are available.

Value: "in_progress"

EXTRA_DATA_KEY

static val EXTRA_DATA_KEY: String

Intent extra data key: This key will be used for the extra populated by the SUGGEST_COLUMN_INTENT_EXTRA_DATA column.

Value: "intent_extra_data_key"

EXTRA_NEW_SEARCH

static val EXTRA_NEW_SEARCH: String

Boolean extra data key for Intent#ACTION_WEB_SEARCH intents. If true, this search should open a new browser window, rather than using an existing one.

Value: "new_search"

EXTRA_SELECT_QUERY

static val EXTRA_SELECT_QUERY: String

Boolean extra data key for INTENT_ACTION_GLOBAL_SEARCH intents. If true, the initial query should be selected when the global search activity is started, so that the user can easily replace it with another query.

Value: "select_query"

EXTRA_WEB_SEARCH_PENDINGINTENT

static val EXTRA_WEB_SEARCH_PENDINGINTENT: String

Extra data key for Intent#ACTION_WEB_SEARCH. If set, the value must be a PendingIntent. The search activity handling the Intent#ACTION_WEB_SEARCH intent will fill in and launch the pending intent. The data URI will be filled in with an http or https URI, and android.provider.Browser#EXTRA_HEADERS may be filled in.

Value: "web_search_pendingintent"

FLAG_QUERY_REFINEMENT

static val FLAG_QUERY_REFINEMENT: Int

Flag to specify that the entry can be used for query refinement, i.e., the query text in the search field can be replaced with the text in this entry, when a query refinement icon is clicked. The suggestion list should show such a clickable icon beside the entry.

Use this flag as a bit-field for SUGGEST_COLUMN_FLAGS.

Value: 1

INTENT_ACTION_GLOBAL_SEARCH

static val INTENT_ACTION_GLOBAL_SEARCH: String

Intent action for starting the global search activity. The global search provider should handle this intent. Supported extra data keys: QUERY, EXTRA_SELECT_QUERY, APP_DATA.

Value: "android.search.action.GLOBAL_SEARCH"

INTENT_ACTION_SEARCHABLES_CHANGED

static val INTENT_ACTION_SEARCHABLES_CHANGED: String

Intent action broadcasted to inform that the searchables list or default have changed. Components should handle this intent if they cache any searchable data and wish to stay up to date on changes.

Value: "android.search.action.SEARCHABLES_CHANGED"

INTENT_ACTION_SEARCH_SETTINGS

static val INTENT_ACTION_SEARCH_SETTINGS: String

Intent action for starting the global search settings activity. The global search provider should handle this intent.

Value: "android.search.action.SEARCH_SETTINGS"

INTENT_ACTION_SEARCH_SETTINGS_CHANGED

static val INTENT_ACTION_SEARCH_SETTINGS_CHANGED: String

Intent action broadcasted to inform that the search settings have changed in some way. Either searchables have been enabled or disabled, or a different web search provider has been chosen.

Value: "android.search.action.SETTINGS_CHANGED"

INTENT_ACTION_WEB_SEARCH_SETTINGS

static val INTENT_ACTION_WEB_SEARCH_SETTINGS: String

Intent action for starting a web search provider's settings activity. Web search providers should handle this intent if they have provider-specific settings to implement.

Value: "android.search.action.WEB_SEARCH_SETTINGS"

INTENT_GLOBAL_SEARCH_ACTIVITY_CHANGED

static val INTENT_GLOBAL_SEARCH_ACTIVITY_CHANGED: String

Intent action to be broadcast to inform that the global search provider has changed.

Value: "android.search.action.GLOBAL_SEARCH_ACTIVITY_CHANGED"

MENU_KEY

static val MENU_KEY: Char

This is a shortcut definition for the default menu key to use for invoking search. See Menu.Item.setAlphabeticShortcut() for more information.

Value: 115

MENU_KEYCODE

static val MENU_KEYCODE: Int

This is a shortcut definition for the default menu key to use for invoking search. See Menu.Item.setAlphabeticShortcut() for more information.

Value: 47

QUERY

static val QUERY: String

Intent extra data key: Use this key with content.Intent.getStringExtra() to obtain the query string from Intent.ACTION_SEARCH.

Value: "query"

SHORTCUT_MIME_TYPE

static val SHORTCUT_MIME_TYPE: String

MIME type for shortcut validation. You'll use this in your suggestions content provider in the getType() function.

Value: "vnd.android.cursor.item/vnd.android.search.suggest"

SUGGEST_COLUMN_AUDIO_CHANNEL_CONFIG

static val SUGGEST_COLUMN_AUDIO_CHANNEL_CONFIG: String

Column name for suggestions cursor. Optional. If your content contains audio, you should provide this column to specify the audio channel configuration. The data in the column is string with format like "channels.subchannels" such as "1.0" or "5.1".

Value: "suggest_audio_channel_config"

SUGGEST_COLUMN_CONTENT_TYPE

static val SUGGEST_COLUMN_CONTENT_TYPE: String

Column name for suggestions cursor. Optional. If your content is media type, you should provide this column so search app could understand more about your content. The data in the column must specify the MIME type of the content.

Value: "suggest_content_type"

SUGGEST_COLUMN_DURATION

static val SUGGEST_COLUMN_DURATION: String

Column name for suggestions cursor. Optional. If your content is video or audio, you should provide this column to specify the duration of your content in milliseconds. The data in the column is of long type.

Value: "suggest_duration"

SUGGEST_COLUMN_FLAGS

static val SUGGEST_COLUMN_FLAGS: String

Column name for suggestions cursor. Optional. This column is used to specify additional flags per item. Multiple flags can be specified.

Must be one of FLAG_QUERY_REFINEMENT or 0 to indicate no flags.

Value: "suggest_flags"

SUGGEST_COLUMN_FORMAT

static val SUGGEST_COLUMN_FORMAT: String

Column name for suggestions cursor. Unused - can be null or column can be omitted.

Value: "suggest_format"

SUGGEST_COLUMN_ICON_1

static val SUGGEST_COLUMN_ICON_1: String

Column name for suggestions cursor. Optional. If your cursor includes this column, then all suggestions will be provided in a format that includes space for two small icons, one at the left and one at the right of each suggestion. The data in the column must be a resource ID of a drawable, or a URI in one of the following formats:

• content (android.content.ContentResolver#SCHEME_CONTENT)
• android.resource (android.content.ContentResolver#SCHEME_ANDROID_RESOURCE)
• file (android.content.ContentResolver#SCHEME_FILE)

Value: "suggest_icon_1"

SUGGEST_COLUMN_ICON_2

static val SUGGEST_COLUMN_ICON_2: String

Column name for suggestions cursor. Optional. If your cursor includes this column, then all suggestions will be provided in a format that includes space for two small icons, one at the left and one at the right of each suggestion. The data in the column must be a resource ID of a drawable, or a URI in one of the following formats:

• content (android.content.ContentResolver#SCHEME_CONTENT)
• android.resource (android.content.ContentResolver#SCHEME_ANDROID_RESOURCE)
• file (android.content.ContentResolver#SCHEME_FILE)

Value: "suggest_icon_2"

SUGGEST_COLUMN_INTENT_ACTION

static val SUGGEST_COLUMN_INTENT_ACTION: String

Column name for suggestions cursor. Optional. If this column exists and this element exists at the given row, this is the action that will be used when forming the suggestion's intent. If the element is not provided, the action will be taken from the android:searchSuggestIntentAction field in your XML metadata. At least one of these must be present for the suggestion to generate an intent. Note: If your action is the same for all suggestions, it is more efficient to specify it using XML metadata and omit it from the cursor.

Value: "suggest_intent_action"

SUGGEST_COLUMN_INTENT_DATA

static val SUGGEST_COLUMN_INTENT_DATA: String

Column name for suggestions cursor. Optional. If this column exists and this element exists at the given row, this is the data that will be used when forming the suggestion's intent. If the element is not provided, the data will be taken from the android:searchSuggestIntentData field in your XML metadata. If neither source is provided, the Intent's data field will be null. Note: If your data is the same for all suggestions, or can be described using a constant part and a specific ID, it is more efficient to specify it using XML metadata and omit it from the cursor.

Value: "suggest_intent_data"

SUGGEST_COLUMN_INTENT_DATA_ID

static val SUGGEST_COLUMN_INTENT_DATA_ID: String

Column name for suggestions cursor. Optional. If this column exists and this element exists at the given row, then "/" and this value will be appended to the data field in the Intent. This should only be used if the data field has already been set to an appropriate base string.

Value: "suggest_intent_data_id"

SUGGEST_COLUMN_INTENT_EXTRA_DATA

static val SUGGEST_COLUMN_INTENT_EXTRA_DATA: String

Column name for suggestions cursor. Optional. If this column exists and this element exists at the given row, this is the data that will be used when forming the suggestion's intent. If not provided, the Intent's extra data field will be null. This column allows suggestions to provide additional arbitrary data which will be included as an extra under the key EXTRA_DATA_KEY.

Value: "suggest_intent_extra_data"

SUGGEST_COLUMN_IS_LIVE

static val SUGGEST_COLUMN_IS_LIVE: String

Column name for suggestions cursor. Optional. If your content is media type, you should provide this column to specify whether your content is live media such as live video or live audio. The value in the column is of integer type with value of either 0 indicating non-live content or 1 indicating live content.

Value: "suggest_is_live"

SUGGEST_COLUMN_LAST_ACCESS_HINT

static val SUGGEST_COLUMN_LAST_ACCESS_HINT: String

Column name for suggestions cursor. Optional. This column may be used to specify the time in System.currentTImeMillis() (wall time in UTC) when an item was last accessed within the results-providing application. If set, this may be used to show more-recently-used items first.

Value: "suggest_last_access_hint"

SUGGEST_COLUMN_PRODUCTION_YEAR

static val SUGGEST_COLUMN_PRODUCTION_YEAR: String

Column name for suggestions cursor. Optional. If your content is video or audio and has a known production year, you should provide this column to specify the production year of your content. The data in the column is of integer type.

Value: "suggest_production_year"

SUGGEST_COLUMN_PURCHASE_PRICE

static val SUGGEST_COLUMN_PURCHASE_PRICE: String

Column name for suggestions cursor. Optional. If your content is purchasable, you should provide this column to specify the displayable string representation of the purchase price of your content including the currency and the amount. If it's free, you should provide localized string to specify that it's free. This column can be omitted if the content is not applicable to purchase.

Value: "suggest_purchase_price"

SUGGEST_COLUMN_QUERY

static val SUGGEST_COLUMN_QUERY: String

Column name for suggestions cursor. Required if action is ACTION_SEARCH, optional otherwise. If this column exists and this element exists at the given row, this is the data that will be used when forming the suggestion's query.

Value: "suggest_intent_query"

SUGGEST_COLUMN_RATING_SCORE

static val SUGGEST_COLUMN_RATING_SCORE: String

Column name for suggestions cursor. Optional. If your content has a rating, you should provide this column to specify the rating score of your content. The data in the column is of float type. See android.media.Rating about valid rating scores for each rating style.

Value: "suggest_rating_score"

SUGGEST_COLUMN_RATING_STYLE

static val SUGGEST_COLUMN_RATING_STYLE: String

Column name for suggestions cursor. Optional. If your content has a rating, you should provide this column to specify the rating style of your content. The data in the column must be one of the constant values specified in android.media.Rating

Value: "suggest_rating_style"

SUGGEST_COLUMN_RENTAL_PRICE

static val SUGGEST_COLUMN_RENTAL_PRICE: String

Column name for suggestions cursor. Optional. If your content is rentable, you should provide this column to specify the displayable string representation of the rental price of your content including the currency and the amount. If it's free, you should provide localized string to specify that it's free. This column can be omitted if the content is not applicable to rent.

Value: "suggest_rental_price"

SUGGEST_COLUMN_RESULT_CARD_IMAGE

static val SUGGEST_COLUMN_RESULT_CARD_IMAGE: String

Column name for suggestions cursor. Optional. If your cursor includes this column, then the image will be displayed when forming the suggestion. The suggested dimension for the image is 270x400 px for portrait mode and 400x225 px for landscape mode. The data in the column must be a resource ID of a drawable, or a URI in one of the following formats:

• content (android.content.ContentResolver#SCHEME_CONTENT)
• android.resource (android.content.ContentResolver#SCHEME_ANDROID_RESOURCE)
• file (android.content.ContentResolver#SCHEME_FILE)

Value: "suggest_result_card_image"

SUGGEST_COLUMN_SHORTCUT_ID

static val SUGGEST_COLUMN_SHORTCUT_ID: String

Column name for suggestions cursor. Optional. This column is used to indicate whether a search suggestion should be stored as a shortcut, and whether it should be refreshed. If missing, the result will be stored as a shortcut and never validated. If set to SUGGEST_NEVER_MAKE_SHORTCUT, the result will not be stored as a shortcut. Otherwise, the shortcut id will be used to check back for an up to date suggestion using SUGGEST_URI_PATH_SHORTCUT.

Value: "suggest_shortcut_id"

SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING

static val SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING: String

Column name for suggestions cursor. Optional. This column is used to specify that a spinner should be shown in lieu of an icon2 while the shortcut of this suggestion is being refreshed.

Value: "suggest_spinner_while_refreshing"

SUGGEST_COLUMN_TEXT_1

static val SUGGEST_COLUMN_TEXT_1: String

Column name for suggestions cursor. Required. This is the primary line of text that will be presented to the user as the suggestion.

Value: "suggest_text_1"

SUGGEST_COLUMN_TEXT_2

static val SUGGEST_COLUMN_TEXT_2: String

Column name for suggestions cursor. Optional. If your cursor includes this column, then all suggestions will be provided in a two-line format. The second line of text is in a much smaller appearance.

Value: "suggest_text_2"

SUGGEST_COLUMN_TEXT_2_URL

static val SUGGEST_COLUMN_TEXT_2_URL: String

Column name for suggestions cursor. Optional. This is a URL that will be shown as the second line of text instead of SUGGEST_COLUMN_TEXT_2. This is a separate column so that the search UI knows to display the text as a URL, e.g. by using a different color. If this column is absent, or has the value null, SUGGEST_COLUMN_TEXT_2 will be used instead.

Value: "suggest_text_2_url"

SUGGEST_COLUMN_VIDEO_HEIGHT

static val SUGGEST_COLUMN_VIDEO_HEIGHT: String

Column name for suggestions cursor. Optional. If your content is video, you should provide this column to specify the number of horizontal lines. The data in the column is of integer type.

Value: "suggest_video_height"

SUGGEST_COLUMN_VIDEO_WIDTH

static val SUGGEST_COLUMN_VIDEO_WIDTH: String

Column name for suggestions cursor. Optional. If your content is video, you should provide this column to specify the number of vertical lines. The data in the column is of integer type.

Value: "suggest_video_width"

SUGGEST_MIME_TYPE

static val SUGGEST_MIME_TYPE: String

MIME type for suggestions data. You'll use this in your suggestions content provider in the getType() function.

Value: "vnd.android.cursor.dir/vnd.android.search.suggest"

SUGGEST_NEVER_MAKE_SHORTCUT

static val SUGGEST_NEVER_MAKE_SHORTCUT: String

Column value for suggestion column SUGGEST_COLUMN_SHORTCUT_ID when a suggestion should not be stored as a shortcut in global search.

Value: "_-1"

SUGGEST_PARAMETER_LIMIT

static val SUGGEST_PARAMETER_LIMIT: String

Query parameter added to suggestion queries to limit the number of suggestions returned. This limit is only advisory and suggestion providers may chose to ignore it.

Value: "limit"

SUGGEST_URI_PATH_QUERY

static val SUGGEST_URI_PATH_QUERY: String

Uri path for queried suggestions data. This is the path that the search manager will use when querying your content provider for suggestions data based on user input (e.g. looking for partial matches). Typically you'll use this with a URI matcher.

Value: "search_suggest_query"

SUGGEST_URI_PATH_SHORTCUT

static val SUGGEST_URI_PATH_SHORTCUT: String

Uri path for shortcut validation. This is the path that the search manager will use when querying your content provider to refresh a shortcutted suggestion result and to check if it is still valid. When asked, a source may return an up to date result, or no result. No result indicates the shortcut refers to a no longer valid sugggestion.

Value: "search_suggest_shortcut"

USER_QUERY

static val USER_QUERY: String

Intent extra data key: Use this key with content.Intent.getStringExtra() to obtain the query string typed in by the user. This may be different from the value of QUERY if the intent is the result of selecting a suggestion. In that case, QUERY will contain the value of SUGGEST_COLUMN_QUERY for the suggestion, and USER_QUERY will contain the string typed by the user.

Value: "user_query"

getGlobalSearchActivity

open fun getGlobalSearchActivity(): ComponentName!

Gets the name of the global search activity.

getSearchableInfo

open fun getSearchableInfo(componentName: ComponentName!): SearchableInfo!

Gets information about a searchable activity.

getSearchablesInGlobalSearch

open fun getSearchablesInGlobalSearch(): MutableList<SearchableInfo!>!

Returns a list of the searchable activities that can be included in global search.

onCancel

open fun onCancel(dialog: DialogInterface!): Unit

Deprecated: This method is an obsolete internal implementation detail. Do not use.

onDismiss

open fun onDismiss(dialog: DialogInterface!): Unit

Deprecated: This method is an obsolete internal implementation detail. Do not use.

setOnCancelListener

open fun setOnCancelListener(listener: SearchManager.OnCancelListener!): Unit

Set or clear the callback that will be invoked whenever the search UI is canceled.

Configuration#UI_MODE_TYPE_TELEVISION does not support this method.

setOnDismissListener

open fun setOnDismissListener(listener: SearchManager.OnDismissListener!): Unit

Set or clear the callback that will be invoked whenever the search UI is dismissed.

Configuration#UI_MODE_TYPE_TELEVISION does not support this method.

startSearch

open fun startSearch(
    initialQuery: String!, 
    selectInitialQuery: Boolean, 
    launchActivity: ComponentName!, 
    appSearchData: Bundle!, 
    globalSearch: Boolean
): Unit

Launch search UI.

The search manager will open a search widget in an overlapping window, and the underlying activity may be obscured. The search entry state will remain in effect until one of the following events:

• The user completes the search. In most cases this will launch a search intent.
• The user uses the back, home, or other keys to exit the search.
• The application calls the stopSearch method, which will hide the search window and return focus to the activity from which it was launched.

Most applications will not use this interface to invoke search. The primary method for invoking search is to call android.app.Activity#onSearchRequested or Activity.startSearch().

stopSearch

open fun stopSearch(): Unit

Terminate search UI.

Typically the user will terminate the search UI by launching a search or by canceling. This function allows the underlying application or activity to cancel the search prematurely (for any reason).

This function can be safely called at any time (even if no search is active.)

Configuration#UI_MODE_TYPE_TELEVISION does not support this method.

triggerSearch

open fun triggerSearch(
    query: String!, 
    launchActivity: ComponentName!, 
    appSearchData: Bundle!
): Unit

Similar to startSearch but actually fires off the search query after invoking the search dialog. Made available for testing purposes.