en-US/about_DRMMSiteSettings.help.txt
|
TOPIC
about_DRMMSiteSettings SHORT DESCRIPTION Represents the overall settings for a site in the DRMM system, including general settings, proxy settings, mail recipients, and site UID. LONG DESCRIPTION The DRMMSiteSettings class models the overall settings for a site within the DRMM platform. It includes properties such as GeneralSettings, ProxySettings, MailRecipients, and SiteUid. The class provides a constructor and a static method to create an instance from API response data. Additionally, it includes a method to generate a summary string of the site's settings information, combining details from the general settings, proxy settings, and mail recipients. The class serves as a comprehensive representation of the site's configuration, allowing for easy access and management of various settings related to the site. This class inherits from DRMMObject. ## PROPERTIES The DRMMSiteSettings class exposes the following properties: Property Type Description --------------- ----------------------- ---------------------------------------- GeneralSettings DRMMSiteGeneralSettings The general settings of the site. ProxySettings DRMMSiteProxySettings The proxy settings for the site. MailRecipients DRMMSiteMailRecipient[] The mail recipients configured for si... SiteUid guid The unique identifier (UID) of the si... ## METHODS The DRMMSiteSettings class provides the following methods: ### GetSummary() Generates a summary string for the site's settings, including on-demand status, proxy information, and mail recipient count. **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/DRMMSite/about_DRMMSiteSettings.md |