hyperx.api.PackageCol Class Reference

Inheritance diagram for hyperx.api.PackageCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.PackageCol packageCol)
	__iter__ (self)
	__len__ (self)
bool	Contains (self, str identifier)
types.SimpleStatus	Demote (self, Package package)
	Update package from a standalone package to a dependency package.
Package	Get (self, str identifier)
types.SimpleStatus	Install (self, item1=None)
types.SimpleStatus	Install (self, Package package)
	Install the latest version of package.
types.SimpleStatus	Install (self, PackageVersion packageVersion)
	Install a particular packageVersion.
types.SimpleStatus	Install (self, tuple[Package] packages)
	Install the latest versions of a collection of packages.
types.SimpleStatus	Install (self, tuple[PackageVersion] packageVersions)
	Install particular versions of a collection of packageVersions.
types.SimpleStatus	Pin (self, Package package)
	Prevent package from automatically updating to the latest version.
types.SimpleStatus	Promote (self, Package package)
	Promote package to be standalone.
types.SimpleStatus	Remove (self, Package package, bool force)
	Uninstall package.
types.SimpleStatus	Unpin (self, Package package)
	Allow package to automatically update to the latest version.

Protected Attributes
	_Entity = packageCol

Properties
	PackageColList = property

Constructor & Destructor Documentation

__init__()

hyperx.api.PackageCol.__init__	(		self,
		_api.PackageCol	packageCol )

Member Function Documentation

__getitem__()

hyperx.api.PackageCol.__getitem__	(		self,
		int	index )

__iter__()

hyperx.api.PackageCol.__iter__

(

self

)

__len__()

hyperx.api.PackageCol.__len__

(

self

)

Contains()

bool hyperx.api.PackageCol.Contains	(		self,
		str	identifier )

Demote()

types.SimpleStatus hyperx.api.PackageCol.Demote	(		self,
		Package	package )

Update package from a standalone package to a dependency package.

Get()

Package hyperx.api.PackageCol.Get	(		self,
		str	identifier )

Install() [1/5]

types.SimpleStatus hyperx.api.PackageCol.Install	(		self,
			item1 = None )

Install the latest version of package.

Install a particular packageVersion.

Install the latest versions of a collection of packages.

Install particular versions of a collection of packageVersions.

Install() [2/5]

types.SimpleStatus hyperx.api.PackageCol.Install	(		self,
		Package	package )

Install the latest version of package.

Install() [3/5]

types.SimpleStatus hyperx.api.PackageCol.Install	(		self,
		PackageVersion	packageVersion )

Install a particular packageVersion.

Install() [4/5]

types.SimpleStatus hyperx.api.PackageCol.Install	(		self,
		tuple[Package]	packages )

Install the latest versions of a collection of packages.

Install() [5/5]

types.SimpleStatus hyperx.api.PackageCol.Install	(		self,
		tuple[PackageVersion]	packageVersions )

Install particular versions of a collection of packageVersions.

Pin()

types.SimpleStatus hyperx.api.PackageCol.Pin	(		self,
		Package	package )

Prevent package from automatically updating to the latest version.

Promote()

types.SimpleStatus hyperx.api.PackageCol.Promote	(		self,
		Package	package )

Promote package to be standalone.

Remove()

types.SimpleStatus hyperx.api.PackageCol.Remove	(		self,
		Package	package,
		bool	force )

Uninstall package.

Parameters

force

If true, entities associated with the package will be removed. If false, removal will fail if any entities are associated with the package.

Unpin()

types.SimpleStatus hyperx.api.PackageCol.Unpin	(		self,
		Package	package )

Allow package to automatically update to the latest version.

Member Data Documentation

_Entity

hyperx.api.PackageCol._Entity = packageCol

protected

Property Documentation

PackageColList

hyperx.api.PackageCol.PackageColList = property

static

---

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

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py