Added in API level 8

SearchableInfo

---

Kotlin |Java

class SearchableInfo : Parcelable

kotlin.Any
↳	android.app.SearchableInfo

Searchability meta-data for an activity. Only applications that search other applications should need to use this class. See Searchable Configuration for more information about declaring searchability meta-data for your application.

Summary

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Boolean	autoUrlDetect() Checks whether this searchable activity has auto URL detection turned on.
Int	describeContents()
Int	getHintId() Gets the resource id of the hint text.
Int	getImeOptions() Gets the input method options specified in the searchable attributes.
Int	getInputType() Gets the input type as specified in the searchable attributes.
ComponentName!	getSearchActivity() Gets the component name of the searchable activity.
Int	getSettingsDescriptionId() Gets the resource id of the description string to use for this source in system search settings, or 0 if none has been specified.
String!	getSuggestAuthority() Gets the search suggestion content provider authority.
String!	getSuggestIntentAction() Gets the optional intent action for use with these suggestions.
String!	getSuggestIntentData() Gets the optional intent data for use with these suggestions.
String!	getSuggestPackage() Gets the name of the package where the suggestion provider lives, or null.
String!	getSuggestPath() Gets the content provider path for obtaining search suggestions.
String!	getSuggestSelection() Gets the selection for obtaining search suggestions.
Int	getSuggestThreshold() Gets the suggestion threshold.
Int	getVoiceLanguageId() Gets the resource id of the spoken language to recognize in voice search.
Int	getVoiceLanguageModeId() Gets the resource id of the voice search language model string.
Int	getVoiceMaxResults() The maximum number of voice recognition results to return.
Int	getVoicePromptTextId() Gets the resource id of the voice prompt text string.
Boolean	getVoiceSearchEnabled() Checks if the searchable activity wants the voice search button to be shown.
Boolean	getVoiceSearchLaunchRecognizer() Checks if voice search should start in-app search.
Boolean	getVoiceSearchLaunchWebSearch() Checks if voice search should start web search.
Boolean	queryAfterZeroResults() Checks whether this searchable activity should be queried for suggestions if a prefix of the query has returned no results.
Boolean	shouldIncludeInGlobalSearch() Checks whether the searchable should be included in global search.
Boolean	shouldRewriteQueryFromData() Checks whether the text in the query field should come from the suggestion intent data.
Boolean	shouldRewriteQueryFromText() Checks whether the text in the query field should come from the suggestion title.
Unit	writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<SearchableInfo!>	CREATOR Support for parcelable and aidl operations.

Public methods

autoUrlDetect

Added in API level 8

fun autoUrlDetect(): Boolean

Checks whether this searchable activity has auto URL detection turned on.

See Also

• android.R.styleable#Searchable_autoUrlDetect

describeContents

Added in API level 8

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getHintId

Added in API level 8

fun getHintId(): Int

Gets the resource id of the hint text. This must be read using the searchable Activity's resources.

Return
Int	A resource id, or 0 if no hint was specified.

See Also

• android.R.styleable#Searchable_hint

getImeOptions

Added in API level 8

fun getImeOptions(): Int

Gets the input method options specified in the searchable attributes. This will default to EditorInfo#IME_ACTION_GO if not specified (which is appropriate for a search box).

Return
Int	the input type

See Also

• android.R.styleable#Searchable_imeOptions

getInputType

Added in API level 8

fun getInputType(): Int

Gets the input type as specified in the searchable attributes. This will default to InputType#TYPE_CLASS_TEXT if not specified (which is appropriate for free text input).

Return
Int	the input type

See Also

• android.R.styleable#Searchable_inputType

getSearchActivity

Added in API level 8

fun getSearchActivity(): ComponentName!

Gets the component name of the searchable activity.

Return
ComponentName!	A component name, never null.

getSettingsDescriptionId

Added in API level 8

fun getSettingsDescriptionId(): Int

Gets the resource id of the description string to use for this source in system search settings, or 0 if none has been specified.

See Also

• android.R.styleable#Searchable_searchSettingsDescription

getSuggestAuthority

Added in API level 8

fun getSuggestAuthority(): String!

Gets the search suggestion content provider authority.

Return
String!	The search suggestions authority, or null if not set.

See Also

• android.R.styleable#Searchable_searchSuggestAuthority

getSuggestIntentAction

Added in API level 8

fun getSuggestIntentAction(): String!

