SiliconStudio.Assets.PackageStore Class Reference

Manage packages locally installed and accessible on the store. More...

Public Member Functions
IEnumerable< PackageMeta >	GetPackages ()
	Gets the packages available online. More...
IEnumerable< Package >	GetInstalledPackages ()
	Gets the packages installed locally. More...
UFile	GetPackageFileName (string packageName, PackageVersionRange versionRange=null, bool allowPreleaseVersion=true, bool allowUnlisted=false)
	Gets the filename to the specific package. More...

Properties
string	DefaultPackageName [get, set]
	Gets or sets the default package name (mainly used in dev environment). More...
PackageVersionRange	DefaultPackageMinVersion [get]
	Gets the default package minimum version. More...
PackageVersion	DefaultPackageVersion [get, set]
	Gets the default package version. More...
Package	DefaultPackage [get]
	Gets the default package. More...
UDirectory	InstallationPath [get]
	The root directory of packages. More...
static PackageStore	Instance [get]
	Gets the default package manager. More...

Detailed Description

Manage packages locally installed and accessible on the store.

This class is the frontend to the packaging/distribution system. It is currently using nuget for its packaging but may change in the future.

Definition at line 21 of file PackageStore.cs.

Member Function Documentation

IEnumerable<Package> SiliconStudio.Assets.PackageStore.GetInstalledPackages

(

)

Gets the packages installed locally.

Returns

An enumeratior of Package.

Definition at line 213 of file PackageStore.cs.

UFile SiliconStudio.Assets.PackageStore.GetPackageFileName	(	string	packageName,
		PackageVersionRange	versionRange = null,
		bool	allowPreleaseVersion = true,
		bool	allowUnlisted = false
	)

Gets the filename to the specific package.

Parameters

packageName	Name of the package.
versionRange	The version range.
allowPreleaseVersion	if set to true [allow prelease version].
allowUnlisted	if set to true [allow unlisted].

Returns

A location on the disk to the specified package or null if not found.

Exceptions

System.ArgumentNullException

packageName

Definition at line 247 of file PackageStore.cs.

References SiliconStudio.Assets.Package.PackageFileExtension.

IEnumerable<PackageMeta> SiliconStudio.Assets.PackageStore.GetPackages

(

)

Gets the packages available online.

Returns

IEnumerable<PackageMeta>.

Definition at line 191 of file PackageStore.cs.

Property Documentation

Package SiliconStudio.Assets.PackageStore.DefaultPackage

get

Gets the default package.

The default package.

Definition at line 169 of file PackageStore.cs.

PackageVersionRange SiliconStudio.Assets.PackageStore.DefaultPackageMinVersion

get

Gets the default package minimum version.

The default package minimum version.

Definition at line 151 of file PackageStore.cs.

string SiliconStudio.Assets.PackageStore.DefaultPackageName

getset

Gets or sets the default package name (mainly used in dev environment).

The default package name.

Definition at line 144 of file PackageStore.cs.

Referenced by SiliconStudio.Assets.Analysis.PackageAnalysis.CheckDependencies().

PackageVersion SiliconStudio.Assets.PackageStore.DefaultPackageVersion

getset

Gets the default package version.

The default package version.

Definition at line 162 of file PackageStore.cs.

UDirectory SiliconStudio.Assets.PackageStore.InstallationPath

get

The root directory of packages.

Definition at line 180 of file PackageStore.cs.

PackageStore SiliconStudio.Assets.PackageStore.Instance

staticget

Gets the default package manager.

A default instance.

Definition at line 259 of file PackageStore.cs.

Referenced by SiliconStudio.Assets.Analysis.PackageAnalysis.CheckDependencies().

---

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

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/assets/SiliconStudio.Assets/PackageStore.cs