en-US/about_DRMMComponent.help.txt
|
TOPIC
about_DRMMComponent SHORT DESCRIPTION Represents a component in the DRMM system, including its properties and associated variables. LONG DESCRIPTION The DRMMComponent class models a component within the DRMM platform, encapsulating properties such as Id, Uid, Name, Description, CategoryCode, CredentialsRequired, and an array of associated variables (DRMMComponentVariable). It provides methods to retrieve specific variables and generate summaries of the component's properties. This class inherits from DRMMObject. ## PROPERTIES The DRMMComponent class exposes the following properties: Property Type Description ------------------- ----------------------- ---------------------------------------- Id int The unique identifier of the component. Uid string The unique identifier string of the c... Name string The name of the component. Description string A description of the component. CategoryCode string The category code that classifies the... CredentialsRequired bool Indicates whether the component requi... Variables DRMMComponentVariable[] An array of variables associated with... PortalUrl string The URL to access the component in th... ## METHODS The DRMMComponent class provides the following methods: ### GetVariable([String]$Name) Retrieves a specific variable from the component by name. **Returns:** `DRMMComponentVariable` - Represents a variable associated with a DRMM component, including its name, type, direction, and other metadata. **Parameters:** - `[String]$Name` - TODO: Describe this parameter ### GetInputVariables() Retrieves all input variables associated with the component. **Returns:** `DRMMComponentVariable[]` - Represents a variable associated with a DRMM component, including its name, type, direction, and other metadata. ### GetOutputVariables() Retrieves all output variables associated with the component. **Returns:** `DRMMComponentVariable[]` - Represents a variable associated with a DRMM component, including its name, type, direction, and other metadata. ### OpenPortal() Opens the component's portal URL in the default web browser. **Returns:** `void` - Returns void ### GetSummary() Generates a summary string for the component, including its name, variable count, credentials requirement, and category. **Returns:** `string` - Returns string ## NOTES This class is defined in the DattoRMM.Core module's class system. SEE ALSO Online Documentation https://github.com/TheShadowTek/DattoRMM.Core/blob/main/docs/about/classes/DRMMComponent/about_DRMMComponent.md Get-RMMComponent New-RMMQuickJob |