hyperx.api.FolderCol Class Reference

Inheritance diagram for hyperx.api.FolderCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.FolderCol folderCol)
	__iter__ (self)
	__len__ (self)
Folder	AddFolder (self, str name)
tuple[Folder]	AddFolders (self, tuple[str] names)
bool	DeleteFolder (self, Folder folder)
bool	DeleteFolders (self, tuple[Folder] folders)
Folder	Get (self, int id)
Folder	Get (self, item1=None)
Folder	Get (self, str 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
	FolderColList = property
	ParentFolder = 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.FolderCol.__init__	(		self,
		_api.FolderCol	folderCol )

Member Function Documentation

__getitem__()

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

__iter__()

hyperx.api.FolderCol.__iter__

(

self

)

__len__()

hyperx.api.FolderCol.__len__

(

self

)

AddFolder()

Folder hyperx.api.FolderCol.AddFolder	(		self,
		str	name )

AddFolders()

tuple[Folder] hyperx.api.FolderCol.AddFolders	(		self,
		tuple[str]	names )

DeleteFolder()

bool hyperx.api.FolderCol.DeleteFolder	(		self,
		Folder	folder )

DeleteFolders()

bool hyperx.api.FolderCol.DeleteFolders	(		self,
		tuple[Folder]	folders )

Get() [1/3]

Folder hyperx.api.FolderCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [2/3]

Folder hyperx.api.FolderCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [3/3]

Folder hyperx.api.FolderCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.IdNameEntityCol.

Property Documentation

FolderColList

hyperx.api.FolderCol.FolderColList = property

static

ParentFolder

hyperx.api.FolderCol.ParentFolder = property

static

---

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

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