IT. Expert System.

All Implemented Interfaces:

Parcelable

public final class SearchableInfo
extends Object
implements Parcelable

See Also:

SearchManager.getSearchableInfo(ComponentName), SearchManager.getSearchablesInGlobalSearch()

• Nested Class Summary

  Nested Classes

  Modifier and Type	Class and Description
  static class	SearchableInfo.ActionKeyInfo Information about an action key in searchability meta-data.

  • Nested classes/interfaces inherited from interface android.os.Parcelable

    Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static Parcelable.Creator<SearchableInfo>	CREATOR Support for parcelable and aidl operations.

  • Fields inherited from interface android.os.Parcelable

    CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

• Method Summary

  Methods

  Modifier and Type	Method and Description
  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's marshalled representation.
  SearchableInfo.ActionKeyInfo	findActionKey(int keyCode) If any action keys were defined for this searchable activity, look up and return.
  Context	getActivityContext(Context context) Get the context for the searchable activity.
  static SearchableInfo	getActivityMetaData(Context context, ActivityInfo activityInfo, int userId) Gets search information for the given activity.
  int	getHintId() Gets the resource id of the hint text.
  int	getIconId() Gets the icon id specified by the Searchable_icon meta-data entry.
  int	getImeOptions() Gets the input method options specified in the searchable attributes.
  int	getInputType() Gets the input type as specified in the searchable attributes.
  int	getLabelId() Gets the "label" (user-visible name) of this searchable context.
  Context	getProviderContext(Context context, Context activityContext) Get the context for the suggestions provider.
  ComponentName	getSearchActivity() Gets the component name of the searchable activity.
  int	getSearchButtonText() Gets the resource id of replacement text for the "Search" button.
  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.
  boolean	useBadgeIcon() Checks whether the badge should be an icon.
  boolean	useBadgeLabel() Checks whether the badge should be a text label.
  void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Field Detail

  • CREATOR

    public static final Parcelable.Creator<SearchableInfo> CREATOR

    Support for parcelable and aidl operations.