Gets the optional intent action for use with these suggestions. This is useful if all intents will have the same action (e.g. android.content.Intent#ACTION_VIEW) This can be overriden in any given suggestion using the column SearchManager#SUGGEST_COLUMN_INTENT_ACTION.

Return
String!	The default intent action, or null if not set.

See Also

• android.R.styleable#Searchable_searchSuggestIntentAction

getSuggestIntentData

Added in API level 8

fun getSuggestIntentData(): String!

Gets the optional intent data for use with these suggestions. This is useful if all intents will have similar data URIs, but you'll likely need to provide a specific ID as well via the column SearchManager#SUGGEST_COLUMN_INTENT_DATA_ID, which will be appended to the intent data URI. This can be overriden in any given suggestion using the column SearchManager#SUGGEST_COLUMN_INTENT_DATA.

Return
String!	The default intent data, or null if not set.

See Also

• android.R.styleable#Searchable_searchSuggestIntentData

getSuggestPackage

Added in API level 8

fun getSuggestPackage(): String!

Gets the name of the package where the suggestion provider lives, or null.

getSuggestPath

Added in API level 8

fun getSuggestPath(): String!

Gets the content provider path for obtaining search suggestions.

Return
String!	The suggestion path, or null if not set.

See Also

• android.R.styleable#Searchable_searchSuggestPath

getSuggestSelection

Added in API level 8

fun getSuggestSelection(): String!

Gets the selection for obtaining search suggestions.

See Also

• android.R.styleable#Searchable_searchSuggestSelection

getSuggestThreshold

Added in API level 8

fun getSuggestThreshold(): Int

Gets the suggestion threshold.

Return
Int	The suggestion threshold, or 0 if not set.

See Also

• android.R.styleable#Searchable_searchSuggestThreshold

getVoiceLanguageId

Added in API level 8

fun getVoiceLanguageId(): Int

Gets the resource id of the spoken language to recognize in voice search.

Return
Int	A resource id, or 0 if no language was specified.

See Also

• android.R.styleable#Searchable_voiceLanguage

getVoiceLanguageModeId

Added in API level 8

fun getVoiceLanguageModeId(): Int

Gets the resource id of the voice search language model string.

Return
Int	A resource id, or 0 if no language model was specified.

See Also

• android.R.styleable#Searchable_voiceLanguageModel

getVoiceMaxResults

Added in API level 8

fun getVoiceMaxResults(): Int

The maximum number of voice recognition results to return.

Return
Int	the max results count, if specified in the searchable activity's metadata, or 0 if not specified.

See Also

• android.R.styleable#Searchable_voiceMaxResults

getVoicePromptTextId

Added in API level 8

fun getVoicePromptTextId(): Int

Gets the resource id of the voice prompt text string.

Return
Int	A resource id, or 0 if no voice prompt text was specified.

See Also

• android.R.styleable#Searchable_voicePromptText

getVoiceSearchEnabled

Added in API level 8

fun getVoiceSearchEnabled(): Boolean

Checks if the searchable activity wants the voice search button to be shown.

See Also

• android.R.styleable#Searchable_voiceSearchMode

getVoiceSearchLaunchRecognizer

Added in API level 8

fun getVoiceSearchLaunchRecognizer(): Boolean

Checks if voice search should start in-app search.

See Also

• android.R.styleable#Searchable_voiceSearchMode

getVoiceSearchLaunchWebSearch

Added in API level 8

fun getVoiceSearchLaunchWebSearch(): Boolean

Checks if voice search should start web search.

See Also

• android.R.styleable#Searchable_voiceSearchMode

queryAfterZeroResults

Added in API level 8

fun queryAfterZeroResults(): Boolean

Checks whether this searchable activity should be queried for suggestions if a prefix of the query has returned no results.

See Also

• android.R.styleable#Searchable_queryAfterZeroResults

shouldIncludeInGlobalSearch

Added in API level 8

fun shouldIncludeInGlobalSearch(): Boolean

Checks whether the searchable should be included in global search.

Return
Boolean	The value of the android.R.styleable#Searchable_includeInGlobalSearch attribute, or false if the attribute is not set.

See Also

• android.R.styleable#Searchable_includeInGlobalSearch

shouldRewriteQueryFromData

Added in API level 8

fun shouldRewriteQueryFromData(): Boolean

Checks whether the text in the query field should come from the suggestion intent data.

See Also

• android.R.styleable#Searchable_searchMode

shouldRewriteQueryFromText

Added in API level 8

fun shouldRewriteQueryFromText(): Boolean

Checks whether the text in the query field should come from the suggestion title.

See Also

• android.R.styleable#Searchable_searchMode

writeToParcel

Added in API level 8

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Parameters
dest	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 8

static val CREATOR: Parcelable.Creator<SearchableInfo!>

Support for parcelable and aidl operations.