OpenTap.Package.IPackageRepository Interface Reference

A client interface for a package repository. Implementations include FilePackageRepository and HttpPackageRepository. More...

Inheritance diagram for OpenTap.Package.IPackageRepository:

Public Member Functions
void	DownloadPackage (IPackageIdentifier package, string destination, CancellationToken cancellationToken)
	Downloads a package from this repository to a file. More...
string[]	GetPackageNames (CancellationToken cancellationToken, params IPackageIdentifier[] compatibleWith)
	Get all names of packages. More...
PackageVersion[]	GetPackageVersions (string packageName, CancellationToken cancellationToken, params IPackageIdentifier[] compatibleWith)
	Returns all package version information about a package. More...
PackageDef[]	GetPackages (PackageSpecifier package, CancellationToken cancellationToken, params IPackageIdentifier[] compatibleWith)
	This returns the latest version of a package that matches a number of specified parameters. If multiple packages have that same version number they all will be returned. More...
PackageDef[]	CheckForUpdates (IPackageIdentifier[] packages, CancellationToken cancellationToken)
	Returns a list of all packages that have an updated version. More...

Properties
string	Url [get]
	The url of the repository.

Detailed Description

A client interface for a package repository. Implementations include FilePackageRepository and HttpPackageRepository.

Member Function Documentation

CheckForUpdates()

PackageDef[] OpenTap.Package.IPackageRepository.CheckForUpdates	(	IPackageIdentifier[]	packages,
		CancellationToken	cancellationToken
	)

Returns a list of all packages that have an updated version.

Parameters

packages
cancellationToken	A cancellation token that can be used to cancel the download.

Returns

An array of package definitions PackageDef.

Implemented in OpenTap.Package.FilePackageRepository, and OpenTap.Package.HttpPackageRepository.

DownloadPackage()

void OpenTap.Package.IPackageRepository.DownloadPackage	(	IPackageIdentifier	package,
		string	destination,
		CancellationToken	cancellationToken
	)

Downloads a package from this repository to a file.

Parameters

package	The package to download.
destination	The destination path where the package should be stored.
cancellationToken	A cancellation token that can be used to cancel the download.

Implemented in OpenTap.Package.FilePackageRepository, and OpenTap.Package.HttpPackageRepository.

GetPackageNames()

string[] OpenTap.Package.IPackageRepository.GetPackageNames	(	CancellationToken	cancellationToken,
		params IPackageIdentifier[]	compatibleWith
	)

Get all names of packages.

Parameters

cancellationToken	A cancellation token that can be used to cancel the download.
compatibleWith	Any packages that the package to download must be compatible with.

Returns

An array of package names.

Implemented in OpenTap.Package.FilePackageRepository, and OpenTap.Package.HttpPackageRepository.

GetPackages()

PackageDef[] OpenTap.Package.IPackageRepository.GetPackages	(	PackageSpecifier	package,
		CancellationToken	cancellationToken,
		params IPackageIdentifier[]	compatibleWith
	)

This returns the latest version of a package that matches a number of specified parameters. If multiple packages have that same version number they all will be returned.

Parameters

package	A package identifier. If not specified, packages with any name will be returned.
cancellationToken	A cancellation token that can be used to cancel the download.
compatibleWith	Any packages that the package to download must be compatible with.

Returns

An array of package definitions PackageDef.

Implemented in OpenTap.Package.HttpPackageRepository, and OpenTap.Package.FilePackageRepository.

GetPackageVersions()

PackageVersion[] OpenTap.Package.IPackageRepository.GetPackageVersions	(	string	packageName,
		CancellationToken	cancellationToken,
		params IPackageIdentifier[]	compatibleWith
	)

Returns all package version information about a package.

Parameters

packageName	The name package to retrieve version info about.
cancellationToken	A cancellation token that can be used to cancel the download.
compatibleWith	Any packages that the package to download must be compatible with.

Returns

An array of package versions.

Implemented in OpenTap.Package.FilePackageRepository, and OpenTap.Package.HttpPackageRepository.