Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

nsIAutoCompleteSearch

This interface is implemented by search providers to start and stop autocomplete.
Inherits from: nsISupports Last changed in Gecko 1.7

Users call startSearch() and pass in an nsIAutoCompleteObserver when the search starts. Results can be sent to the listener either synchronously or asynchronously, depending on the implementation.

Method overview

void startSearch(in AString searchString, in AString searchParam, in nsIAutoCompleteResult previousResult, in nsIAutoCompleteObserver listener);
void stopSearch();

Methods

startSearch()

Search for a given string and notify a listener (either synchronously or asynchronously) of the result.

void startSearch(
  in AString searchString,
  in AString searchParam,
  in nsIAutoCompleteResult previousResult,
  in nsIAutoCompleteObserver listener
);
Parameters
searchString
The string to search for.
searchParam
An extra parameter. Can be empty if not needed.
previousResult
The previous nsIAutoCompleteResult to use for faster searching. Can be null.
listener
An nsIAutoCompleteObserver listener to notify when the search is complete.

stopSearch()

Stop all searches that are in progress.

void stopSearch();
Parameters

None.

Document Tags and Contributors

 Contributors to this page: Sheppy, madarche, trevorh, roel, Bzbarsky, Wjjohnst
 Last updated by: Sheppy,