en-US/about_DRMMJob.help.txt
|
TOPIC
about_DRMMJob SHORT DESCRIPTION Represents a job in the DRMM system, including its ID, unique identifier, name, creation date, and status. LONG DESCRIPTION The DRMMJob class models a job within the DRMM platform. It includes properties such as Id, Uid, Name, DateCreated, and Status. This class provides methods to interact with job components, results, standard output, and error data. It also includes utility methods to check the job's status, calculate its age, refresh its data, and generate a summary string. The class is used to represent and manage jobs in the DRMM system. This class inherits from DRMMObject. ## PROPERTIES The DRMMJob class exposes the following properties: Property Type Description ----------- ------------------ ---------------------------------------- Id long The unique identifier of the job. Uid guid The unique identifier (UID) of the job. Name string The name of the job. DateCreated Nullable[datetime] The date and time when the job was cr... Status string The current status of the job. ## METHODS The DRMMJob class provides the following methods: ### IsActive() Checks if the job is currently active. **Returns:** `bool` - Returns bool ### IsCompleted() Checks if the job is completed. **Returns:** `bool` - Returns bool ### GetAge() Calculates the age of the job based on its creation date. **Returns:** `timespan` - Returns timespan ### GetComponents() Retrieves the components associated with the job. **Returns:** `DRMMJobComponent[]` - Represents a component of a DRMM job, including its unique identifier, name, and associated variables. ### GetSummary() Generates a summary string for the job. **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/DRMMJob/about_DRMMJob.md |