Confirmed users, Bureaucrats and Sysops emeriti
722
edits
Search Service:API: Difference between revisions
Jump to navigation
Jump to search
no edit summary
GavinSharp (talk | contribs) No edit summary |
GavinSharp (talk | contribs) No edit summary |
||
| Line 83: | Line 83: | ||
/** | /** | ||
* Adds a new search engine. | * Adds a new search engine. | ||
* @param | * @param name | ||
* The search engine's name. Must be unique. | |||
* @param iconURI | |||
* A nsIURI pointing to the icon to be used to represent the engine. | |||
* Only supports HTTP/HTTPS/File protocols, all others will be | |||
* rejected. | |||
* HTTP/HTTPS icons will be downloaded to the user's search plugin | |||
* directory. | |||
* @param alias | |||
* A unique shortcut that can be used to retrieve the search engine. | |||
* @param description | |||
* A description of the search engine. | |||
* @param method | |||
* The HTTP request method used when submitting a search query. | |||
* Must be a case insensitive value of either "get" or "post". | |||
* @param template | |||
* The URL to which search queries should be sent. This value will | |||
* undergo parameter substition according to the OpenSearch 1.1 | |||
* specification. | |||
* // XXX only some parameters are supported | |||
* Example value: "http://browser.search.example.com/?query={searchTerms} | |||
* See http://opensearch.a9.com/spec/1.1/querysyntax/#parameter-syntax. | |||
*/ | */ | ||
void addEngineWithDetails( | void addEngineWithDetails(in AString name, | ||
in nsIURI iconURI, | |||
in AString alias, | |||
in AString description, | |||
in AString method, | |||
in AString template); | |||
/** | /** | ||
| Line 97: | Line 117: | ||
* @param alias | * @param alias | ||
* The search engine's alias. | * The search engine's alias. | ||
* @returns A nsISearchEngine object | * @returns A nsISearchEngine object, or null if no engine with the | ||
* specified alias exists. | |||
*/ | */ | ||
nsISearchEngine getEngineByAlias(in AString alias); | nsISearchEngine getEngineByAlias(in AString alias); | ||