SearchManager Class

Definition

Namespace:: Android.App

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This class provides access to the system search services.

[Android.Runtime.Register("android/app/SearchManager", DoNotGenerateAcw=true)]
public class SearchManager : Java.Lang.Object, Android.Content.IDialogInterfaceOnCancelListener, Android.Content.IDialogInterfaceOnDismissListener, IDisposable

[<Android.Runtime.Register("android/app/SearchManager", DoNotGenerateAcw=true)>]
type SearchManager = class
    inherit Object
    interface IDialogInterfaceOnCancelListener
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface IDialogInterfaceOnDismissListener

Inheritance: Object

JavaObject

Object
SearchManager

Attributes: RegisterAttribute

Implements: IDialogInterfaceOnCancelListener IDialogInterfaceOnDismissListener IJavaObject IJavaPeerable IDisposable

Remarks

This class provides access to the system search services. In practice, you won't interact with this class directly, as search services are provided through methods in Activity and the ACTION_SEARCH Intent. Configuration.UI_MODE_TYPE_WATCH does not support this system service. Developer Guides For more information about using the search dialog and adding search suggestions in your application, read the Search developer guide.

Android reference for android.app.SearchManager.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Name	Description
SearchManager(IntPtr, JniHandleOwnership)	Initializes a managed representation of an existing Java Native Interface object.

Fields

Name	Description
ActionKey	Intent extra data key: Use this key with Intent.
ActionMsg	Intent extra data key: Use this key with Intent.
AppData	Intent extra data key: Use this key with Intent.
CursorExtraKeyInProgress	Boolean extra data key for a suggestion provider to return in `Cursor#getExtras` to indicate that the search is not complete yet.
ExtraDataKey	Intent extra data key: This key will be used for the extra populated by the `#SUGGEST_COLUMN_INTENT_EXTRA_DATA` column.
ExtraNewSearch	Boolean extra data key for `Intent#ACTION_WEB_SEARCH` intents.
ExtraSelectQuery	Boolean extra data key for `#INTENT_ACTION_GLOBAL_SEARCH` intents.
ExtraWebSearchPendingintent	Extra data key for `Intent#ACTION_WEB_SEARCH`.
FlagQueryRefinement	Flag to specify that the entry can be used for query refinement, i.
IntentActionGlobalSearch	Intent action for starting the global search activity.
IntentActionSearchablesChanged	Intent action broadcasted to inform that the searchables list or default have changed.
IntentActionSearchSettings	Intent action for starting the global search settings activity.
IntentActionSearchSettingsChanged	Intent action broadcasted to inform that the search settings have changed in some way.
IntentActionWebSearchSettings	Intent action for starting a web search provider's settings activity.
IntentGlobalSearchActivityChanged	Intent action to be broadcast to inform that the global search provider has changed.
MenuKey	This is a shortcut definition for the default menu key to use for invoking search.
MenuKeycode	This is a shortcut definition for the default menu key to use for invoking search.
Query	Intent extra data key: Use this key with `android.content.Intent#getStringExtra content.Intent.getStringExtra()` to obtain the query string from Intent.
ShortcutMimeType	MIME type for shortcut validation.
SuggestColumnAudioChannelConfig	Column name for suggestions cursor.
SuggestColumnContentType	Column name for suggestions cursor.
SuggestColumnDuration	Column name for suggestions cursor.
SuggestColumnFlags	Column name for suggestions cursor.
SuggestColumnFormat	Column name for suggestions cursor.
SuggestColumnIcon1	Column name for suggestions cursor.
SuggestColumnIcon2	Column name for suggestions cursor.
SuggestColumnIntentAction	Column name for suggestions cursor.
SuggestColumnIntentData	Column name for suggestions cursor.
SuggestColumnIntentDataId	Column name for suggestions cursor.
SuggestColumnIntentExtraData	Column name for suggestions cursor.
SuggestColumnIsLive	Column name for suggestions cursor.
SuggestColumnLastAccessHint	Column name for suggestions cursor.
SuggestColumnProductionYear	Column name for suggestions cursor.
SuggestColumnPurchasePrice	Column name for suggestions cursor.
SuggestColumnQuery	Column name for suggestions cursor.
SuggestColumnRatingScore	Column name for suggestions cursor.
SuggestColumnRatingStyle	Column name for suggestions cursor.
SuggestColumnRentalPrice	Column name for suggestions cursor.
SuggestColumnResultCardImage	Column name for suggestions cursor.
SuggestColumnShortcutId	Column name for suggestions cursor.
SuggestColumnSpinnerWhileRefreshing	Column name for suggestions cursor.
SuggestColumnText1	Column name for suggestions cursor.
SuggestColumnText2	Column name for suggestions cursor.
SuggestColumnText2Url	Column name for suggestions cursor.
SuggestColumnVideoHeight	Column name for suggestions cursor.
SuggestColumnVideoWidth	Column name for suggestions cursor.
SuggestMimeType	MIME type for suggestions data.
SuggestNeverMakeShortcut	Column value for suggestion column `#SUGGEST_COLUMN_SHORTCUT_ID` when a suggestion should not be stored as a shortcut in global search.
SuggestParameterLimit	Query parameter added to suggestion queries to limit the number of suggestions returned.
SuggestUriPathQuery	Uri path for queried suggestions data.
SuggestUriPathShortcut	Uri path for shortcut validation.
UserQuery	Intent extra data key: Use this key with `android.content.Intent#getStringExtra content.Intent.getStringExtra()` to obtain the query string typed in by the user.

Properties

Name	Description
Class	Returns the runtime class of this `Object`. (Inherited from Object)
GlobalSearchActivity	Gets the name of the global search activity.
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	(Inherited from JavaObject)
JniPeerMembers	Provides JNI binding infrastructure for Android.App.SearchManager.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
SearchablesInGlobalSearch	Returns a list of the searchable activities that can be included in global search.
ThresholdClass	Provides JNI binding infrastructure for Android.App.SearchManager.
ThresholdType	Provides JNI binding infrastructure for Android.App.SearchManager.

Methods

Name	Description
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
Dispose()	Releases the resources held by this Java peer. (Inherited from Object)
Dispose(Boolean)	Releases the resources held by this Java peer. (Inherited from Object)
DisposeUnlessReferenced()	(Inherited from JavaObject)
Equals(Object)	(Inherited from JavaObject)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
FromContext(Context)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetSearchableInfo(ComponentName)	Gets information about a searchable activity.
JavaFinalize()	Obsolete. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
OnCancel(IDialogInterface)	Obsolete. This method is deprecated.
OnDismiss(IDialogInterface)	Obsolete. This method is deprecated.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetOnCancelListener(SearchManager+IOnCancelListener)	Set or clear the callback that will be invoked whenever the search UI is canceled.
SetOnDismissListener(SearchManager+IOnDismissListener)	Set or clear the callback that will be invoked whenever the search UI is dismissed.
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
StartSearch(String, Boolean, ComponentName, Bundle, Boolean)	Launch search UI.
StopSearch()	Terminate search UI.
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
TriggerSearch(String, ComponentName, Bundle)	Similar to `#startSearch` but actually fires off the search query after invoking the search dialog.
UnregisterFromRuntime()	Unregisters this Java peer from the interop runtime. (Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Events

Name	Description
Cancel
Dismiss

Explicit Interface Implementations

Name	Description
IJavaPeerable.Disposed()	(Inherited from JavaObject)
IJavaPeerable.Finalized()	(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock	(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to