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

Properties
bool	HasDependents `[get]`
	True if any installed packages depend on this package.
string	Identifier `[get]`
PackageVersion	InstalledVersion `[get]`
bool	IsInstalled `[get]`
bool	IsPinned `[get]`
	Flag that indicates whether the package automatically updates to the latest version.
bool	IsStandalone `[get]`
	True if the package was manually installed or promoted. If false, uninstalling all packages dependent on this package will also uninstall this package.
PackageVersion	Latest `[get]`
	The newest version of this package found in the database's available package sources.
PackageVersionCol	Versions `[get]`

Member Function Documentation

◆ Demote()

SimpleStatus HyperX.Scripting.Package.Demote ( )

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

◆ Install() [1/2]

SimpleStatus HyperX.Scripting.Package.Install ( )

Install the lastest version of this package.

◆ Install() [2/2]

SimpleStatus HyperX.Scripting.Package.Install ( PackageVersion packageVersion )

Install a particular version of this package.

◆ Pin()

SimpleStatus HyperX.Scripting.Package.Pin ( )

Prevent package from automatically updating to the latest version.

◆ Promote()

SimpleStatus HyperX.Scripting.Package.Promote ( )

Promote package to be standalone.

◆ Remove()

SimpleStatus HyperX.Scripting.Package.Remove ( 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()

SimpleStatus HyperX.Scripting.Package.Unpin ( )

Allow package to automatically update to the latest version.

Property Documentation

◆ HasDependents

bool HyperX.Scripting.Package.HasDependents

get

True if any installed packages depend on this package.

◆ Identifier

string HyperX.Scripting.Package.Identifier

get

◆ InstalledVersion

PackageVersion HyperX.Scripting.Package.InstalledVersion

get

◆ IsInstalled

bool HyperX.Scripting.Package.IsInstalled

get

◆ IsPinned

bool HyperX.Scripting.Package.IsPinned

get

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

◆ IsStandalone

bool HyperX.Scripting.Package.IsStandalone

get

True if the package was manually installed or promoted. If false, uninstalling all packages dependent on this package will also uninstall this package.

◆ Latest

PackageVersion HyperX.Scripting.Package.Latest

get

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

◆ Versions

PackageVersionCol HyperX.Scripting.Package.Versions

get

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

HyperXPackages/Package.cs

Public Member Functions

Properties