Job Class

The Job class has the following methods and properties:

Methods

this pause() - Pause the job.
this copyToQueue(string $queueName) - Copy the job to queue $queueName. The new job is processed normally according to the rules in the target queue.
this moveToQueue(string $queueName) - Move the job to queue $queueName. The new job is processed normally according to the rules in the target queue.
this setReleased() - Set the job as released (printed) without actually releasing it. (setPrinted is still supported for BC).
this delete() - Delete the job.
this setProject(string $projectCode) - Assign the job to the given project by project code.
this setAccount(string $accountReference) - Assign payment account to the job.

Properties

Job Properties show how the job looks after applying user/quota policies. This is how the job will be released. The null value means that the job parser was not able to get the property from the job file.

By setting a property, you can modify how the job will be released. This overrides any user/quota policy. If you set a property to null, the job will be released as originally received.

Setting monoCount, colorCount or paper doesn't actually modify the job. The new values are used only for credit/quota calculations.

Name	Type	Writable	Description
name	string	yes	Name of the job
dataSize	int	yes	Data size of the job in bytes
queue	Queue	-	Job's queue
monoCount	int	yes	Count of the monochrome pages of the job
colorCount	int	yes	Count of the color pages of the job
pageCount	int	-	Total sum of the pages of the job
paper	string	yes	Format of the paper with the following strings as its values: 'a4' 'a3' 'other' 'a5' 'b4' 'b5' 'folio' 'ledger' 'legal' 'letter' 'statement' This variable is employed by the 'set' method in MyQ. Use it in commands of the PHP script.
duplex	Boolean	yes	Job is in duplex. Possible values: 'simplex' 'longEdge' 'shortEdge' Note: Changing this property only updates the metadata of the job. The job is not converted to simplex/duplex.
color	Boolean	-	Job is in color. Note: Changing this property only updates the metadata of the job. The job is not converted to B&W/color.
owner	User[ ]	yes	Owner of the job Note: The user policies are not updated; Projects are not updated.
copies	int	yes	Number of copies of the job Note: Changing this property only updates the metadata of the job. The number of copies to be released is not changed.
tonerSaving	Boolean	yes	Toner Saving mode enabled
filename	string	yes	A path including the filename of the job. The path is relative to the job folder. Note: The path must exist, otherwise the job is not parsed and is declared as "deleted".
lang	int	-	The PDL of the job with the following integers as its values: UNKNOWN = 0, PDL_PCL = 1, PDL_PS = 2, PDL_ESCP = 3, PDL_PRESCRIBE = 4, PDL_PCLXL = 5, PDL_PDF = 6, PDL_JPEG = 7
stapling	string	yes	Staples the document, the following options are available: no, yes, topRight, twoStaples.
punching	string	yes	Punches the document, the following options are available: no, yes, twoHoles, threeHoles, fourHoles.