en-US/about_DRMMVariable.help.txt
|
TOPIC
about_DRMMVariable SHORT DESCRIPTION Represents a variable in the DRMM system, including its name, value, scope, and other attributes. LONG DESCRIPTION The DRMMVariable class models a variable within the DRMM platform, encapsulating properties such as Id, Name, Value, Scope, SiteUid, and IsSecret. It provides a constructor and a static method to create an instance from API response data. The class also includes methods to determine if the variable is global or site-specific, as well as a method to generate a summary string of the variable's information. This class inherits from DRMMObject. ## PROPERTIES The DRMMVariable class exposes the following properties: Property Type Description ---------- -------------- ---------------------------------------- Id long The unique identifier of the variable. Name string The name of the variable. Value object The value of the variable. Scope string The scope of the variable. SiteUid Nullable[guid] The unique identifier (UID) of the si... IsSecret bool Indicates whether the variable is a s... ## METHODS The DRMMVariable class provides the following methods: ### IsGlobal() Determines if the variable is global in scope. **Returns:** `bool` - Returns bool ### IsSite() Determines if the variable is site-specific in scope. **Returns:** `bool` - Returns bool ### GetSummary() Generates a summary string for the variable, including its name, scope, and value. **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/DRMMVariable/about_DRMMVariable.md |