hyperx.api.Package Class Reference

Public Member Functions
	__init__ (self, _api.Package package)
types.SimpleStatus	Demote (self)
	Update this package from a standalone package to a dependency package.
types.SimpleStatus	Install (self)
	Install the lastest version of this package.
types.SimpleStatus	Install (self, item1=None)
types.SimpleStatus	Install (self, PackageVersion packageVersion)
	Install a particular version of this package.
types.SimpleStatus	Pin (self)
	Prevent package from automatically updating to the latest version.
types.SimpleStatus	Promote (self)
	Promote package to be standalone.
types.SimpleStatus	Remove (self, bool force)
	Uninstall this package.
types.SimpleStatus	Unpin (self)
	Allow package to automatically update to the latest version.

Protected Attributes
	_Entity = package

Properties
	HasDependents = property
	True if any installed packages depend on this package.
	Identifier = property
	InstalledVersion = property
	IsInstalled = property
	IsPinned = property
	Flag that indicates whether the package automatically updates to the latest version.
	IsStandalone = property
	True if the package was manually installed or promoted.
	Latest = property
	The newest version of this package found in the database's available package sources.
	Versions = property

Constructor & Destructor Documentation

__init__()

hyperx.api.Package.__init__	(		self,
		_api.Package	package )

Member Function Documentation

Demote()

types.SimpleStatus hyperx.api.Package.Demote

(

self

)

Update this package from a standalone package to a dependency package.

Install() [1/3]

types.SimpleStatus hyperx.api.Package.Install

(

self

)

Install the lastest version of this package.

Install() [2/3]

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

Install the lastest version of this package.

Install a particular version of this package.

Install() [3/3]

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

Install a particular version of this package.

Pin()

types.SimpleStatus hyperx.api.Package.Pin

(

self

)

Prevent package from automatically updating to the latest version.

Promote()

types.SimpleStatus hyperx.api.Package.Promote

(

self

)

Promote package to be standalone.

Remove()

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

Uninstall this 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.Package.Unpin

(

self

)

Allow package to automatically update to the latest version.

Member Data Documentation

_Entity

hyperx.api.Package._Entity = package

protected

Property Documentation

HasDependents

hyperx.api.Package.HasDependents = property

static

True if any installed packages depend on this package.

Identifier

hyperx.api.Package.Identifier = property

static

InstalledVersion

hyperx.api.Package.InstalledVersion = property

static

IsInstalled

hyperx.api.Package.IsInstalled = property

static

IsPinned

hyperx.api.Package.IsPinned = property

static

Flag that indicates whether the package automatically updates to the latest version.

IsStandalone

hyperx.api.Package.IsStandalone = property

static

True if the package was manually installed or promoted.

If false, uninstalling all packages dependent on this package will also uninstall this package.

Latest

hyperx.api.Package.Latest = property

static

The newest version of this package found in the database's available package sources.

Versions

hyperx.api.Package.Versions = property

static

---

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

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