java.lang.Object | |
↳ | android.printservice.PrintJob |
This class represents a print job from the perspective of a print service. It provides APIs for observing the print job state and performing operations on the print job.
Note: All methods of this class must be invoked on the main application thread.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Blocks the print job.
| |||||||||||
Cancels the print job.
| |||||||||||
Completes the print job.
| |||||||||||
Compares this instance with the specified object and indicates if they
are equal.
| |||||||||||
Fails the print job.
| |||||||||||
Gets the value of an advanced (printer specific) print option.
| |||||||||||
Gets the value of an advanced (printer specific) print option.
| |||||||||||
Gets the printed document.
| |||||||||||
Gets the unique print job id.
| |||||||||||
Gets the
PrintJobInfo that describes this job. | |||||||||||
Gets the print job tag.
| |||||||||||
Gets whether this job has a given advanced (printer specific) print
option.
| |||||||||||
Returns an integer hash code for this object.
| |||||||||||
Gets whether this print job is blocked.
| |||||||||||
Gets whether this print job is cancelled.
| |||||||||||
Gets whether this print job is completed.
| |||||||||||
Gets whether this print job is failed.
| |||||||||||
Gets whether this print job is queued.
| |||||||||||
Gets whether this print job is started.
| |||||||||||
Sets a tag that is valid in the context of a
PrintService
and is not interpreted by the system. | |||||||||||
Starts the print job.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Blocks the print job. You should call this method if isStarted()
or isBlocked()
returns true and you need
to block the print job. For example, the user has to add some
paper to continue printing. To resume the print job call start()
.
Cancels the print job. You should call this method if isQueued()
or or #isBlocked()
returns
true and you canceled the print job as a response to a call to
onRequestCancelPrintJob(PrintJob)
.
Completes the print job. You should call this method if isStarted()
returns true and you are done printing.
Compares this instance with the specified object and indicates if they
are equal. In order to be equal, o
must represent the same object
as this instance using a class-specific comparison. The general contract
is that this comparison should be reflexive, symmetric, and transitive.
Also, no object reference other than null is equal to null.
The default implementation returns true
only if this ==
o
. See Writing a correct
equals
method
if you intend implementing your own equals
method.
The general contract for the equals
and hashCode()
methods is that if equals
returns true
for
any two objects, then hashCode()
must return the same value for
these objects. This means that subclasses of Object
usually
override either both methods or neither of them.
obj | the object to compare this instance with. |
---|
true
if the specified object is equal to this Object
; false
otherwise.Fails the print job. You should call this method if isQueued()
or isStarted()
or isBlocked()
returns true you failed while printing.
error | The human readable, short, and translated reason for the failure. |
---|
Gets the value of an advanced (printer specific) print option.
key | The option key. |
---|
Gets the value of an advanced (printer specific) print option.
key | The option key. |
---|
Gets the printed document.
Gets the PrintJobInfo
that describes this job.
Node:The returned info object is a snapshot of the current print job state. Every call to this method returns a fresh info object that reflects the current print job state.
Gets whether this job has a given advanced (printer specific) print option.
key | The option key. |
---|
Returns an integer hash code for this object. By contract, any two
objects for which equals(Object)
returns true
must return
the same hash code value. This means that subclasses of Object
usually override both methods or neither method.
Note that hash values must not change over time unless information used in equals comparisons also changes.
See Writing a correct
hashCode
method
if you intend implementing your own hashCode
method.
Gets whether this print job is blocked. Such a print job is halted due to an abnormal condition and can be started or canceled or failed.
Gets whether this print job is cancelled. Such a print job was cancelled as a result of a user request. This is a final state.
Gets whether this print job is completed. Such a print job is successfully printed. This is a final state.
Gets whether this print job is failed. Such a print job is not successfully printed due to an error. This is a final state.
Gets whether this print job is started. Such a print job is being printed and can be completed or canceled or failed.
Sets a tag that is valid in the context of a PrintService
and is not interpreted by the system. For example, a print service
may set as a tag the key of the print job returned by a remote
print server, if the printing is off handed to a cloud based service.
tag | The tag. |
---|
Starts the print job. You should call this method if isQueued()
or isBlocked()
returns true and you started
resumed printing.