# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Inherited Constants | Fields | Methods | Inherited Methods

# SearchableInfo

`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:

- `SearchManager.getSearchableInfo(ComponentName)`
- `SearchManager.getSearchablesInGlobalSearch()`

## 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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
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

    public static final Creator<SearchableInfo> CREATOR

Support for parcelable and aidl operations.

## Public methods

### autoUrlDetect

    public boolean autoUrlDetect ()

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

Returns
`boolean` |

See also:

- `R.styleable.Searchable_autoUrlDetect`

### describeContents

    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

    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

    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

    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

    public ComponentName getSearchActivity ()

Gets the component name of the searchable activity.

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

### getSettingsDescriptionId

    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

    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

    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

    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

    public String getSuggestPackage ()

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

Returns
`String` |

### getSuggestPath

    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

    public String getSuggestSelection ()

Gets the selection for obtaining search suggestions.

Returns
`String` |

See also:

- `R.styleable.Searchable_searchSuggestSelection`

### getSuggestThreshold

    public int getSuggestThreshold ()

Gets the suggestion threshold.

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

See also:

- `R.styleable.Searchable_searchSuggestThreshold`

### getVoiceLanguageId

    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

    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

    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

    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

    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

    public boolean getVoiceSearchLaunchRecognizer ()

Checks if voice search should start in-app search.

Returns
`boolean` |

See also:

- `R.styleable.Searchable_voiceSearchMode`

### getVoiceSearchLaunchWebSearch

    public boolean getVoiceSearchLaunchWebSearch ()

Checks if voice search should start web search.

Returns
`boolean` |

See also:

- `R.styleable.Searchable_voiceSearchMode`

### queryAfterZeroResults

    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

    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

    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

    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

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

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*