Confirmed users, Bureaucrats and Sysops emeriti
722
edits
Search Service:API: Difference between revisions
Jump to navigation
Jump to search
m
no edit summary
GavinSharp (talk | contribs) mNo edit summary |
GavinSharp (talk | contribs) mNo edit summary |
||
| Line 103: | Line 103: | ||
* undergo parameter substition according to the OpenSearch 1.1 | * undergo parameter substition according to the OpenSearch 1.1 | ||
* specification. | * specification. | ||
* | * XXX only some parameters are supported | ||
* Example value: "http://browser.search.example.com/?query={searchTerms} | * Example value: "http://browser.search.example.com/?query={searchTerms} | ||
* See http://opensearch.a9.com/spec/1.1/querysyntax/#parameter-syntax. | * See http://opensearch.a9.com/spec/1.1/querysyntax/#parameter-syntax. | ||
| Line 118: | Line 118: | ||
* @param alias | * @param alias | ||
* The search engine's alias. | * The search engine's alias. | ||
* @returns | * @returns The corresponding nsISearchEngine object, or null if it doesn't | ||
* | * exist. | ||
*/ | */ | ||
nsISearchEngine getEngineByAlias(in AString alias); | nsISearchEngine getEngineByAlias(in AString alias); | ||
| Line 134: | Line 134: | ||
/** | /** | ||
* Returns an array of all installed search engines. | * Returns an array of all installed search engines. | ||
* @returns | * @returns an array of nsISearchEngine objects. | ||
*/ | */ | ||
void getEngines(out unsigned long engineCount, | void getEngines(out unsigned long engineCount, | ||
| Line 141: | Line 141: | ||
/** | /** | ||
* Removes the search engine (from disk, too). | * Removes the search engine (from disk, too). | ||
* XXX | |||
* @param engine | * @param engine | ||
* The engine to remove. | * The engine to remove. | ||
| Line 148: | Line 149: | ||
/** | /** | ||
* Update all the stored search engines. | * Update all the stored search engines. | ||
* XXX | |||
*/ | */ | ||
void updateEngines(); | void updateEngines(); | ||
}; | }; | ||