Added in API level 8

Summary: Inherited Constants | Fields | Methods | Inherited Methods

SearchableInfo

Kotlin |Java

public final class SearchableInfo
extends Object implements Parcelable

java.lang.Object
↳	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.

See also:

Summary

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<SearchableInfo>`	`CREATOR` Support for parcelable and aidl operations.

Public methods
`boolean`	`autoUrlDetect()` Checks whether this searchable activity has auto URL detection turned on.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`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.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 8

public static final Creator<SearchableInfo> CREATOR

Support for parcelable and aidl operations.

Public methods

autoUrlDetect

Added in API level 8

public boolean autoUrlDetect ()

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

Returns
`boolean`

See also:

R.styleable.Searchable_autoUrlDetect

describeContents

Added in API level 8

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getHintId

Added in API level 8

public int getHintId ()

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

Returns
`int`	A resource id, or `0` if no hint was specified.

See also:

R.styleable.Searchable_hint

getImeOptions

Added in API level 8

public int getImeOptions ()

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).

Returns
`int`	the input type

See also:

R.styleable.Searchable_imeOptions

getInputType

Added in API level 8

public int getInputType ()

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).

Returns
`int`	the input type

See also:

R.styleable.Searchable_inputType

getSearchActivity

Added in API level 8

public ComponentName getSearchActivity ()

Gets the component name of the searchable activity.

Returns
`ComponentName`	A component name, never `null`.

getSettingsDescriptionId

Added in API level 8

public 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.

Returns
`int`

See also:

R.styleable.Searchable_searchSettingsDescription

getSuggestAuthority

Added in API level 8

public String getSuggestAuthority ()

Gets the search suggestion content provider authority.

Returns
`String`	The search suggestions authority, or `null` if not set.

See also:

R.styleable.Searchable_searchSuggestAuthority

getSuggestIntentAction

Added in API level 8

public String getSuggestIntentAction ()

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

Returns
`String`	The default intent action, or `null` if not set.

See also:

R.styleable.Searchable_searchSuggestIntentAction

getSuggestIntentData

Added in API level 8

public String getSuggestIntentData ()

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.

Returns
`String`	The default intent data, or `null` if not set.

See also:

R.styleable.Searchable_searchSuggestIntentData

getSuggestPackage

Added in API level 8

public String getSuggestPackage ()

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

Returns
`String`

getSuggestPath

Added in API level 8

public String getSuggestPath ()

Gets the content provider path for obtaining search suggestions.

Returns
`String`	The suggestion path, or `null` if not set.

See also:

R.styleable.Searchable_searchSuggestPath

getSuggestSelection

Added in API level 8

public String getSuggestSelection ()

Gets the selection for obtaining search suggestions.

Returns
`String`

See also:

R.styleable.Searchable_searchSuggestSelection

getSuggestThreshold

Added in API level 8

public int getSuggestThreshold ()

Gets the suggestion threshold.

Returns
`int`	The suggestion threshold, or `0` if not set.

See also:

R.styleable.Searchable_searchSuggestThreshold

getVoiceLanguageId

Added in API level 8

public int getVoiceLanguageId ()

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

Returns
`int`	A resource id, or `0` if no language was specified.

See also:

R.styleable.Searchable_voiceLanguage

getVoiceLanguageModeId

Added in API level 8

public int getVoiceLanguageModeId ()

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

Returns
`int`	A resource id, or `0` if no language model was specified.

See also:

R.styleable.Searchable_voiceLanguageModel

getVoiceMaxResults

Added in API level 8

public int getVoiceMaxResults ()

The maximum number of voice recognition results to return.

Returns
`int`	the max results count, if specified in the searchable activity's metadata, or `0` if not specified.

See also:

R.styleable.Searchable_voiceMaxResults

getVoicePromptTextId

Added in API level 8

public int getVoicePromptTextId ()

Gets the resource id of the voice prompt text string.

Returns
`int`	A resource id, or `0` if no voice prompt text was specified.

See also:

R.styleable.Searchable_voicePromptText

getVoiceSearchEnabled

Added in API level 8

public boolean getVoiceSearchEnabled ()

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

Returns
`boolean`

See also:

R.styleable.Searchable_voiceSearchMode

getVoiceSearchLaunchRecognizer

Added in API level 8

public boolean getVoiceSearchLaunchRecognizer ()

Checks if voice search should start in-app search.

Returns
`boolean`

See also:

R.styleable.Searchable_voiceSearchMode

getVoiceSearchLaunchWebSearch

Added in API level 8

public boolean getVoiceSearchLaunchWebSearch ()

Checks if voice search should start web search.

Returns
`boolean`

See also:

R.styleable.Searchable_voiceSearchMode

queryAfterZeroResults

Added in API level 8

public boolean queryAfterZeroResults ()

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

Returns
`boolean`

See also:

R.styleable.Searchable_queryAfterZeroResults

shouldIncludeInGlobalSearch

Added in API level 8

public boolean shouldIncludeInGlobalSearch ()

Checks whether the searchable should be included in global search.

Returns
`boolean`	The value of the `R.styleable.Searchable_includeInGlobalSearch` attribute, or `false` if the attribute is not set.

See also:

R.styleable.Searchable_includeInGlobalSearch

shouldRewriteQueryFromData

Added in API level 8

public boolean shouldRewriteQueryFromData ()

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

Returns
`boolean`

See also:

R.styleable.Searchable_searchMode

shouldRewriteQueryFromText

Added in API level 8

public boolean shouldRewriteQueryFromText ()

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

Returns
`boolean`

See also:

R.styleable.Searchable_searchMode

writeToParcel

Added in API level 8

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES