API Reference

All methods supported by the HydroSym Plugin API, grouped by category.

Method	Category	Capability	Description
GetInfo	Lifecycle	—	Returns plugin metadata. Called immediately after loading to verify compatibility.
Initialize	Lifecycle	—	Establish connections and load configuration.
Finalize	Lifecycle	—	Close connections and release resources.
OnMenuAction	Menu & UI	—	Called when the user clicks a plugin menu item.
GetMenuItemState	Menu & UI	—	Query dynamic enabled/disabled/checked state of menu items.
ShowSettings	Menu & UI	—	Show the plugin's settings dialog.
CheckOut	Document Management	checkOut	Lock a project file for editing in the PDM system.
CheckIn	Document Management	checkIn	Release a project file back to the PDM system.
GetFileStatus	Document Management	getFileStatus	Query the PDM status of a file.
SaveFile	Document Management	saveFile	Save or upload a file to the PDM vault.
GetProjectVariables	Project Metadata	getProjectVariables	Retrieve project metadata from the external system.
SetProjectVariables	Project Metadata	setProjectVariables	Push project metadata to the external system.
GetProjectId	Project Metadata	getProjectId	Request a project identifier from the external system.
GetComponentParameters	Component Data	getComponentParameters	Retrieve parameters for a component from the ERP/PDM system.
GetPartFamilyMembers	Component Data	getPartFamilyMembers	List all members of a part family.
GetBom	BOM	getBom	Retrieve a Bill of Materials from the external system.
UploadBom	BOM	uploadBom	Push a BOM from HydroSym to the external system.
UploadDrawing	Output / Export	uploadDrawing	Upload exported drawing files to the external system.
GetManifoldIds	Manifolds	getManifoldIds	Retrieve identifiers for manifold blocks in an i-border.