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.
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: |
duplex | Boolean | yes | Job is in duplex. Possible values: |
color | Boolean | - | Job is in color. |
owner | User[ ] | yes | Owner of the job |
copies | int | yes | Number of copies of the job |
tonerSaving | Boolean | yes | Toner Saving mode enabled |
filename | string | yes | A path including the filename of the job. |
lang | int | - | The PDL of the job with the following integers as its values: |