Public Member Functions | Public Attributes

nsIAddonRepository Interface Reference

The add-on repository is a source of add-ons that can be installed. More...

import "nsIAddonRepository.idl";

List of all members.

Public Member Functions

AString getRecommendedURL ()
 The url that can be visited to see recommended add-ons in this repository.
AString getSearchURL (in AString aSearchTerms)
 Retrieves the url that can be visited to see search results for the given terms.
void retrieveRecommendedAddons (in unsigned long aMaxResults, in nsIAddonSearchResultsCallback aCallback)
 Begins a search for recommended add-ons in this repository.
void searchAddons (in AString aSearchTerms, in unsigned long aMaxResults, in nsIAddonSearchResultsCallback aCallback)
 Begins a search for add-ons in this repository.
void cancelSearch ()
 Cancels the search in progress.

Public Attributes

readonly attribute AString homepageURL
 The homepage for visiting this repository.
readonly attribute boolean isSearching
 Returns whether this instance is currently performing a search.

Detailed Description

The add-on repository is a source of add-ons that can be installed.

It can be searched in two ways. One returns a list of add-ons that come highly recommended, this list should change frequently. The other way is to search for specific search terms entered by the user. Searches are asynchronous and results should be passed to the provided callback object when complete. The results passed to the callback should only include add-ons that are compatible with the current application and are not already installed. Searches are always asynchronous and should be passed to the callback object provided.


Member Function Documentation

void nsIAddonRepository::cancelSearch (  ) 

Cancels the search in progress.

If there is no search in progress this does nothing.

AString nsIAddonRepository::getRecommendedURL (  ) 

The url that can be visited to see recommended add-ons in this repository.

AString nsIAddonRepository::getSearchURL ( in AString  aSearchTerms  ) 

Retrieves the url that can be visited to see search results for the given terms.

Parameters:
aSearchTerms search terms used to search the repository
void nsIAddonRepository::retrieveRecommendedAddons ( in unsigned long  aMaxResults,
in nsIAddonSearchResultsCallback  aCallback 
)

Begins a search for recommended add-ons in this repository.

Results will be passed to the given callback.

Parameters:
aMaxResults the maximum number of results to return
aCallback the callback to pass results to
void nsIAddonRepository::searchAddons ( in AString  aSearchTerms,
in unsigned long  aMaxResults,
in nsIAddonSearchResultsCallback  aCallback 
)

Begins a search for add-ons in this repository.

Results will be passed to the given callback.

Parameters:
aSearchTerms the terms to search for
aMaxResults the maximum number of results to return
aCallback the callback to pass results to

Member Data Documentation

readonly attribute AString nsIAddonRepository::homepageURL

The homepage for visiting this repository.

This may be null or an empty string.

Returns whether this instance is currently performing a search.

New searches will not be performed while this is the case.


The documentation for this interface was generated from the following file: