Zero Install .NET API 2.20.0
ZeroInstall.Services.Feeds.ICatalogManager Interface Reference

Provides access to remote and local Catalogs. Handles downloading, signature verification and caching. More...

Inheritance diagram for ZeroInstall.Services.Feeds.ICatalogManager:
ZeroInstall.Services.Feeds.CatalogManager

Public Member Functions

CatalogGetCached ()
 Loads the last result of GetOnline. More...
 
Catalog GetOnline ()
 Downloads and merges all Catalogs specified by the configuration files. More...
 
Catalog DownloadCatalog (FeedUri source)
 Downloads and parses a remote catalog file. Mainly for internal use. More...
 
bool AddSource (FeedUri uri)
 Adds a new source to download Catalog files from. More...
 
bool RemoveSource (FeedUri uri)
 Removes an existing source of Catalog files. More...
 

Detailed Description

Provides access to remote and local Catalogs. Handles downloading, signature verification and caching.

Member Function Documentation

◆ AddSource()

bool ZeroInstall.Services.Feeds.ICatalogManager.AddSource ( FeedUri  uri)

Adds a new source to download Catalog files from.

Parameters
uriThe URI of the source to add.
Returns
true if the source was add; false if the source was already in the list.
Exceptions
IOExceptionThere was a problem accessing a configuration file.
UnauthorizedAccessExceptionAccess to a configuration file was not permitted.
UriFormatExceptionAn invalid catalog source is specified in the configuration file.

Implemented in ZeroInstall.Services.Feeds.CatalogManager.

◆ DownloadCatalog()

Catalog ZeroInstall.Services.Feeds.ICatalogManager.DownloadCatalog ( FeedUri  source)

Downloads and parses a remote catalog file. Mainly for internal use.

Parameters
sourceThe URL to download the catalog file from.
Returns
The parsed Catalog.
Exceptions
WebExceptionA file could not be downloaded from the internet.
SignatureExceptionThe signature data of a remote catalog file could not be verified.
InvalidDataExceptionA problem occurred while deserializing the XML data.

Implemented in ZeroInstall.Services.Feeds.CatalogManager.

◆ GetCached()

Catalog? ZeroInstall.Services.Feeds.ICatalogManager.GetCached ( )

Loads the last result of GetOnline.

Returns
A Catalog; null if there is no cached data.
Exceptions
IOExceptionA problem occurred while reading the cache file.
UnauthorizedAccessExceptionAccess to the cache file was not permitted.
InvalidDataExceptionA problem occurred while deserializing the XML data.

Implemented in ZeroInstall.Services.Feeds.CatalogManager.

◆ GetOnline()

Catalog ZeroInstall.Services.Feeds.ICatalogManager.GetOnline ( )

Downloads and merges all Catalogs specified by the configuration files.

Returns
A Catalog.
Exceptions
IOExceptionA problem occurred while reading a local catalog file.
UnauthorizedAccessExceptionAccess to a local catalog file was not permitted.
WebExceptionA problem occurred while fetching a remote catalog file.
InvalidDataExceptionA problem occurred while deserializing the XML data.
SignatureExceptionThe signature data of a remote catalog file could not be verified.
UriFormatExceptionAn invalid catalog source is specified in the configuration file.

Implemented in ZeroInstall.Services.Feeds.CatalogManager.

◆ RemoveSource()

bool ZeroInstall.Services.Feeds.ICatalogManager.RemoveSource ( FeedUri  uri)

Removes an existing source of Catalog files.

Parameters
uriThe URI of the source to remove.
Returns
true if the source was removed; false if the source was not in the current list.
Exceptions
IOExceptionThere was a problem accessing a configuration file.
UnauthorizedAccessExceptionAccess to a configuration file was not permitted.
UriFormatExceptionAn invalid catalog source is specified in the configuration file.

Implemented in ZeroInstall.Services.Feeds.CatalogManager.


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