hyperx.api.PluginPackageCol Class Reference

Inheritance diagram for hyperx.api.PluginPackageCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.PluginPackageCol pluginPackageCol)
	__iter__ (self)
	__len__ (self)
PluginPackage	AddPluginPackage (self, str path)
	Add a plugin package by path.
None	ClearAllPluginPackages (self)
	Clears all packages out of the database.
PluginPackage	Get (self, int id)
PluginPackage	Get (self, item1=None)
PluginPackage	Get (self, str name)
list[PluginPackage]	GetPluginPackages (self)
	Gets a list of package info Includes name, id, file path, version, description, and modification date.
bool	RemovePluginPackage (self, int id)
	Remove a plugin package by id.
bool	RemovePluginPackage (self, item1=None)
bool	RemovePluginPackage (self, str name)
	Remove a plugin package by name.
Public Member Functions inherited from hyperx.api.IdNameEntityCol
	__init__ (self, _api.IdNameEntityCol idNameEntityCol)
Public Member Functions inherited from hyperx.api.IdEntityCol
	__init__ (self, _api.IdEntityCol idEntityCol)
bool	Contains (self, int id)
int	Count (self)

Properties
	PluginPackageColList = property
Properties inherited from hyperx.api.IdNameEntityCol
	Names = property
Properties inherited from hyperx.api.IdEntityCol
	Ids = property

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdNameEntityCol
	_CollectedClass = T
Protected Attributes inherited from hyperx.api.IdEntityCol
	_Entity = idEntityCol

Constructor & Destructor Documentation

__init__()

hyperx.api.PluginPackageCol.__init__	(		self,
		_api.PluginPackageCol	pluginPackageCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.PluginPackageCol.__iter__

(

self

)

__len__()

hyperx.api.PluginPackageCol.__len__

(

self

)

AddPluginPackage()

PluginPackage hyperx.api.PluginPackageCol.AddPluginPackage	(		self,
		str	path )

Add a plugin package by path.

Returns

The added PluginPackage.

ClearAllPluginPackages()

None hyperx.api.PluginPackageCol.ClearAllPluginPackages

(

self

)

Clears all packages out of the database.

Get() [1/3]

PluginPackage hyperx.api.PluginPackageCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [2/3]

PluginPackage hyperx.api.PluginPackageCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [3/3]

PluginPackage hyperx.api.PluginPackageCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.IdNameEntityCol.

GetPluginPackages()

list[PluginPackage] hyperx.api.PluginPackageCol.GetPluginPackages

(

self

)

Gets a list of package info Includes name, id, file path, version, description, and modification date.

Returns

A list of all packages in the collection.

RemovePluginPackage() [1/3]

bool hyperx.api.PluginPackageCol.RemovePluginPackage	(		self,
		int	id )

Remove a plugin package by id.

Returns

False if the package is not found.

RemovePluginPackage() [2/3]

bool hyperx.api.PluginPackageCol.RemovePluginPackage	(		self,
			item1 = None )

   Remove a plugin package by name.

Returns

False if the package is not found.

   Remove a plugin package by id.

False if the package is not found.

RemovePluginPackage() [3/3]

bool hyperx.api.PluginPackageCol.RemovePluginPackage	(		self,
		str	name )

Remove a plugin package by name.

Returns

False if the package is not found.

Property Documentation

PluginPackageColList

hyperx.api.PluginPackageCol.PluginPackageColList = property

static

---

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

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