• Method Detail

  • getSuggestAuthority

    public String getSuggestAuthority()

    Gets the search suggestion content provider authority.

    Returns:

    The search suggestions authority, or null if not set.

    See Also:

    android.R.styleable#Searchable_searchSuggestAuthority

  • getSuggestPackage

    public String getSuggestPackage()

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

  • getSearchActivity

    public ComponentName getSearchActivity()

    Gets the component name of the searchable activity.

    Returns:

    A component name, never null.

  • useBadgeLabel

    public boolean useBadgeLabel()

    Checks whether the badge should be a text label.

    See Also:

    android.R.styleable#Searchable_searchMode

  • useBadgeIcon

    public boolean useBadgeIcon()

    Checks whether the badge should be an icon.

    See Also:

    android.R.styleable#Searchable_searchMode

  • shouldRewriteQueryFromData

    public boolean shouldRewriteQueryFromData()

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

    See Also:

    android.R.styleable#Searchable_searchMode

  • shouldRewriteQueryFromText

    public boolean shouldRewriteQueryFromText()

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

    See Also:

    android.R.styleable#Searchable_searchMode

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

    See Also:

    android.R.styleable#Searchable_searchSettingsDescription

  • getSuggestPath

    public String getSuggestPath()

    Gets the content provider path for obtaining search suggestions.

    Returns:

    The suggestion path, or null if not set.

    See Also:

    android.R.styleable#Searchable_searchSuggestPath

  • getSuggestSelection

    public String getSuggestSelection()

    Gets the selection for obtaining search suggestions.

    See Also:

    android.R.styleable#Searchable_searchSuggestSelection

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

    The default intent action, or null if not set.

    See Also:

    android.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:

    The default intent data, or null if not set.

    See Also:

    android.R.styleable#Searchable_searchSuggestIntentData

  • getSuggestThreshold

    public int getSuggestThreshold()

    Gets the suggestion threshold.

    Returns:

    The suggestion threshold, or 0 if not set.

    See Also:

    android.R.styleable#Searchable_searchSuggestThreshold

  • getActivityContext

    public Context getActivityContext(Context context)

    Get the context for the searchable activity.

    Parameters:

    context - You need to supply a context to start with

    Returns:

    Returns a context related to the searchable activity

  • getProviderContext

    public Context getProviderContext(Context context,
                             Context activityContext)

    Get the context for the suggestions provider.

    Parameters:

    context - You need to supply a context to start with

    activityContext - If we can determine that the provider and the activity are the same, we'll just return this one.

    Returns:

    Returns a context related to the suggestion provider

  • findActionKey

    public SearchableInfo.ActionKeyInfo findActionKey(int keyCode)

    If any action keys were defined for this searchable activity, look up and return.

    Parameters:

    keyCode - The key that was pressed

    Returns:

    Returns the action key info, or null if none defined.

  • getActivityMetaData

    public static SearchableInfo getActivityMetaData(Context context,
                                     ActivityInfo activityInfo,
                                     int userId)

    Gets search information for the given activity.

    Parameters:

    context - Context to use for reading activity resources.

    activityInfo - Activity to get search information from.

    Returns:

    Search information about the given activity, or null if the activity has no or invalid searchability meta-data.

  • getLabelId

    public int getLabelId()

    Gets the "label" (user-visible name) of this searchable context. This must be read using the searchable Activity's resources.

    Returns:

    A resource id, or 0 if no label was specified.

    See Also:

    android.R.styleable#Searchable_label

  • getHintId

    public int getHintId()

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

    Returns:

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

    See Also:

    android.R.styleable#Searchable_hint

  • getIconId

    public int getIconId()

    Gets the icon id specified by the Searchable_icon meta-data entry. This must be read using the searchable Activity's resources.

    Returns:

    A resource id, or 0 if no icon was specified.

    See Also:

    android.R.styleable#Searchable_icon

  • getVoiceSearchEnabled

    public boolean getVoiceSearchEnabled()

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

    See Also:

    android.R.styleable#Searchable_voiceSearchMode

  • getVoiceSearchLaunchWebSearch

    public boolean getVoiceSearchLaunchWebSearch()

    Checks if voice search should start web search.

    See Also:

    android.R.styleable#Searchable_voiceSearchMode

  • getVoiceSearchLaunchRecognizer

    public boolean getVoiceSearchLaunchRecognizer()

    Checks if voice search should start in-app search.

    See Also:

    android.R.styleable#Searchable_voiceSearchMode

  • getVoiceLanguageModeId

    public int getVoiceLanguageModeId()

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

    Returns:

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

    See Also:

    android.R.styleable#Searchable_voiceLanguageModel

  • getVoicePromptTextId

    public int getVoicePromptTextId()

    Gets the resource id of the voice prompt text string.

    Returns:

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

    See Also:

    android.R.styleable#Searchable_voicePromptText

  • getVoiceLanguageId

    public int getVoiceLanguageId()

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

    Returns:

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

    See Also:

    android.R.styleable#Searchable_voiceLanguage

  • getVoiceMaxResults

    public int getVoiceMaxResults()

    The maximum number of voice recognition results to return.

    Returns:

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

    See Also:

    android.R.styleable#Searchable_voiceMaxResults

  • getSearchButtonText

    public int getSearchButtonText()

    Gets the resource id of replacement text for the "Search" button.

    Returns:

    A resource id, or 0 if no replacement text was specified.

    See Also:

    android.R.styleable#Searchable_searchButtonText

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

    the input type

    See Also:

    android.R.styleable#Searchable_inputType

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

    the input type

    See Also:

    android.R.styleable#Searchable_imeOptions

  • shouldIncludeInGlobalSearch

    public boolean shouldIncludeInGlobalSearch()

    Checks whether the searchable should be included in global search.

    Returns:

    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

  • queryAfterZeroResults

    public boolean queryAfterZeroResults()

    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

  • autoUrlDetect

    public boolean autoUrlDetect()

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

    See Also:

    android.R.styleable#Searchable_autoUrlDetect

  • describeContents

    public int describeContents()

    Description copied from interface: Parcelable
    Describe the kinds of special objects contained in this Parcelable's marshalled representation.

    Specified by:

    describeContents in interface Parcelable

    Returns:

    a bitmask indicating the set of special object types marshalled by the Parcelable.

  • writeToParcel

    public void writeToParcel(Parcel dest,
                     int flags)

    Description copied from interface: Parcelable
    Flatten this object in to a Parcel.

    Specified by:

    writeToParcel in interface Parcelable

    Parameters:

    dest - The Parcel in which the object should be written.

    flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.